Class JobDescriptor
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<JobDescriptor.Builder,
JobDescriptor>
A container element for the job configuration and status information returned by a Describe Job
request.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic JobDescriptor.Builder
builder()
final Boolean
Indicates whether confirmation is required before Amazon S3 begins running the specified job.final Instant
A timestamp indicating when this job was created.final String
The description for this job, if one was provided in this job'sCreate Job
request.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<JobFailure> If the specified job failed, this field contains information describing the failure.The attribute of the JobDescriptor containing details about the job's generated manifest.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FailureReasons property.final int
hashCode()
final String
jobArn()
The Amazon Resource Name (ARN) for this job.final String
jobId()
The ID for the specified job.final JobManifest
manifest()
The configuration information for the specified job's manifest object.final JobManifestGenerator
The manifest generator that was used to generate a job manifest for this job.final JobOperation
The operation that the specified job is configured to run on the objects listed in the manifest.final Integer
priority()
The priority of the specified job.final JobProgressSummary
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.final JobReport
report()
Contains the configuration information for the job-completion report if you requested one in theCreate Job
request.final String
roleArn()
The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks for this job.static Class
<? extends JobDescriptor.Builder> final JobStatus
status()
The current status of the specified job.final String
The current status of the specified job.final String
The reason for updating the job.final String
The reason why the specified job was suspended.final Instant
The timestamp when this job was suspended, if it has been suspended.final Instant
A timestamp indicating when this job terminated.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobId
The ID for the specified job.
- Returns:
- The ID for the specified job.
-
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
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
The Amazon Resource Name (ARN) for this job.
- Returns:
- The Amazon Resource Name (ARN) for this job.
-
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 returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the specified job.
- See Also:
-
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 returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the specified job.
- See Also:
-
manifest
The configuration information for the specified job's manifest object.
- Returns:
- The configuration information for the specified job's manifest object.
-
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
The priority of the specified job.
- Returns:
- The priority of the specified job.
-
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
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 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. -
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
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
A timestamp indicating when this job was created.
- Returns:
- A timestamp indicating when this job was created.
-
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
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
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
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 theSuspended
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 theSuspended
state.
-
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
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
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 interfaceToCopyableBuilder<JobDescriptor.Builder,
JobDescriptor> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-