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:

  • Method Details

    • 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 STARTING status.

      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 STARTING status.

    • 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 the RUNNING status.

      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 the RUNNING status.

    • 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 the isEmpty() 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()
      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 interface ToCopyableBuilder<AttemptContainerDetail.Builder,AttemptContainerDetail>
      Returns:
      a builder for type T

    • builder

      public static AttemptContainerDetail.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AttemptContainerDetail.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.