Class EcsTaskDetails
- java.lang.Object
-
- software.amazon.awssdk.services.batch.model.EcsTaskDetails
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<EcsTaskDetails.Builder,EcsTaskDetails>
@Generated("software.amazon.awssdk:codegen") public final class EcsTaskDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EcsTaskDetails.Builder,EcsTaskDetails>
The details of a task definition that describes the container and volume definitions of an Amazon ECS task.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceEcsTaskDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static EcsTaskDetails.Builderbuilder()StringcontainerInstanceArn()The Amazon Resource Name (ARN) of the container instance that hosts the task.List<TaskContainerDetails>containers()A list of containers that are included in thetaskPropertieslist.EphemeralStorageephemeralStorage()The amount of ephemeral storage allocated for the task.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexecutionRoleArn()The Amazon Resource Name (ARN) of the execution role that Batch can assume.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasContainers()For responses, this returns true if the service returned a value for the Containers property.inthashCode()booleanhasVolumes()For responses, this returns true if the service returned a value for the Volumes property.StringipcMode()The IPC resource namespace to use for the containers in the task.NetworkConfigurationnetworkConfiguration()The network configuration for jobs that are running on Fargate resources.StringpidMode()The process namespace to use for the containers in the task.StringplatformVersion()The Fargate platform version where the jobs are running.RuntimePlatformruntimePlatform()An object that represents the compute environment architecture for Batch jobs on Fargate.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends EcsTaskDetails.Builder>serializableBuilderClass()StringtaskArn()The ARN of the Amazon ECS task.StringtaskRoleArn()The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions.EcsTaskDetails.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<Volume>volumes()A list of data volumes used in a 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
-
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
public final List<TaskContainerDetails> containers()
A list of containers that are included in the
taskPropertieslist.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
taskPropertieslist.
-
containerInstanceArn
public final String 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
public final String taskArn()
The ARN of the Amazon ECS task.
- Returns:
- The ARN of the Amazon ECS task.
-
ephemeralStorage
public final EphemeralStorage ephemeralStorage()
The amount of ephemeral storage allocated for the task.
- Returns:
- The amount of ephemeral storage allocated for the task.
-
executionRoleArn
public final 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.
- 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
public final String platformVersion()
The Fargate platform version where the jobs are running.
- Returns:
- The Fargate platform version where the jobs are running.
-
ipcMode
public final String 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
public final 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.
- 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
public final String 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
public final 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.
- 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
public final RuntimePlatform 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
public final List<Volume> 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
public EcsTaskDetails.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<EcsTaskDetails.Builder,EcsTaskDetails>
-
builder
public static EcsTaskDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends EcsTaskDetails.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-