Class JobDescriptor

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

A container element for the job configuration and status information returned by a Describe Job request.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The ID for the specified job.

      Returns:
      The ID for the specified job.

    • confirmationRequired

      public final Boolean confirmationRequired()

      Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

      Returns:
      Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

    • description

      public final String description()

      The description for this job, if one was provided in this job's Create Job request.

      Returns:
      The description for this job, if one was provided in this job's Create Job request.

    • jobArn

      public final String jobArn()

      The Amazon Resource Name (ARN) for this job.

      Returns:
      The Amazon Resource Name (ARN) for this job.

    • status

      public final JobStatus status()

      The current status of the specified job.

      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 current status of the specified job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the specified job.

      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 current status of the specified job.
      See Also:

    • manifest

      public final JobManifest manifest()

      The configuration information for the specified job's manifest object.

      Returns:
      The configuration information for the specified job's manifest object.

    • operation

      public final JobOperation operation()

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

      Returns:
      The operation that the specified job is configured to run on the objects listed in the manifest.

    • priority

      public final Integer priority()

      The priority of the specified job.

      Returns:
      The priority of the specified job.

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

    • statusUpdateReason

      public final String statusUpdateReason()

      The reason for updating the job.

      Returns:
      The reason for updating the job.

    • hasFailureReasons

      public final boolean hasFailureReasons()
      For responses, this returns true if the service returned a value for the FailureReasons 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.

    • failureReasons

      public final List<JobFailure> failureReasons()

      If the specified job failed, this field contains information describing the failure.

      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 hasFailureReasons() method.

      Returns:
      If the specified job failed, this field contains information describing the failure.

    • report

      public final JobReport report()

      Contains the configuration information for the job-completion report if you requested one in the Create Job request.

      Returns:
      Contains the configuration information for the job-completion report if you requested one in the Create Job request.

    • creationTime

      public final Instant creationTime()

      A timestamp indicating when this job was created.

      Returns:
      A timestamp indicating when this job was created.

    • terminationDate

      public final Instant terminationDate()

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

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

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks for this job.

      Returns:
      The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks for this job.

    • suspendedDate

      public final Instant suspendedDate()

      The timestamp when this job was suspended, if it has been suspended.

      Returns:
      The timestamp when this job was suspended, if it has been suspended.

    • suspendedCause

      public final String suspendedCause()

      The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

      Returns:
      The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

    • manifestGenerator

      public final JobManifestGenerator manifestGenerator()

      The manifest generator that was used to generate a job manifest for this job.

      Returns:
      The manifest generator that was used to generate a job manifest for this job.

    • generatedManifestDescriptor

      public final S3GeneratedManifestDescriptor generatedManifestDescriptor()

      The attribute of the JobDescriptor containing details about the job's generated manifest.

      Returns:
      The attribute of the JobDescriptor containing details about the job's generated manifest.

    • toBuilder

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

    • builder

      public static JobDescriptor.Builder builder()

    • serializableBuilderClass

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