Class AwsEcsTaskDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsEcsTaskDetails.Builder,
AwsEcsTaskDetails>
Provides details about a task in a cluster.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic AwsEcsTaskDetails.Builder
builder()
final String
The Amazon Resource Name (ARN) of the cluster that hosts the task.final List
<AwsEcsContainerDetails> The containers that are associated with the task.final String
The Unix timestamp for the time when the task was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final String
group()
The name of the task group that's associated with the task.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.static Class
<? extends AwsEcsTaskDetails.Builder> final String
The Unix timestamp for the time when the task started.final String
The tag specified when a task is started.final String
The ARN of the task definition that creates 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.final String
version()
The version counter for the task.final List
<AwsEcsTaskVolumeDetails> volumes()
Details about the data volume that is used in a task definition.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clusterArn
The Amazon Resource Name (ARN) of the cluster that hosts the task.
- Returns:
- The Amazon Resource Name (ARN) of the cluster that hosts the task.
-
taskDefinitionArn
The ARN of the task definition that creates the task.
- Returns:
- The ARN of the task definition that creates the task.
-
version
The version counter for the task.
- Returns:
- The version counter for the task.
-
createdAt
The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the
PENDING
state.- Returns:
- The Unix timestamp for the time when the task was created. More specifically, it's for the time when the
task entered the
PENDING
state.
-
startedAt
The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the
PENDING
state to theRUNNING
state.- Returns:
- The Unix timestamp for the time when the task started. More specifically, it's for the time when the task
transitioned from the
PENDING
state to theRUNNING
state.
-
startedBy
The tag specified when a task is started. If an Amazon ECS service started the task, the
startedBy
parameter contains the deployment ID of that service.- Returns:
- The tag specified when a task is started. If an Amazon ECS service started the task, the
startedBy
parameter contains the deployment ID of that service.
-
group
The name of the task group that's associated with the task.
- Returns:
- The name of the task group that's associated with the task.
-
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
Details about the data volume that is used in a task definition.
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:
- Details about the data volume that is used in a task definition.
-
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
The containers that are associated with the task.
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:
- The containers that are associated with the task.
-
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<AwsEcsTaskDetails.Builder,
AwsEcsTaskDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-