Class ContainerServiceDeployment

java.lang.Object
software.amazon.awssdk.services.lightsail.model.ContainerServiceDeployment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ContainerServiceDeployment.Builder,ContainerServiceDeployment>
@Generated("software.amazon.awssdk:codegen") public final class ContainerServiceDeployment extends Object implements SdkPojo, Serializable, 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:

  • Method Details

    • version

      public final Integer version()

      The version number of the deployment.

      Returns:
      The version number of the deployment.

    • state

      public final ContainerServiceDeploymentState 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 the GetContainerLog 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 return ContainerServiceDeploymentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      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 the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.

      See Also:

    • stateAsString

      public final String 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 the GetContainerLog 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 return ContainerServiceDeploymentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      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 the GetContainerLog 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 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.

    • containers

      public final Map<String,Container> 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

      public final ContainerServiceEndpoint publicEndpoint()

      An object that describes the endpoint of the deployment.

      Returns:
      An object that describes the endpoint of the deployment.

    • createdAt

      public final Instant createdAt()

      The timestamp when the deployment was created.

      Returns:
      The timestamp when the deployment was created.

    • toBuilder

      public ContainerServiceDeployment.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<ContainerServiceDeployment.Builder,ContainerServiceDeployment>
      Returns:
      a builder for type T

    • builder

      public static ContainerServiceDeployment.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ContainerServiceDeployment.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final 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.