Class Container
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Container.Builder,
Container>
A Docker container that's part of a task.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Container.Builder
builder()
final String
The Amazon Resource Name (ARN) of the container.final String
cpu()
The number of CPU units set for the container.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
exitCode()
The exit code returned from the container.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) gpuIds()
The IDs of each GPU assigned to the container.final boolean
For responses, this returns true if the service returned a value for the GpuIds property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ManagedAgents property.final boolean
For responses, this returns true if the service returned a value for the NetworkBindings property.final boolean
For responses, this returns true if the service returned a value for the NetworkInterfaces property.final HealthStatus
The health status of the container.final String
The health status of the container.final String
image()
The image used for the container.final String
The container image manifest digest.final String
The last known status of the container.final List
<ManagedAgent> The details of any Amazon ECS managed agents associated with the container.final String
memory()
The hard limit (in MiB) of memory set for the container.final String
The soft limit (in MiB) of memory set for the container.final String
name()
The name of the container.final List
<NetworkBinding> The network bindings associated with the container.final List
<NetworkInterface> The network interfaces associated with the container.final String
reason()
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.final String
The ID of the Docker container.static Class
<? extends Container.Builder> final String
taskArn()
The ARN of the task.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
containerArn
The Amazon Resource Name (ARN) of the container.
- Returns:
- The Amazon Resource Name (ARN) of the container.
-
taskArn
The ARN of the task.
- Returns:
- The ARN of the task.
-
name
The name of the container.
- Returns:
- The name of the container.
-
image
The image used for the container.
- Returns:
- The image used for the container.
-
imageDigest
The container image manifest digest.
- Returns:
- The container image manifest digest.
-
runtimeId
The ID of the Docker container.
- Returns:
- The ID of the Docker container.
-
lastStatus
The last known status of the container.
- Returns:
- The last known status of the container.
-
exitCode
The exit code returned from the container.
- Returns:
- The exit code returned from the container.
-
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 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. -
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 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. -
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
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 returnHealthStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthStatusAsString()
.- 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
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 returnHealthStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthStatusAsString()
.- 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 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. -
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
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
The hard limit (in MiB) of memory set for the container.
- Returns:
- The hard limit (in MiB) of memory set for the container.
-
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 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. -
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
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<Container.Builder,
Container> - 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
-