Container (AWS Java SDK :: Services :: Amazon EC2 Container Service 2.17.33 API)

java.lang.Object
- software.amazon.awssdk.services.ecs.model.Container

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

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

A Docker container that is part of a task.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Container.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Container.Builder`	`builder()`
`String`	`containerArn()` The Amazon Resource Name (ARN) of the container.
`String`	`cpu()` The number of CPU units set for the container.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Integer`	`exitCode()` The exit code returned from the container.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<String>`	`gpuIds()` The IDs of each GPU assigned to the container.
`boolean`	`hasGpuIds()` For responses, this returns true if the service returned a value for the GpuIds property.
`int`	`hashCode()`
`boolean`	`hasManagedAgents()` For responses, this returns true if the service returned a value for the ManagedAgents property.
`boolean`	`hasNetworkBindings()` For responses, this returns true if the service returned a value for the NetworkBindings property.
`boolean`	`hasNetworkInterfaces()` For responses, this returns true if the service returned a value for the NetworkInterfaces property.
`HealthStatus`	`healthStatus()` The health status of the container.
`String`	`healthStatusAsString()` The health status of the container.
`String`	`image()` The image used for the container.
`String`	`imageDigest()` The container image manifest digest.
`String`	`lastStatus()` The last known status of the container.
`List<ManagedAgent>`	`managedAgents()` The details of any Amazon ECS managed agents associated with the container.
`String`	`memory()` The hard limit (in MiB) of memory set for the container.
`String`	`memoryReservation()` The soft limit (in MiB) of memory set for the container.
`String`	`name()` The name of the container.
`List<NetworkBinding>`	`networkBindings()` The network bindings associated with the container.
`List<NetworkInterface>`	`networkInterfaces()` The network interfaces associated with the container.
`String`	`reason()` A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
`String`	`runtimeId()` The ID of the Docker container.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Container.Builder>`	`serializableBuilderClass()`
`String`	`taskArn()` The ARN of the task.
`Container.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - 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.
    
    The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.
    
    Returns:
    
    The container image manifest digest.
    
    The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.
  - 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 are not 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 are not configured for this container in its task definition, then it reports the health status as UNKNOWN.
    
    See Also:
    
    HealthStatus
  - healthStatusAsString
```
public final String healthStatusAsString()
```
    The health status of the container. If health checks are not 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 are not configured for this container in its task definition, then it reports the health status as UNKNOWN.
    
    See Also:
    
    HealthStatus
  - 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 will be 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 will be 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Container.Builder,Container>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class Container

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

containerArn

taskArn

name

image

imageDigest

runtimeId

lastStatus

exitCode

reason

hasNetworkBindings

networkBindings

hasNetworkInterfaces

networkInterfaces

healthStatus

healthStatusAsString

hasManagedAgents

managedAgents

cpu

memory

memoryReservation

hasGpuIds

gpuIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields