Class ListJobsByConsumableResourceSummary

java.lang.Object
software.amazon.awssdk.services.batch.model.ListJobsByConsumableResourceSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ListJobsByConsumableResourceSummary.Builder,ListJobsByConsumableResourceSummary>
@Generated("software.amazon.awssdk:codegen") public final class ListJobsByConsumableResourceSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ListJobsByConsumableResourceSummary.Builder,ListJobsByConsumableResourceSummary>

Current information about a consumable resource required by a job.

See Also:

  • Method Details

    • jobArn

      public final String jobArn()

      The Amazon Resource Name (ARN) of the job.

      Returns:
      The Amazon Resource Name (ARN) of the job.

    • jobQueueArn

      public final String jobQueueArn()

      The Amazon Resource Name (ARN) of the job queue.

      Returns:
      The Amazon Resource Name (ARN) of the job queue.

    • jobName

      public final String jobName()

      The name of the job.

      Returns:
      The name of the job.

    • jobDefinitionArn

      public final String jobDefinitionArn()

      The Amazon Resource Name (ARN) of the job definition.

      Returns:
      The Amazon Resource Name (ARN) of the job definition.

    • shareIdentifier

      public final String shareIdentifier()

      The fair-share scheduling policy identifier for the job.

      Returns:
      The fair-share scheduling policy identifier for the job.

    • jobStatus

      public final String jobStatus()

      The status of the job. Can be one of:

      • SUBMITTED

      • PENDING

      • RUNNABLE

      • STARTING

      • RUNNING

      • SUCCEEDED

      • FAILED

      Returns:
      The status of the job. Can be one of:

      • SUBMITTED

      • PENDING

      • RUNNABLE

      • STARTING

      • RUNNING

      • SUCCEEDED

      • FAILED

    • quantity

      public final Long quantity()

      The total amount of the consumable resource that is available.

      Returns:
      The total amount of the consumable resource that is available.

    • statusReason

      public final String statusReason()

      A short, human-readable string to provide more details for the current status of the job.

      Returns:
      A short, human-readable string to provide more details for the current status of the job.

    • startedAt

      public final Long startedAt()

      The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

      Returns:
      The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

    • createdAt

      public final Long createdAt()

      The Unix timestamp (in milliseconds) for when the consumable resource was created.

      Returns:
      The Unix timestamp (in milliseconds) for when the consumable resource was created.

    • consumableResourceProperties

      public final ConsumableResourceProperties consumableResourceProperties()

      Contains a list of consumable resources required by the job.

      Returns:
      Contains a list of consumable resources required by the job.

    • toBuilder

      public ListJobsByConsumableResourceSummary.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<ListJobsByConsumableResourceSummary.Builder,ListJobsByConsumableResourceSummary>
      Returns:
      a builder for type T

    • builder

      public static ListJobsByConsumableResourceSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListJobsByConsumableResourceSummary.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.