Class ContainerServiceDeployment
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ContainerServiceDeployment.Builder,
ContainerServiceDeployment>
Describes a container deployment configuration of an Amazon Lightsail container service.
A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
An object that describes the configuration for the containers of the deployment.final Instant
The timestamp when the deployment was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Containers property.final int
hashCode()
final ContainerServiceEndpoint
An object that describes the endpoint of the deployment.static Class
<? extends ContainerServiceDeployment.Builder> state()
The state of the deployment.final String
The state of the deployment.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
version()
The version number of the deployment.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
version
The version number of the deployment.
- Returns:
- The version number of the deployment.
-
state
The state of the deployment.
A deployment can be in one of the following states:
-
ACTIVATING
- The deployment is being created. -
ACTIVE
- The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time. -
INACTIVE
- The deployment was previously successfully created, but it is not currently running on the container service. -
FAILED
- The deployment failed. Use theGetContainerLog
action to view the log events for the containers in the deployment to try to determine the reason for the failure.
If the service returns an enum value that is not available in the current SDK version,
state
will returnContainerServiceDeploymentState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the deployment.
A deployment can be in one of the following states:
-
ACTIVATING
- The deployment is being created. -
ACTIVE
- The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time. -
INACTIVE
- The deployment was previously successfully created, but it is not currently running on the container service. -
FAILED
- The deployment failed. Use theGetContainerLog
action to view the log events for the containers in the deployment to try to determine the reason for the failure.
-
- See Also:
-
-
stateAsString
The state of the deployment.
A deployment can be in one of the following states:
-
ACTIVATING
- The deployment is being created. -
ACTIVE
- The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time. -
INACTIVE
- The deployment was previously successfully created, but it is not currently running on the container service. -
FAILED
- The deployment failed. Use theGetContainerLog
action to view the log events for the containers in the deployment to try to determine the reason for the failure.
If the service returns an enum value that is not available in the current SDK version,
state
will returnContainerServiceDeploymentState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the deployment.
A deployment can be in one of the following states:
-
ACTIVATING
- The deployment is being created. -
ACTIVE
- The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time. -
INACTIVE
- The deployment was previously successfully created, but it is not currently running on the container service. -
FAILED
- The deployment failed. Use theGetContainerLog
action to view the log events for the containers in the deployment to try to determine the reason for the failure.
-
- See Also:
-
-
hasContainers
public final boolean hasContainers()For responses, this returns true if the service returned a value for the Containers 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. -
containers
An object that describes the configuration for the containers of the deployment.
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
hasContainers()
method.- Returns:
- An object that describes the configuration for the containers of the deployment.
-
publicEndpoint
An object that describes the endpoint of the deployment.
- Returns:
- An object that describes the endpoint of the deployment.
-
createdAt
The timestamp when the deployment was created.
- Returns:
- The timestamp when the deployment was created.
-
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 interfaceToCopyableBuilder<ContainerServiceDeployment.Builder,
ContainerServiceDeployment> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-