DeploymentInfo (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.codedeploy.model.DeploymentInfo

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DeploymentInfo.Builder,DeploymentInfo>

@Generated(value="software.amazon.awssdk:codegen")
public final class DeploymentInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DeploymentInfo.Builder,DeploymentInfo>

Information about a deployment.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DeploymentInfo.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`additionalDeploymentStatusInfo()` Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.
`String`	`applicationName()` The application name.
`AutoRollbackConfiguration`	`autoRollbackConfiguration()` Information about the automatic rollback configuration associated with the deployment.
`BlueGreenDeploymentConfiguration`	`blueGreenDeploymentConfiguration()` Information about blue/green deployment options for this deployment.
`static DeploymentInfo.Builder`	`builder()`
`Instant`	`completeTime()` A timestamp indicating when the deployment was complete.
`ComputePlatform`	`computePlatform()` The destination platform type for the deployment (`Lambda` or `Server`).
`String`	`computePlatformAsString()` The destination platform type for the deployment (`Lambda` or `Server`).
`Instant`	`createTime()` A timestamp indicating when the deployment was created.
`DeploymentCreator`	`creator()` The means by which the deployment was created:
`String`	`creatorAsString()` The means by which the deployment was created:
`String`	`deploymentConfigName()` The deployment configuration name.
`String`	`deploymentGroupName()` The deployment group name.
`String`	`deploymentId()` The unique ID of a deployment.
`DeploymentOverview`	`deploymentOverview()` A summary of the deployment status of the instances in the deployment.
`List<String>`	`deploymentStatusMessages()` Messages that contain information about the status of a deployment.
`DeploymentStyle`	`deploymentStyle()` Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
`String`	`description()` A comment about the deployment.
`boolean`	`equals(Object obj)`
`ErrorInformation`	`errorInformation()` Information about any error associated with this deployment.
`FileExistsBehavior`	`fileExistsBehavior()` Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
`String`	`fileExistsBehaviorAsString()` Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`ignoreApplicationStopFailures()` If true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.
`Boolean`	`instanceTerminationWaitTimeStarted()` Indicates whether the wait period set for the termination of instances in the original environment has started.
`LoadBalancerInfo`	`loadBalancerInfo()` Information about the load balancer used in the deployment.
`RevisionLocation`	`previousRevision()` Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
`RevisionLocation`	`revision()` Information about the location of stored application artifacts and the service from which to retrieve them.
`RollbackInfo`	`rollbackInfo()` Information about a deployment rollback.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DeploymentInfo.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` A timestamp indicating when the deployment was deployed to the deployment group.
`DeploymentStatus`	`status()` The current state of the deployment as a whole.
`String`	`statusAsString()` The current state of the deployment as a whole.
`TargetInstances`	`targetInstances()` Information about the instances that belong to the replacement environment in a blue/green deployment.
`DeploymentInfo.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Boolean`	`updateOutdatedInstancesOnly()` Indicates whether only instances that are not running the latest application revision are to be deployed to.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - applicationName
```
public String applicationName()
```
    The application name.
    
    Returns:
    
    The application name.
  - deploymentGroupName
```
public String deploymentGroupName()
```
    The deployment group name.
    
    Returns:
    
    The deployment group name.
  - deploymentConfigName
```
public String deploymentConfigName()
```
    The deployment configuration name.
    
    Returns:
    
    The deployment configuration name.
  - deploymentId
```
public String deploymentId()
```
    The unique ID of a deployment.
    
    Returns:
    
    The unique ID of a deployment.
  - previousRevision
```
public RevisionLocation previousRevision()
```
    Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
    
    Returns:
    
    Information about the application revision that was deployed to the deployment group before the most recent successful deployment.
  - revision
```
public RevisionLocation revision()
```
    Information about the location of stored application artifacts and the service from which to retrieve them.
    
    Returns:
    
    Information about the location of stored application artifacts and the service from which to retrieve them.
  - status
```
public DeploymentStatus status()
```
    The current state of the deployment as a whole.
    
    If the service returns an enum value that is not available in the current SDK version, status will return DeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current state of the deployment as a whole.
    
    See Also:
    
    DeploymentStatus
  - statusAsString
```
public String statusAsString()
```
    The current state of the deployment as a whole.
    
    If the service returns an enum value that is not available in the current SDK version, status will return DeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current state of the deployment as a whole.
    
    See Also:
    
    DeploymentStatus
  - errorInformation
```
public ErrorInformation errorInformation()
```
    Information about any error associated with this deployment.
    
    Returns:
    
    Information about any error associated with this deployment.
  - createTime
```
public Instant createTime()
```
    A timestamp indicating when the deployment was created.
    
    Returns:
    
    A timestamp indicating when the deployment was created.
  - startTime
```
public Instant startTime()
```
    A timestamp indicating when the deployment was deployed to the deployment group.
    
    In some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of back-end servers that participate in the deployment process.
    
    Returns:
    
    A timestamp indicating when the deployment was deployed to the deployment group.
    
    In some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of back-end servers that participate in the deployment process.
  - completeTime
```
public Instant completeTime()
```
    A timestamp indicating when the deployment was complete.
    
    Returns:
    
    A timestamp indicating when the deployment was complete.
  - deploymentOverview
```
public DeploymentOverview deploymentOverview()
```
    A summary of the deployment status of the instances in the deployment.
    
    Returns:
    
    A summary of the deployment status of the instances in the deployment.
  - description
```
public String description()
```
    A comment about the deployment.
    
    Returns:
    
    A comment about the deployment.
  - creator
```
public DeploymentCreator creator()
```
    The means by which the deployment was created:
    - user: A user created the deployment.
    - autoscaling: Auto Scaling created the deployment.
    - codeDeployRollback: A rollback process created the deployment.
    If the service returns an enum value that is not available in the current SDK version, creator will return DeploymentCreator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from creatorAsString().
    Returns:
    The means by which the deployment was created:
    
    user: A user created the deployment.
    
    autoscaling: Auto Scaling created the deployment.
    
    codeDeployRollback: A rollback process created the deployment.
    See Also:
    
    DeploymentCreator
  - creatorAsString
```
public String creatorAsString()
```
    The means by which the deployment was created:
    - user: A user created the deployment.
    - autoscaling: Auto Scaling created the deployment.
    - codeDeployRollback: A rollback process created the deployment.
    If the service returns an enum value that is not available in the current SDK version, creator will return DeploymentCreator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from creatorAsString().
    Returns:
    The means by which the deployment was created:
    
    user: A user created the deployment.
    
    autoscaling: Auto Scaling created the deployment.
    
    codeDeployRollback: A rollback process created the deployment.
    See Also:
    
    DeploymentCreator
  - ignoreApplicationStopFailures
```
public Boolean ignoreApplicationStopFailures()
```
    If true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.
    
    If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.
    
    Returns:
    
    If true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.
    
    If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.
  - autoRollbackConfiguration
```
public AutoRollbackConfiguration autoRollbackConfiguration()
```
    Information about the automatic rollback configuration associated with the deployment.
    
    Returns:
    
    Information about the automatic rollback configuration associated with the deployment.
  - updateOutdatedInstancesOnly
```
public Boolean updateOutdatedInstancesOnly()
```
    Indicates whether only instances that are not running the latest application revision are to be deployed to.
    
    Returns:
    
    Indicates whether only instances that are not running the latest application revision are to be deployed to.
  - rollbackInfo
```
public RollbackInfo rollbackInfo()
```
    Information about a deployment rollback.
    
    Returns:
    
    Information about a deployment rollback.
  - deploymentStyle
```
public DeploymentStyle deploymentStyle()
```
    Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
    
    Returns:
    
    Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
  - targetInstances
```
public TargetInstances targetInstances()
```
    Information about the instances that belong to the replacement environment in a blue/green deployment.
    
    Returns:
    
    Information about the instances that belong to the replacement environment in a blue/green deployment.
  - instanceTerminationWaitTimeStarted
```
public Boolean instanceTerminationWaitTimeStarted()
```
    Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified; otherwise, 'true' as soon as the termination wait period starts.
    
    Returns:
    
    Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified; otherwise, 'true' as soon as the termination wait period starts.
  - blueGreenDeploymentConfiguration
```
public BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration()
```
    Information about blue/green deployment options for this deployment.
    
    Returns:
    
    Information about blue/green deployment options for this deployment.
  - loadBalancerInfo
```
public LoadBalancerInfo loadBalancerInfo()
```
    Information about the load balancer used in the deployment.
    
    Returns:
    
    Information about the load balancer used in the deployment.
  - additionalDeploymentStatusInfo
```
public String additionalDeploymentStatusInfo()
```
    Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.
    
    Returns:
    
    Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.
  - fileExistsBehavior
```
public FileExistsBehavior fileExistsBehavior()
```
    Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
    - DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
    - OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
    - RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
    If the service returns an enum value that is not available in the current SDK version, fileExistsBehavior will return FileExistsBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileExistsBehaviorAsString().
    Returns:
    Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
    
    DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
    
    OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
    
    RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
    See Also:
    
    FileExistsBehavior
  - fileExistsBehaviorAsString
```
public String fileExistsBehaviorAsString()
```
    Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
    - DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
    - OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
    - RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
    If the service returns an enum value that is not available in the current SDK version, fileExistsBehavior will return FileExistsBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileExistsBehaviorAsString().
    Returns:
    Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.
    
    DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
    
    OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
    
    RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
    See Also:
    
    FileExistsBehavior
  - deploymentStatusMessages
```
public List<String> deploymentStatusMessages()
```
    Messages that contain information about the status of a deployment.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Messages that contain information about the status of a deployment.
  - computePlatform
```
public ComputePlatform computePlatform()
```
    The destination platform type for the deployment (Lambda or Server).
    
    If the service returns an enum value that is not available in the current SDK version, computePlatform will return ComputePlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computePlatformAsString().
    
    Returns:
    
    The destination platform type for the deployment (Lambda or Server).
    
    See Also:
    
    ComputePlatform
  - computePlatformAsString
```
public String computePlatformAsString()
```
    The destination platform type for the deployment (Lambda or Server).
    
    If the service returns an enum value that is not available in the current SDK version, computePlatform will return ComputePlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computePlatformAsString().
    
    Returns:
    
    The destination platform type for the deployment (Lambda or Server).
    
    See Also:
    
    ComputePlatform
  - toBuilder
```
public DeploymentInfo.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<DeploymentInfo.Builder,DeploymentInfo>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DeploymentInfo.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DeploymentInfo.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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.

Class DeploymentInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

applicationName

deploymentGroupName

deploymentConfigName

deploymentId

previousRevision

revision

status

statusAsString

errorInformation

createTime

startTime

completeTime

deploymentOverview

description

creator

creatorAsString

ignoreApplicationStopFailures

autoRollbackConfiguration

updateOutdatedInstancesOnly

rollbackInfo

deploymentStyle

targetInstances

instanceTerminationWaitTimeStarted

blueGreenDeploymentConfiguration

loadBalancerInfo

additionalDeploymentStatusInfo

fileExistsBehavior

fileExistsBehaviorAsString

deploymentStatusMessages

computePlatform

computePlatformAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields