Package software.amazon.awssdk.services.ecs.model

Class Container

java.lang.Object
software.amazon.awssdk.services.ecs.model.Container
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Container.Builder,Container>
@Generated("software.amazon.awssdk:codegen") public final class Container extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Container.Builder,Container>

A Docker container that's part of a task.

See Also:

  • Method Details

    • containerArn

      public final String containerArn()

      The Amazon Resource Name (ARN) of the container.

      Returns:
      The Amazon Resource Name (ARN) of the container.

    • taskArn

      public final String taskArn()

      The ARN of the task.

      Returns:
      The ARN of the task.

    • name

      public final String name()

      The name of the container.

      Returns:
      The name of the container.

    • image

      public final String image()

      The image used for the container.

      Returns:
      The image used for the container.

    • imageDigest

      public final String imageDigest()

      The container image manifest digest.

      Returns:
      The container image manifest digest.

    • runtimeId

      public final String runtimeId()

      The ID of the Docker container.

      Returns:
      The ID of the Docker container.

    • lastStatus

      public final String lastStatus()

      The last known status of the container.

      Returns:
      The last known status of the container.

    • exitCode

      public final Integer exitCode()

      The exit code returned from the container.

      Returns:
      The exit code returned from the container.

    • reason

      public final String reason()

      A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

      Returns:
      A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

    • hasNetworkBindings

      public final boolean hasNetworkBindings()
      For responses, this returns true if the service returned a value for the NetworkBindings 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.

    • networkBindings

      public final List<NetworkBinding> networkBindings()

      The network bindings associated with the container.

      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 hasNetworkBindings() method.

      Returns:
      The network bindings associated with the container.

    • hasNetworkInterfaces

      public final boolean hasNetworkInterfaces()
      For responses, this returns true if the service returned a value for the NetworkInterfaces 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.

    • networkInterfaces

      public final List<NetworkInterface> networkInterfaces()

      The network interfaces associated with the container.

      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 hasNetworkInterfaces() method.

      Returns:
      The network interfaces associated with the container.

    • healthStatus

      public final HealthStatus healthStatus()

      The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.

      If the service returns an enum value that is not available in the current SDK version, healthStatus will return HealthStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthStatusAsString().

      Returns:
      The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.
      See Also:

    • healthStatusAsString

      public final String healthStatusAsString()

      The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.

      If the service returns an enum value that is not available in the current SDK version, healthStatus will return HealthStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthStatusAsString().

      Returns:
      The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.
      See Also:

    • hasManagedAgents

      public final boolean hasManagedAgents()
      For responses, this returns true if the service returned a value for the ManagedAgents 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.

    • managedAgents

      public final List<ManagedAgent> managedAgents()

      The details of any Amazon ECS managed agents associated with the container.

      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 hasManagedAgents() method.

      Returns:
      The details of any Amazon ECS managed agents associated with the container.

    • cpu

      public final String cpu()

      The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

      Returns:
      The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

    • memory

      public final String memory()

      The hard limit (in MiB) of memory set for the container.

      Returns:
      The hard limit (in MiB) of memory set for the container.

    • memoryReservation

      public final String memoryReservation()

      The soft limit (in MiB) of memory set for the container.

      Returns:
      The soft limit (in MiB) of memory set for the container.

    • hasGpuIds

      public final boolean hasGpuIds()
      For responses, this returns true if the service returned a value for the GpuIds 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.

    • gpuIds

      public final List<String> gpuIds()

      The IDs of each GPU assigned to the container.

      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 hasGpuIds() method.

      Returns:
      The IDs of each GPU assigned to the container.

    • toBuilder

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

    • builder

      public static Container.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Container.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.