Class EcsTaskDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EcsTaskDetails.Builder,
EcsTaskDetails>
The details of a task definition that describes the container and volume definitions of an Amazon ECS task.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EcsTaskDetails.Builder
builder()
final String
The Amazon Resource Name (ARN) of the container instance that hosts the task.final List
<TaskContainerDetails> A list of containers that are included in thetaskProperties
list.final EphemeralStorage
The amount of ephemeral storage allocated for the task.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Name (ARN) of the execution role that Batch can assume.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Containers property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Volumes property.final String
ipcMode()
The IPC resource namespace to use for the containers in the task.final NetworkConfiguration
The network configuration for jobs that are running on Fargate resources.final String
pidMode()
The process namespace to use for the containers in the task.final String
The Fargate platform version where the jobs are running.final RuntimePlatform
An object that represents the compute environment architecture for Batch jobs on Fargate.static Class
<? extends EcsTaskDetails.Builder> final String
taskArn()
The ARN of the Amazon ECS task.final String
The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions.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.volumes()
A list of data volumes used in a job.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasContainers
public final boolean hasContainers()For responses, this returns true if the service returned a value for the Containers 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. -
containers
A list of containers that are included in the
taskProperties
list.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
hasContainers()
method.- Returns:
- A list of containers that are included in the
taskProperties
list.
-
containerInstanceArn
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.
-
taskArn
The ARN of the Amazon ECS task.
- Returns:
- The ARN of the Amazon ECS task.
-
ephemeralStorage
The amount of ephemeral storage allocated for the task.
- Returns:
- The amount of ephemeral storage allocated for the task.
-
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:
- 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.
-
platformVersion
The Fargate platform version where the jobs are running.
- Returns:
- The Fargate platform version where the jobs are running.
-
ipcMode
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.
-
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:
- 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.
-
pidMode
The process namespace to use for the containers in the task.
- Returns:
- The process namespace to use for the containers in the task.
-
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:
- The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
-
runtimePlatform
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.
-
hasVolumes
public final boolean hasVolumes()For responses, this returns true if the service returned a value for the Volumes 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. -
volumes
A list of data volumes used in a job.
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
hasVolumes()
method.- Returns:
- A list of data volumes used in a job.
-
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<EcsTaskDetails.Builder,
EcsTaskDetails> - 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
-