JobDescriptor (AWS Java SDK :: Services :: Amazon S3 Control 2.11.6 API)

java.lang.Object
- software.amazon.awssdk.services.s3control.model.JobDescriptor

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobDescriptor.Builder,JobDescriptor>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface JobDescriptor.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JobDescriptor.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static JobDescriptor.Builder`	`builder()`
`Boolean`	`confirmationRequired()` Indicates whether confirmation is required before Amazon S3 begins running the specified job.
`Instant`	`creationTime()` A timestamp indicating when this job was created.
`String`	`description()` The description for this job, if one was provided in this job's `Create Job` request.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<JobFailure>`	`failureReasons()` If the specified job failed, this field contains information describing the failure.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFailureReasons()` Returns true if the FailureReasons property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`String`	`jobArn()` The Amazon Resource Name (ARN) for this job.
`String`	`jobId()` The ID for the specified job.
`JobManifest`	`manifest()` The configuration information for the specified job's manifest object.
`JobOperation`	`operation()` The operation that the specified job is configured to execute on the objects listed in the manifest.
`Integer`	`priority()` The priority of the specified job.
`JobProgressSummary`	`progressSummary()` Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.
`JobReport`	`report()` Contains the configuration information for the job-completion report if you requested one in the `Create Job` request.
`String`	`roleArn()` The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role assigned to execute the tasks for this job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends JobDescriptor.Builder>`	`serializableBuilderClass()`
`JobStatus`	`status()` The current status of the specified job.
`String`	`statusAsString()` The current status of the specified job.
`String`	`statusUpdateReason()`
`String`	`suspendedCause()` The reason why the specified job was suspended.
`Instant`	`suspendedDate()` The timestamp when this job was suspended, if it has been suspended.
`Instant`	`terminationDate()` A timestamp indicating when this job terminated.
`JobDescriptor.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - jobId
```
public String jobId()
```
    The ID for the specified job.
    
    Returns:
    
    The ID for the specified job.
  - confirmationRequired
```
public 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 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 String jobArn()
```
    The Amazon Resource Name (ARN) for this job.
    
    Returns:
    
    The Amazon Resource Name (ARN) for this job.
  - status
```
public 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:
    
    JobStatus
  - statusAsString
```
public 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:
    
    JobStatus
  - manifest
```
public 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 JobOperation operation()
```
    The operation that the specified job is configured to execute on the objects listed in the manifest.
    
    Returns:
    
    The operation that the specified job is configured to execute on the objects listed in the manifest.
  - priority
```
public Integer priority()
```
    The priority of the specified job.
    
    Returns:
    
    The priority of the specified job.
  - progressSummary
```
public JobProgressSummary progressSummary()
```
    Describes the total number of tasks that the specified job has executed, 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 executed, the number of tasks that succeeded, and the number of tasks that failed.
  - statusUpdateReason
```
public String statusUpdateReason()
```
    Returns:
  - hasFailureReasons
```
public boolean hasFailureReasons()
```
    Returns true if the FailureReasons property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - failureReasons
```
public 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.
    
    You can use hasFailureReasons() to see if a value was sent in this field.
    
    Returns:
    
    If the specified job failed, this field contains information describing the failure.
  - report
```
public 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 Instant creationTime()
```
    A timestamp indicating when this job was created.
    
    Returns:
    
    A timestamp indicating when this job was created.
  - terminationDate
```
public 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 String roleArn()
```
    The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role assigned to execute the tasks for this job.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role assigned to execute the tasks for this job.
  - suspendedDate
```
public 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 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.
  - toBuilder
```
public JobDescriptor.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<JobDescriptor.Builder,JobDescriptor>
  - builder
```
public static JobDescriptor.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends JobDescriptor.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class JobDescriptor

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jobId

confirmationRequired

description

jobArn

status

statusAsString

manifest

operation

priority

progressSummary

statusUpdateReason

hasFailureReasons

failureReasons

report

creationTime

terminationDate

roleArn

suspendedDate

suspendedCause

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields