Class JobListDescriptor

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

Contains the configuration and status information for a single job retrieved as part of a job list.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The ID for the specified job.

      Returns:
      The ID for the specified job.

    • description

      public final String description()

      The user-specified description that was included in the specified job's Create Job request.

      Returns:
      The user-specified description that was included in the specified job's Create Job request.

    • operation

      public final OperationName operation()

      The operation that the specified job is configured to run on every object listed in the manifest.

      If the service returns an enum value that is not available in the current SDK version, operation will return OperationName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().

      Returns:
      The operation that the specified job is configured to run on every object listed in the manifest.
      See Also:

    • operationAsString

      public final String operationAsString()

      The operation that the specified job is configured to run on every object listed in the manifest.

      If the service returns an enum value that is not available in the current SDK version, operation will return OperationName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().

      Returns:
      The operation that the specified job is configured to run on every object listed in the manifest.
      See Also:

    • priority

      public final Integer priority()

      The current priority for the specified job.

      Returns:
      The current priority for the specified job.

    • status

      public final JobStatus status()

      The specified job's current status.

      If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The specified job's current status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The specified job's current status.

      If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The specified job's current status.
      See Also:

    • creationTime

      public final Instant creationTime()

      A timestamp indicating when the specified job was created.

      Returns:
      A timestamp indicating when the specified job was created.

    • terminationDate

      public final Instant terminationDate()

      A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

      Returns:
      A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

    • progressSummary

      public final JobProgressSummary progressSummary()

      Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

      Returns:
      Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

    • toBuilder

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

    • builder

      public static JobListDescriptor.Builder builder()

    • serializableBuilderClass

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