Package software.amazon.awssdk.services.appconfig.model

Class StartDeploymentResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.appconfig.model.AppConfigResponse
software.amazon.awssdk.services.appconfig.model.StartDeploymentResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartDeploymentResponse.Builder,StartDeploymentResponse>
@Generated("software.amazon.awssdk:codegen") public final class StartDeploymentResponse extends AppConfigResponse implements ToCopyableBuilder<StartDeploymentResponse.Builder,StartDeploymentResponse>

  • Method Details

    • applicationId

      public final String applicationId()

      The ID of the application that was deployed.

      Returns:
      The ID of the application that was deployed.

    • environmentId

      public final String environmentId()

      The ID of the environment that was deployed.

      Returns:
      The ID of the environment that was deployed.

    • deploymentStrategyId

      public final String deploymentStrategyId()

      The ID of the deployment strategy that was deployed.

      Returns:
      The ID of the deployment strategy that was deployed.

    • configurationProfileId

      public final String configurationProfileId()

      The ID of the configuration profile that was deployed.

      Returns:
      The ID of the configuration profile that was deployed.

    • deploymentNumber

      public final Integer deploymentNumber()

      The sequence number of the deployment.

      Returns:
      The sequence number of the deployment.

    • configurationName

      public final String configurationName()

      The name of the configuration.

      Returns:
      The name of the configuration.

    • configurationLocationUri

      public final String configurationLocationUri()

      Information about the source location of the configuration.

      Returns:
      Information about the source location of the configuration.

    • configurationVersion

      public final String configurationVersion()

      The configuration version that was deployed.

      Returns:
      The configuration version that was deployed.

    • description

      public final String description()

      The description of the deployment.

      Returns:
      The description of the deployment.

    • deploymentDurationInMinutes

      public final Integer deploymentDurationInMinutes()

      Total amount of time the deployment lasted.

      Returns:
      Total amount of time the deployment lasted.

    • growthType

      public final GrowthType growthType()

      The algorithm used to define how percentage grew over time.

      If the service returns an enum value that is not available in the current SDK version, growthType will return GrowthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from growthTypeAsString().

      Returns:
      The algorithm used to define how percentage grew over time.
      See Also:

    • growthTypeAsString

      public final String growthTypeAsString()

      The algorithm used to define how percentage grew over time.

      If the service returns an enum value that is not available in the current SDK version, growthType will return GrowthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from growthTypeAsString().

      Returns:
      The algorithm used to define how percentage grew over time.
      See Also:

    • growthFactor

      public final Float growthFactor()

      The percentage of targets to receive a deployed configuration during each interval.

      Returns:
      The percentage of targets to receive a deployed configuration during each interval.

    • finalBakeTimeInMinutes

      public final Integer finalBakeTimeInMinutes()

      The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

      Returns:
      The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

    • state

      public final DeploymentState state()

      The state of the deployment.

      If the service returns an enum value that is not available in the current SDK version, state will return DeploymentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the deployment.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the deployment.

      If the service returns an enum value that is not available in the current SDK version, state will return DeploymentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the deployment.
      See Also:

    • hasEventLog

      public final boolean hasEventLog()
      For responses, this returns true if the service returned a value for the EventLog property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • eventLog

      public final List<DeploymentEvent> eventLog()

      A list containing all events related to a deployment. The most recent events are displayed first.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEventLog() method.

      Returns:
      A list containing all events related to a deployment. The most recent events are displayed first.

    • percentageComplete

      public final Float percentageComplete()

      The percentage of targets for which the deployment is available.

      Returns:
      The percentage of targets for which the deployment is available.

    • startedAt

      public final Instant startedAt()

      The time the deployment started.

      Returns:
      The time the deployment started.

    • completedAt

      public final Instant completedAt()

      The time the deployment completed.

      Returns:
      The time the deployment completed.

    • hasAppliedExtensions

      public final boolean hasAppliedExtensions()
      For responses, this returns true if the service returned a value for the AppliedExtensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • appliedExtensions

      public final List<AppliedExtension> appliedExtensions()

      A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAppliedExtensions() method.

      Returns:
      A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.

      Returns:
      The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.

    • kmsKeyIdentifier

      public final String kmsKeyIdentifier()

      The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

      Returns:
      The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

    • versionLabel

      public final String versionLabel()

      A user-defined label for an AppConfig hosted configuration version.

      Returns:
      A user-defined label for an AppConfig hosted configuration version.

    • toBuilder

      public StartDeploymentResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartDeploymentResponse.Builder,StartDeploymentResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static StartDeploymentResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartDeploymentResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.