Class AttemptContainerDetail
- java.lang.Object
-
- software.amazon.awssdk.services.batch.model.AttemptContainerDetail
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AttemptContainerDetail.Builder,AttemptContainerDetail>
@Generated("software.amazon.awssdk:codegen") public final class AttemptContainerDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AttemptContainerDetail.Builder,AttemptContainerDetail>
An object that represents the details of a container that's part of a job attempt.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAttemptContainerDetail.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AttemptContainerDetail.Builderbuilder()StringcontainerInstanceArn()The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)IntegerexitCode()The exit code for the job attempt.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasNetworkInterfaces()For responses, this returns true if the service returned a value for the NetworkInterfaces property.StringlogStreamName()The name of the CloudWatch Logs log stream that's associated with the container.List<NetworkInterface>networkInterfaces()The network interfaces that are associated with the job attempt.Stringreason()A short (255 max characters) human-readable string to provide additional details for a running or stopped container.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends AttemptContainerDetail.Builder>serializableBuilderClass()StringtaskArn()The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt.AttemptContainerDetail.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
containerInstanceArn
public final String containerInstanceArn()
The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
- Returns:
- The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
-
taskArn
public final String taskArn()
The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container attempt receives a task ARN when they reach the
STARTINGstatus.- Returns:
- The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each
container attempt receives a task ARN when they reach the
STARTINGstatus.
-
exitCode
public final Integer exitCode()
The exit code for the job attempt. A non-zero exit code is considered failed.
- Returns:
- The exit code for the job attempt. A non-zero exit code is considered failed.
-
reason
public final String reason()
A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
- Returns:
- A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
-
logStreamName
public final String logStreamName()
The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is
/aws/batch/job. Each container attempt receives a log stream name when they reach theRUNNINGstatus.- Returns:
- The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch
jobs is
/aws/batch/job. Each container attempt receives a log stream name when they reach theRUNNINGstatus.
-
hasNetworkInterfaces
public final boolean hasNetworkInterfaces()
For responses, this returns true if the service returned a value for the NetworkInterfaces 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.
-
networkInterfaces
public final List<NetworkInterface> networkInterfaces()
The network interfaces that are associated with the job attempt.
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
hasNetworkInterfaces()method.- Returns:
- The network interfaces that are associated with the job attempt.
-
toBuilder
public AttemptContainerDetail.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AttemptContainerDetail.Builder,AttemptContainerDetail>
-
builder
public static AttemptContainerDetail.Builder builder()
-
serializableBuilderClass
public static Class<? extends AttemptContainerDetail.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
-
-