ContainerDetail (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.batch.model.ContainerDetail

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ContainerDetail.Builder,ContainerDetail>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ContainerDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ContainerDetail.Builder,ContainerDetail>
```
An object representing the details of a container that is part of a job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ContainerDetail.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ContainerDetail.Builder`	`builder()`
`List<String>`	`command()` The command that is passed to the container.
`String`	`containerInstanceArn()` The Amazon Resource Name (ARN) of the container instance on which the container is running.
`List<KeyValuePair>`	`environment()` The environment variables to pass to a container.
`boolean`	`equals(Object obj)`
`Integer`	`exitCode()` The exit code to return upon completion.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`image()` The image used to start the container.
`String`	`instanceType()` The instance type of the underlying host infrastructure of a multi-node parallel job.
`String`	`jobRoleArn()` The Amazon Resource Name (ARN) associated with the job upon execution.
`String`	`logStreamName()` The name of the CloudWatch Logs log stream associated with the container.
`Integer`	`memory()` The number of MiB of memory reserved for the job.
`List<MountPoint>`	`mountPoints()` The mount points for data volumes in your container.
`List<NetworkInterface>`	`networkInterfaces()` The network interfaces associated with the job.
`Boolean`	`privileged()` When this parameter is true, the container is given elevated privileges on the host container instance (similar to the `root` user).
`Boolean`	`readonlyRootFilesystem()` When this parameter is true, the container is given read-only access to its root file system.
`String`	`reason()` A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ContainerDetail.Builder>`	`serializableBuilderClass()`
`String`	`taskArn()` The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.
`ContainerDetail.Builder`	`toBuilder()`
`String`	`toString()`
`List<Ulimit>`	`ulimits()` A list of `ulimit` values to set in the container.
`String`	`user()` The user name to use inside the container.
`Integer`	`vcpus()` The number of VCPUs allocated for the job.
`List<Volume>`	`volumes()` A list of volumes associated with the job.

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
  - image
```
public String image()
```
    The image used to start the container.
    
    Returns:
    
    The image used to start the container.
  - vcpus
```
public Integer vcpus()
```
    The number of VCPUs allocated for the job.
    
    Returns:
    
    The number of VCPUs allocated for the job.
  - memory
```
public Integer memory()
```
    The number of MiB of memory reserved for the job.
    
    Returns:
    
    The number of MiB of memory reserved for the job.
  - command
```
public List<String> command()
```
    The command that is passed to the container.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The command that is passed to the container.
  - jobRoleArn
```
public String jobRoleArn()
```
    The Amazon Resource Name (ARN) associated with the job upon execution.
    
    Returns:
    
    The Amazon Resource Name (ARN) associated with the job upon execution.
  - volumes
```
public List<Volume> volumes()
```
    A list of volumes associated with the job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of volumes associated with the job.
  - environment
```
public List<KeyValuePair> environment()
```
    The environment variables to pass to a container.
    
    Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The environment variables to pass to a container.
    
    Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
  - mountPoints
```
public List<MountPoint> mountPoints()
```
    The mount points for data volumes in your container.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The mount points for data volumes in your container.
  - readonlyRootFilesystem
```
public Boolean readonlyRootFilesystem()
```
    When this parameter is true, the container is given read-only access to its root file system.
    
    Returns:
    
    When this parameter is true, the container is given read-only access to its root file system.
  - ulimits
```
public List<Ulimit> ulimits()
```
    A list of ulimit values to set in the container.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of ulimit values to set in the container.
  - privileged
```
public Boolean privileged()
```
    When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
    
    Returns:
    
    When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
  - user
```
public String user()
```
    The user name to use inside the container.
    
    Returns:
    
    The user name to use inside the container.
  - exitCode
```
public Integer exitCode()
```
    The exit code to return upon completion.
    
    Returns:
    
    The exit code to return upon completion.
  - reason
```
public 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.
  - containerInstanceArn
```
public String containerInstanceArn()
```
    The Amazon Resource Name (ARN) of the container instance on which the container is running.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the container instance on which the container is running.
  - taskArn
```
public String taskArn()
```
    The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.
  - logStreamName
```
public String logStreamName()
```
    The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.
    
    Returns:
    
    The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.
  - instanceType
```
public String instanceType()
```
    The instance type of the underlying host infrastructure of a multi-node parallel job.
    
    Returns:
    
    The instance type of the underlying host infrastructure of a multi-node parallel job.
  - networkInterfaces
```
public List<NetworkInterface> networkInterfaces()
```
    The network interfaces associated with the job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The network interfaces associated with the job.
  - toBuilder
```
public ContainerDetail.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ContainerDetail.Builder,ContainerDetail>
  - builder
```
public static ContainerDetail.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ContainerDetail.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ContainerDetail

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

image

vcpus

memory

command

jobRoleArn

volumes

environment

mountPoints

readonlyRootFilesystem

ulimits

privileged

user

exitCode

reason

containerInstanceArn

taskArn

logStreamName

instanceType

networkInterfaces

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields