Class ServiceDeployment
- java.lang.Object
-
- software.amazon.awssdk.services.ecs.model.ServiceDeployment
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ServiceDeployment.Builder,ServiceDeployment>
@Generated("software.amazon.awssdk:codegen") public final class ServiceDeployment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ServiceDeployment.Builder,ServiceDeployment>
Information about the service deployment.
Service deployments provide a comprehensive view of your deployments. For information about service deployments, see View service history using Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide .
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceServiceDeployment.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ServiceDeploymentAlarmsalarms()The CloudWatch alarms that determine when a service deployment fails.static ServiceDeployment.Builderbuilder()StringclusterArn()The ARN of the cluster that hosts the service.InstantcreatedAt()The time the service deployment was created.ServiceDeploymentCircuitBreakerdeploymentCircuitBreaker()The circuit breaker configuration that determines a service deployment failed.DeploymentConfigurationdeploymentConfiguration()Returns the value of the DeploymentConfiguration property for this object.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)InstantfinishedAt()The time the service deployment finished.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSourceServiceRevisions()For responses, this returns true if the service returned a value for the SourceServiceRevisions property.Rollbackrollback()The rollback options the service deployment uses when the deployment fails.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ServiceDeployment.Builder>serializableBuilderClass()StringserviceArn()The ARN of the service for this service deployment.StringserviceDeploymentArn()The ARN of the service deployment.List<ServiceRevisionSummary>sourceServiceRevisions()The currently deployed workload configuration.InstantstartedAt()The time the service deployment statred.ServiceDeploymentStatusstatus()The service deployment state.StringstatusAsString()The service deployment state.StringstatusReason()Information about why the service deployment is in the current status.InstantstoppedAt()The time the service deployment stopped.ServiceRevisionSummarytargetServiceRevision()The workload configuration being deployed.ServiceDeployment.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedAt()The time that the service deployment was last updated.-
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
-
serviceDeploymentArn
public final String serviceDeploymentArn()
The ARN of the service deployment.
- Returns:
- The ARN of the service deployment.
-
serviceArn
public final String serviceArn()
The ARN of the service for this service deployment.
- Returns:
- The ARN of the service for this service deployment.
-
clusterArn
public final String clusterArn()
The ARN of the cluster that hosts the service.
- Returns:
- The ARN of the cluster that hosts the service.
-
createdAt
public final Instant createdAt()
The time the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
- Returns:
- The time the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
-
startedAt
public final Instant startedAt()
The time the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
- Returns:
- The time the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
-
finishedAt
public final Instant finishedAt()
The time the service deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
- Returns:
- The time the service deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
-
stoppedAt
public final Instant stoppedAt()
The time the service deployment stopped. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
The service deployment stops when any of the following actions happen:
-
A user manually stops the deployment
-
The rollback option is not in use for the failure detection mechanism (the circuit breaker or alarm-based) and the service fails.
- Returns:
- The time the service deployment stopped. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
The service deployment stops when any of the following actions happen:
-
A user manually stops the deployment
-
The rollback option is not in use for the failure detection mechanism (the circuit breaker or alarm-based) and the service fails.
-
-
-
updatedAt
public final Instant updatedAt()
The time that the service deployment was last updated. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
- Returns:
- The time that the service deployment was last updated. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
-
hasSourceServiceRevisions
public final boolean hasSourceServiceRevisions()
For responses, this returns true if the service returned a value for the SourceServiceRevisions 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.
-
sourceServiceRevisions
public final List<ServiceRevisionSummary> sourceServiceRevisions()
The currently deployed workload configuration.
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
hasSourceServiceRevisions()method.- Returns:
- The currently deployed workload configuration.
-
targetServiceRevision
public final ServiceRevisionSummary targetServiceRevision()
The workload configuration being deployed.
- Returns:
- The workload configuration being deployed.
-
status
public final ServiceDeploymentStatus status()
The service deployment state.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnServiceDeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The service deployment state.
- See Also:
ServiceDeploymentStatus
-
statusAsString
public final String statusAsString()
The service deployment state.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnServiceDeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The service deployment state.
- See Also:
ServiceDeploymentStatus
-
statusReason
public final String statusReason()
Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.
- Returns:
- Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.
-
deploymentConfiguration
public final DeploymentConfiguration deploymentConfiguration()
Returns the value of the DeploymentConfiguration property for this object.- Returns:
- The value of the DeploymentConfiguration property for this object.
-
rollback
public final Rollback rollback()
The rollback options the service deployment uses when the deployment fails.
- Returns:
- The rollback options the service deployment uses when the deployment fails.
-
deploymentCircuitBreaker
public final ServiceDeploymentCircuitBreaker deploymentCircuitBreaker()
The circuit breaker configuration that determines a service deployment failed.
- Returns:
- The circuit breaker configuration that determines a service deployment failed.
-
alarms
public final ServiceDeploymentAlarms alarms()
The CloudWatch alarms that determine when a service deployment fails.
- Returns:
- The CloudWatch alarms that determine when a service deployment fails.
-
toBuilder
public ServiceDeployment.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ServiceDeployment.Builder,ServiceDeployment>
-
builder
public static ServiceDeployment.Builder builder()
-
serializableBuilderClass
public static Class<? extends ServiceDeployment.Builder> serializableBuilderClass()
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-