EcsTaskDetails (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.batch.model.EcsTaskDetails

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EcsTaskDetails
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The details of a task definition that describes the container and volume definitions of an Amazon ECS task.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EcsTaskDetails()

Constructors
Constructor and Description
`EcsTaskDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EcsTaskDetails`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getContainerInstanceArn()` The Amazon Resource Name (ARN) of the container instance that hosts the task.
`List<TaskContainerDetails>`	`getContainers()` A list of containers that are included in the `taskProperties` list.
`EphemeralStorage`	`getEphemeralStorage()` The amount of ephemeral storage allocated for the task.
`String`	`getExecutionRoleArn()` The Amazon Resource Name (ARN) of the execution role that Batch can assume.
`String`	`getIpcMode()` The IPC resource namespace to use for the containers in the task.
`NetworkConfiguration`	`getNetworkConfiguration()` The network configuration for jobs that are running on Fargate resources.
`String`	`getPidMode()` The process namespace to use for the containers in the task.
`String`	`getPlatformVersion()` The Fargate platform version where the jobs are running.
`RuntimePlatform`	`getRuntimePlatform()` An object that represents the compute environment architecture for Batch jobs on Fargate.
`String`	`getTaskArn()` The ARN of the Amazon ECS task.
`String`	`getTaskRoleArn()` The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions.
`List<Volume>`	`getVolumes()` A list of data volumes used in a job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setContainerInstanceArn(String containerInstanceArn)` The Amazon Resource Name (ARN) of the container instance that hosts the task.
`void`	`setContainers(Collection<TaskContainerDetails> containers)` A list of containers that are included in the `taskProperties` list.
`void`	`setEphemeralStorage(EphemeralStorage ephemeralStorage)` The amount of ephemeral storage allocated for the task.
`void`	`setExecutionRoleArn(String executionRoleArn)` The Amazon Resource Name (ARN) of the execution role that Batch can assume.
`void`	`setIpcMode(String ipcMode)` The IPC resource namespace to use for the containers in the task.
`void`	`setNetworkConfiguration(NetworkConfiguration networkConfiguration)` The network configuration for jobs that are running on Fargate resources.
`void`	`setPidMode(String pidMode)` The process namespace to use for the containers in the task.
`void`	`setPlatformVersion(String platformVersion)` The Fargate platform version where the jobs are running.
`void`	`setRuntimePlatform(RuntimePlatform runtimePlatform)` An object that represents the compute environment architecture for Batch jobs on Fargate.
`void`	`setTaskArn(String taskArn)` The ARN of the Amazon ECS task.
`void`	`setTaskRoleArn(String taskRoleArn)` The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions.
`void`	`setVolumes(Collection<Volume> volumes)` A list of data volumes used in a job.
`String`	`toString()` Returns a string representation of this object.
`EcsTaskDetails`	`withContainerInstanceArn(String containerInstanceArn)` The Amazon Resource Name (ARN) of the container instance that hosts the task.
`EcsTaskDetails`	`withContainers(Collection<TaskContainerDetails> containers)` A list of containers that are included in the `taskProperties` list.
`EcsTaskDetails`	`withContainers(TaskContainerDetails... containers)` A list of containers that are included in the `taskProperties` list.
`EcsTaskDetails`	`withEphemeralStorage(EphemeralStorage ephemeralStorage)` The amount of ephemeral storage allocated for the task.
`EcsTaskDetails`	`withExecutionRoleArn(String executionRoleArn)` The Amazon Resource Name (ARN) of the execution role that Batch can assume.
`EcsTaskDetails`	`withIpcMode(String ipcMode)` The IPC resource namespace to use for the containers in the task.
`EcsTaskDetails`	`withNetworkConfiguration(NetworkConfiguration networkConfiguration)` The network configuration for jobs that are running on Fargate resources.
`EcsTaskDetails`	`withPidMode(String pidMode)` The process namespace to use for the containers in the task.
`EcsTaskDetails`	`withPlatformVersion(String platformVersion)` The Fargate platform version where the jobs are running.
`EcsTaskDetails`	`withRuntimePlatform(RuntimePlatform runtimePlatform)` An object that represents the compute environment architecture for Batch jobs on Fargate.
`EcsTaskDetails`	`withTaskArn(String taskArn)` The ARN of the Amazon ECS task.
`EcsTaskDetails`	`withTaskRoleArn(String taskRoleArn)` The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions.
`EcsTaskDetails`	`withVolumes(Collection<Volume> volumes)` A list of data volumes used in a job.
`EcsTaskDetails`	`withVolumes(Volume... volumes)` A list of data volumes used in a job.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EcsTaskDetails
```
public EcsTaskDetails()
```
- Method Detail
  - getContainers
```
public List<TaskContainerDetails> getContainers()
```
    A list of containers that are included in the taskProperties list.
    
    Returns:
    
    A list of containers that are included in the taskProperties list.
  - setContainers
```
public void setContainers(Collection<TaskContainerDetails> containers)
```
    A list of containers that are included in the taskProperties list.
    
    Parameters:
    
    containers - A list of containers that are included in the taskProperties list.
  - withContainers
```
public EcsTaskDetails withContainers(TaskContainerDetails... containers)
```
    A list of containers that are included in the taskProperties list.
    
    NOTE: This method appends the values to the existing list (if any). Use setContainers(java.util.Collection) or withContainers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    containers - A list of containers that are included in the taskProperties list.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withContainers
```
public EcsTaskDetails withContainers(Collection<TaskContainerDetails> containers)
```
    A list of containers that are included in the taskProperties list.
    
    Parameters:
    
    containers - A list of containers that are included in the taskProperties list.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainerInstanceArn
```
public void setContainerInstanceArn(String containerInstanceArn)
```
    The Amazon Resource Name (ARN) of the container instance that hosts the task.
    
    Parameters:
    
    containerInstanceArn - The Amazon Resource Name (ARN) of the container instance that hosts the task.
  - getContainerInstanceArn
```
public String getContainerInstanceArn()
```
    The Amazon Resource Name (ARN) of the container instance that hosts the task.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the container instance that hosts the task.
  - withContainerInstanceArn
```
public EcsTaskDetails withContainerInstanceArn(String containerInstanceArn)
```
    The Amazon Resource Name (ARN) of the container instance that hosts the task.
    
    Parameters:
    
    containerInstanceArn - The Amazon Resource Name (ARN) of the container instance that hosts the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskArn
```
public void setTaskArn(String taskArn)
```
    The ARN of the Amazon ECS task.
    
    Parameters:
    
    taskArn - The ARN of the Amazon ECS task.
  - getTaskArn
```
public String getTaskArn()
```
    The ARN of the Amazon ECS task.
    
    Returns:
    
    The ARN of the Amazon ECS task.
  - withTaskArn
```
public EcsTaskDetails withTaskArn(String taskArn)
```
    The ARN of the Amazon ECS task.
    
    Parameters:
    
    taskArn - The ARN of the Amazon ECS task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEphemeralStorage
```
public void setEphemeralStorage(EphemeralStorage ephemeralStorage)
```
    The amount of ephemeral storage allocated for the task.
    
    Parameters:
    
    ephemeralStorage - The amount of ephemeral storage allocated for the task.
  - getEphemeralStorage
```
public EphemeralStorage getEphemeralStorage()
```
    The amount of ephemeral storage allocated for the task.
    
    Returns:
    
    The amount of ephemeral storage allocated for the task.
  - withEphemeralStorage
```
public EcsTaskDetails withEphemeralStorage(EphemeralStorage ephemeralStorage)
```
    The amount of ephemeral storage allocated for the task.
    
    Parameters:
    
    ephemeralStorage - The amount of ephemeral storage allocated for the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionRoleArn
```
public void setExecutionRoleArn(String executionRoleArn)
```
    The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.
    
    Parameters:
    
    executionRoleArn - The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.
  - getExecutionRoleArn
```
public String getExecutionRoleArn()
```
    The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.
  - withExecutionRoleArn
```
public EcsTaskDetails withExecutionRoleArn(String executionRoleArn)
```
    The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.
    
    Parameters:
    
    executionRoleArn - The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlatformVersion
```
public void setPlatformVersion(String platformVersion)
```
    The Fargate platform version where the jobs are running.
    
    Parameters:
    
    platformVersion - The Fargate platform version where the jobs are running.
  - getPlatformVersion
```
public String getPlatformVersion()
```
    The Fargate platform version where the jobs are running.
    
    Returns:
    
    The Fargate platform version where the jobs are running.
  - withPlatformVersion
```
public EcsTaskDetails withPlatformVersion(String platformVersion)
```
    The Fargate platform version where the jobs are running.
    
    Parameters:
    
    platformVersion - The Fargate platform version where the jobs are running.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpcMode
```
public void setIpcMode(String ipcMode)
```
    The IPC resource namespace to use for the containers in the task.
    
    Parameters:
    
    ipcMode - The IPC resource namespace to use for the containers in the task.
  - getIpcMode
```
public String getIpcMode()
```
    The IPC resource namespace to use for the containers in the task.
    
    Returns:
    
    The IPC resource namespace to use for the containers in the task.
  - withIpcMode
```
public EcsTaskDetails withIpcMode(String ipcMode)
```
    The IPC resource namespace to use for the containers in the task.
    
    Parameters:
    
    ipcMode - The IPC resource namespace to use for the containers in the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskRoleArn
```
public void setTaskRoleArn(String taskRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
    
    This is object is comparable to ContainerProperties:jobRoleArn.
    
    Parameters:
    
    taskRoleArn - The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
    
    This is object is comparable to ContainerProperties:jobRoleArn.
  - getTaskRoleArn
```
public String getTaskRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
    
    This is object is comparable to ContainerProperties:jobRoleArn.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
    
    This is object is comparable to ContainerProperties:jobRoleArn.
  - withTaskRoleArn
```
public EcsTaskDetails withTaskRoleArn(String taskRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
    
    This is object is comparable to ContainerProperties:jobRoleArn.
    
    Parameters:
    
    taskRoleArn - The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
    
    This is object is comparable to ContainerProperties:jobRoleArn.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPidMode
```
public void setPidMode(String pidMode)
```
    The process namespace to use for the containers in the task.
    
    Parameters:
    
    pidMode - The process namespace to use for the containers in the task.
  - getPidMode
```
public String getPidMode()
```
    The process namespace to use for the containers in the task.
    
    Returns:
    
    The process namespace to use for the containers in the task.
  - withPidMode
```
public EcsTaskDetails withPidMode(String pidMode)
```
    The process namespace to use for the containers in the task.
    
    Parameters:
    
    pidMode - The process namespace to use for the containers in the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNetworkConfiguration
```
public void setNetworkConfiguration(NetworkConfiguration networkConfiguration)
```
    The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
    
    Parameters:
    
    networkConfiguration - The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
  - getNetworkConfiguration
```
public NetworkConfiguration getNetworkConfiguration()
```
    The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
    
    Returns:
    
    The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
  - withNetworkConfiguration
```
public EcsTaskDetails withNetworkConfiguration(NetworkConfiguration networkConfiguration)
```
    The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
    
    Parameters:
    
    networkConfiguration - The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuntimePlatform
```
public void setRuntimePlatform(RuntimePlatform runtimePlatform)
```
    An object that represents the compute environment architecture for Batch jobs on Fargate.
    
    Parameters:
    
    runtimePlatform - An object that represents the compute environment architecture for Batch jobs on Fargate.
  - getRuntimePlatform
```
public RuntimePlatform getRuntimePlatform()
```
    An object that represents the compute environment architecture for Batch jobs on Fargate.
    
    Returns:
    
    An object that represents the compute environment architecture for Batch jobs on Fargate.
  - withRuntimePlatform
```
public EcsTaskDetails withRuntimePlatform(RuntimePlatform runtimePlatform)
```
    An object that represents the compute environment architecture for Batch jobs on Fargate.
    
    Parameters:
    
    runtimePlatform - An object that represents the compute environment architecture for Batch jobs on Fargate.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVolumes
```
public List<Volume> getVolumes()
```
    A list of data volumes used in a job.
    
    Returns:
    
    A list of data volumes used in a job.
  - setVolumes
```
public void setVolumes(Collection<Volume> volumes)
```
    A list of data volumes used in a job.
    
    Parameters:
    
    volumes - A list of data volumes used in a job.
  - withVolumes
```
public EcsTaskDetails withVolumes(Volume... volumes)
```
    A list of data volumes used in a job.
    
    NOTE: This method appends the values to the existing list (if any). Use setVolumes(java.util.Collection) or withVolumes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    volumes - A list of data volumes used in a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVolumes
```
public EcsTaskDetails withVolumes(Collection<Volume> volumes)
```
    A list of data volumes used in a job.
    
    Parameters:
    
    volumes - A list of data volumes used in a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EcsTaskDetails clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class EcsTaskDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EcsTaskDetails

Method Detail

getContainers

setContainers

withContainers

withContainers

setContainerInstanceArn

getContainerInstanceArn

withContainerInstanceArn

setTaskArn

getTaskArn

withTaskArn

setEphemeralStorage

getEphemeralStorage

withEphemeralStorage

setExecutionRoleArn

getExecutionRoleArn

withExecutionRoleArn

setPlatformVersion

getPlatformVersion

withPlatformVersion

setIpcMode

getIpcMode

withIpcMode

setTaskRoleArn

getTaskRoleArn

withTaskRoleArn

setPidMode

getPidMode

withPidMode

setNetworkConfiguration

getNetworkConfiguration

withNetworkConfiguration

setRuntimePlatform

getRuntimePlatform

withRuntimePlatform

getVolumes

setVolumes

withVolumes

withVolumes

toString

equals

hashCode

clone

marshall