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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStartDeploymentResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringapplicationId()The ID of the application that was deployed.List<AppliedExtension>appliedExtensions()A list of extensions that were processed as part of the deployment.static StartDeploymentResponse.Builderbuilder()InstantcompletedAt()The time the deployment completed.StringconfigurationLocationUri()Information about the source location of the configuration.StringconfigurationName()The name of the configuration.StringconfigurationProfileId()The ID of the configuration profile that was deployed.StringconfigurationVersion()The configuration version that was deployed.IntegerdeploymentDurationInMinutes()Total amount of time the deployment lasted.IntegerdeploymentNumber()The sequence number of the deployment.StringdeploymentStrategyId()The ID of the deployment strategy that was deployed.Stringdescription()The description of the deployment.StringenvironmentId()The ID of the environment that was deployed.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<DeploymentEvent>eventLog()A list containing all events related to a deployment.IntegerfinalBakeTimeInMinutes()The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)FloatgrowthFactor()The percentage of targets to receive a deployed configuration during each interval.GrowthTypegrowthType()The algorithm used to define how percentage grew over time.StringgrowthTypeAsString()The algorithm used to define how percentage grew over time.booleanhasAppliedExtensions()For responses, this returns true if the service returned a value for the AppliedExtensions property.booleanhasEventLog()For responses, this returns true if the service returned a value for the EventLog property.inthashCode()StringkmsKeyArn()The Amazon Resource Name of the Key Management Service key used to encrypt configuration data.StringkmsKeyIdentifier()The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.FloatpercentageComplete()The percentage of targets for which the deployment is available.List<SdkField<?>>sdkFields()static Class<? extends StartDeploymentResponse.Builder>serializableBuilderClass()InstantstartedAt()The time the deployment started.DeploymentStatestate()The state of the deployment.StringstateAsString()The state of the deployment.StartDeploymentResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringversionLabel()A user-defined label for an AppConfig hosted configuration version.-
Methods inherited from class software.amazon.awssdk.services.appconfig.model.AppConfigResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
growthTypewill returnGrowthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromgrowthTypeAsString().- Returns:
- The algorithm used to define how percentage grew over time.
- See Also:
GrowthType
-
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,
growthTypewill returnGrowthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromgrowthTypeAsString().- Returns:
- The algorithm used to define how percentage grew over time.
- See Also:
GrowthType
-
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,
statewill returnDeploymentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The state of the deployment.
- See Also:
DeploymentState
-
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,
statewill returnDeploymentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The state of the deployment.
- See Also:
DeploymentState
-
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 theisEmpty()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 theisEmpty()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
StartDeploymentwas 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
StartDeploymentwas 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<StartDeploymentResponse.Builder,StartDeploymentResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static StartDeploymentResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends StartDeploymentResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-