StopDeploymentResponse (AWS Java SDK :: Services

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.StopDeploymentResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StopDeploymentResponse.Builder,StopDeploymentResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class StopDeploymentResponse
extends AppConfigResponse
implements ToCopyableBuilder<StopDeploymentResponse.Builder,StopDeploymentResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StopDeploymentResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StopDeploymentResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`applicationId()` The ID of the application that was deployed.
`List<AppliedExtension>`	`appliedExtensions()` A list of extensions that were processed as part of the deployment.
`static StopDeploymentResponse.Builder`	`builder()`
`Instant`	`completedAt()` The time the deployment completed.
`String`	`configurationLocationUri()` Information about the source location of the configuration.
`String`	`configurationName()` The name of the configuration.
`String`	`configurationProfileId()` The ID of the configuration profile that was deployed.
`String`	`configurationVersion()` The configuration version that was deployed.
`Integer`	`deploymentDurationInMinutes()` Total amount of time the deployment lasted.
`Integer`	`deploymentNumber()` The sequence number of the deployment.
`String`	`deploymentStrategyId()` The ID of the deployment strategy that was deployed.
`String`	`description()` The description of the deployment.
`String`	`environmentId()` The ID of the environment that was deployed.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<DeploymentEvent>`	`eventLog()` A list containing all events related to a deployment.
`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.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`Float`	`growthFactor()` The percentage of targets to receive a deployed configuration during each interval.
`GrowthType`	`growthType()` The algorithm used to define how percentage grew over time.
`String`	`growthTypeAsString()` The algorithm used to define how percentage grew over time.
`boolean`	`hasAppliedExtensions()` For responses, this returns true if the service returned a value for the AppliedExtensions property.
`boolean`	`hasEventLog()` For responses, this returns true if the service returned a value for the EventLog property.
`int`	`hashCode()`
`String`	`kmsKeyArn()` The Amazon Resource Name of the Key Management Service key used to encrypt configuration data.
`String`	`kmsKeyIdentifier()` The KMS key identifier (key ID, key alias, or key ARN).
`Float`	`percentageComplete()` The percentage of targets for which the deployment is available.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StopDeploymentResponse.Builder>`	`serializableBuilderClass()`
`Instant`	`startedAt()` The time the deployment started.
`DeploymentState`	`state()` The state of the deployment.
`String`	`stateAsString()` The state of the deployment.
`StopDeploymentResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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, 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:
    
    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, 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:
    
    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, 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:
    
    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, 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:
    
    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 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 KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
    
    Returns:
    
    The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
  - toBuilder
```
public StopDeploymentResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StopDeploymentResponse.Builder,StopDeploymentResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static StopDeploymentResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StopDeploymentResponse.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StopDeploymentResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.appconfig.model.AppConfigResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

applicationId

environmentId

deploymentStrategyId

configurationProfileId

deploymentNumber

configurationName

configurationLocationUri

configurationVersion

description

deploymentDurationInMinutes

growthType

growthTypeAsString

growthFactor

finalBakeTimeInMinutes

state

stateAsString

hasEventLog

eventLog

percentageComplete

startedAt

completedAt

hasAppliedExtensions

appliedExtensions

kmsKeyArn

kmsKeyIdentifier

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields