JobDescriptor (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.s3control.model.JobDescriptor

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobDescriptor
extends Object
implements Serializable, Cloneable
```
A container element for the job configuration and status information returned by a Describe Job request.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobDescriptor()

Constructors
Constructor and Description
`JobDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobDescriptor`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getConfirmationRequired()` Indicates whether confirmation is required before Amazon S3 begins running the specified job.
`Date`	`getCreationTime()` A timestamp indicating when this job was created.
`String`	`getDescription()` The description for this job, if one was provided in this job's `Create Job` request.
`List<JobFailure>`	`getFailureReasons()` If the specified job failed, this field contains information describing the failure.
`String`	`getJobArn()` The Amazon Resource Name (ARN) for this job.
`String`	`getJobId()` The ID for the specified job.
`JobManifest`	`getManifest()` The configuration information for the specified job's manifest object.
`JobOperation`	`getOperation()` The operation that the specified job is configured to execute on the objects listed in the manifest.
`Integer`	`getPriority()` The priority of the specified job.
`JobProgressSummary`	`getProgressSummary()` 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`	`getReport()` Contains the configuration information for the job-completion report if you requested one in the `Create Job` request.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to execute the tasks for this job.
`String`	`getStatus()` The current status of the specified job.
`String`	`getStatusUpdateReason()`
`String`	`getSuspendedCause()` The reason why the specified job was suspended.
`Date`	`getSuspendedDate()` The timestamp when this job was suspended, if it has been suspended.
`Date`	`getTerminationDate()` A timestamp indicating when this job terminated.
`int`	`hashCode()`
`Boolean`	`isConfirmationRequired()` Indicates whether confirmation is required before Amazon S3 begins running the specified job.
`void`	`setConfirmationRequired(Boolean confirmationRequired)` Indicates whether confirmation is required before Amazon S3 begins running the specified job.
`void`	`setCreationTime(Date creationTime)` A timestamp indicating when this job was created.
`void`	`setDescription(String description)` The description for this job, if one was provided in this job's `Create Job` request.
`void`	`setFailureReasons(Collection<JobFailure> failureReasons)` If the specified job failed, this field contains information describing the failure.
`void`	`setJobArn(String jobArn)` The Amazon Resource Name (ARN) for this job.
`void`	`setJobId(String jobId)` The ID for the specified job.
`void`	`setManifest(JobManifest manifest)` The configuration information for the specified job's manifest object.
`void`	`setOperation(JobOperation operation)` The operation that the specified job is configured to execute on the objects listed in the manifest.
`void`	`setPriority(Integer priority)` The priority of the specified job.
`void`	`setProgressSummary(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.
`void`	`setReport(JobReport report)` Contains the configuration information for the job-completion report if you requested one in the `Create Job` request.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to execute the tasks for this job.
`void`	`setStatus(String status)` The current status of the specified job.
`void`	`setStatusUpdateReason(String statusUpdateReason)`
`void`	`setSuspendedCause(String suspendedCause)` The reason why the specified job was suspended.
`void`	`setSuspendedDate(Date suspendedDate)` The timestamp when this job was suspended, if it has been suspended.
`void`	`setTerminationDate(Date terminationDate)` A timestamp indicating when this job terminated.
`String`	`toString()` Returns a string representation of this object.
`JobDescriptor`	`withConfirmationRequired(Boolean confirmationRequired)` Indicates whether confirmation is required before Amazon S3 begins running the specified job.
`JobDescriptor`	`withCreationTime(Date creationTime)` A timestamp indicating when this job was created.
`JobDescriptor`	`withDescription(String description)` The description for this job, if one was provided in this job's `Create Job` request.
`JobDescriptor`	`withFailureReasons(Collection<JobFailure> failureReasons)` If the specified job failed, this field contains information describing the failure.
`JobDescriptor`	`withFailureReasons(JobFailure... failureReasons)` If the specified job failed, this field contains information describing the failure.
`JobDescriptor`	`withJobArn(String jobArn)` The Amazon Resource Name (ARN) for this job.
`JobDescriptor`	`withJobId(String jobId)` The ID for the specified job.
`JobDescriptor`	`withManifest(JobManifest manifest)` The configuration information for the specified job's manifest object.
`JobDescriptor`	`withOperation(JobOperation operation)` The operation that the specified job is configured to execute on the objects listed in the manifest.
`JobDescriptor`	`withPriority(Integer priority)` The priority of the specified job.
`JobDescriptor`	`withProgressSummary(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.
`JobDescriptor`	`withReport(JobReport report)` Contains the configuration information for the job-completion report if you requested one in the `Create Job` request.
`JobDescriptor`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to execute the tasks for this job.
`JobDescriptor`	`withStatus(JobStatus status)` The current status of the specified job.
`JobDescriptor`	`withStatus(String status)` The current status of the specified job.
`JobDescriptor`	`withStatusUpdateReason(String statusUpdateReason)`
`JobDescriptor`	`withSuspendedCause(String suspendedCause)` The reason why the specified job was suspended.
`JobDescriptor`	`withSuspendedDate(Date suspendedDate)` The timestamp when this job was suspended, if it has been suspended.
`JobDescriptor`	`withTerminationDate(Date terminationDate)` A timestamp indicating when this job terminated.

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

- Constructor Detail
  - JobDescriptor
```
public JobDescriptor()
```
- Method Detail
  - setJobId
```
public void setJobId(String jobId)
```
    The ID for the specified job.
    
    Parameters:
    
    jobId - The ID for the specified job.
  - getJobId
```
public String getJobId()
```
    The ID for the specified job.
    
    Returns:
    
    The ID for the specified job.
  - withJobId
```
public JobDescriptor withJobId(String jobId)
```
    The ID for the specified job.
    
    Parameters:
    
    jobId - The ID for the specified job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfirmationRequired
```
public void setConfirmationRequired(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.
    
    Parameters:
    
    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.
  - getConfirmationRequired
```
public Boolean getConfirmationRequired()
```
    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.
  - withConfirmationRequired
```
public JobDescriptor withConfirmationRequired(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isConfirmationRequired
```
public Boolean isConfirmationRequired()
```
    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.
  - setDescription
```
public void setDescription(String description)
```
    The description for this job, if one was provided in this job's Create Job request.
    
    Parameters:
    
    description - The description for this job, if one was provided in this job's Create Job request.
  - getDescription
```
public String getDescription()
```
    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.
  - withDescription
```
public JobDescriptor withDescription(String description)
```
    The description for this job, if one was provided in this job's Create Job request.
    
    Parameters:
    
    description - The description for this job, if one was provided in this job's Create Job request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobArn
```
public void setJobArn(String jobArn)
```
    The Amazon Resource Name (ARN) for this job.
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) for this job.
  - getJobArn
```
public String getJobArn()
```
    The Amazon Resource Name (ARN) for this job.
    
    Returns:
    
    The Amazon Resource Name (ARN) for this job.
  - withJobArn
```
public JobDescriptor withJobArn(String jobArn)
```
    The Amazon Resource Name (ARN) for this job.
    
    Parameters:
    
    jobArn - The Amazon Resource Name (ARN) for this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the specified job.
    
    Parameters:
    
    status - The current status of the specified job.
    
    See Also:
    
    JobStatus
  - getStatus
```
public String getStatus()
```
    The current status of the specified job.
    
    Returns:
    
    The current status of the specified job.
    
    See Also:
    
    JobStatus
  - withStatus
```
public JobDescriptor withStatus(String status)
```
    The current status of the specified job.
    
    Parameters:
    
    status - The current status of the specified job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withStatus
```
public JobDescriptor withStatus(JobStatus status)
```
    The current status of the specified job.
    
    Parameters:
    
    status - The current status of the specified job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setManifest
```
public void setManifest(JobManifest manifest)
```
    The configuration information for the specified job's manifest object.
    
    Parameters:
    
    manifest - The configuration information for the specified job's manifest object.
  - getManifest
```
public JobManifest getManifest()
```
    The configuration information for the specified job's manifest object.
    
    Returns:
    
    The configuration information for the specified job's manifest object.
  - withManifest
```
public JobDescriptor withManifest(JobManifest manifest)
```
    The configuration information for the specified job's manifest object.
    
    Parameters:
    
    manifest - The configuration information for the specified job's manifest object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOperation
```
public void setOperation(JobOperation operation)
```
    The operation that the specified job is configured to execute on the objects listed in the manifest.
    
    Parameters:
    
    operation - The operation that the specified job is configured to execute on the objects listed in the manifest.
  - getOperation
```
public JobOperation getOperation()
```
    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.
  - withOperation
```
public JobDescriptor withOperation(JobOperation operation)
```
    The operation that the specified job is configured to execute on the objects listed in the manifest.
    
    Parameters:
    
    operation - The operation that the specified job is configured to execute on the objects listed in the manifest.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(Integer priority)
```
    The priority of the specified job.
    
    Parameters:
    
    priority - The priority of the specified job.
  - getPriority
```
public Integer getPriority()
```
    The priority of the specified job.
    
    Returns:
    
    The priority of the specified job.
  - withPriority
```
public JobDescriptor withPriority(Integer priority)
```
    The priority of the specified job.
    
    Parameters:
    
    priority - The priority of the specified job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProgressSummary
```
public void setProgressSummary(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.
    
    Parameters:
    
    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.
  - getProgressSummary
```
public JobProgressSummary getProgressSummary()
```
    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.
  - withProgressSummary
```
public JobDescriptor withProgressSummary(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusUpdateReason
```
public void setStatusUpdateReason(String statusUpdateReason)
```
    Parameters:
    
    statusUpdateReason -
  - getStatusUpdateReason
```
public String getStatusUpdateReason()
```
    Returns:
  - withStatusUpdateReason
```
public JobDescriptor withStatusUpdateReason(String statusUpdateReason)
```
    Parameters:
    
    statusUpdateReason -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFailureReasons
```
public List<JobFailure> getFailureReasons()
```
    If the specified job failed, this field contains information describing the failure.
    
    Returns:
    
    If the specified job failed, this field contains information describing the failure.
  - setFailureReasons
```
public void setFailureReasons(Collection<JobFailure> failureReasons)
```
    If the specified job failed, this field contains information describing the failure.
    
    Parameters:
    
    failureReasons - If the specified job failed, this field contains information describing the failure.
  - withFailureReasons
```
public JobDescriptor withFailureReasons(JobFailure... failureReasons)
```
    If the specified job failed, this field contains information describing the failure.
    
    NOTE: This method appends the values to the existing list (if any). Use setFailureReasons(java.util.Collection) or withFailureReasons(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    failureReasons - If the specified job failed, this field contains information describing the failure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFailureReasons
```
public JobDescriptor withFailureReasons(Collection<JobFailure> failureReasons)
```
    If the specified job failed, this field contains information describing the failure.
    
    Parameters:
    
    failureReasons - If the specified job failed, this field contains information describing the failure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReport
```
public void setReport(JobReport report)
```
    Contains the configuration information for the job-completion report if you requested one in the Create Job request.
    
    Parameters:
    
    report - Contains the configuration information for the job-completion report if you requested one in the Create Job request.
  - getReport
```
public JobReport getReport()
```
    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.
  - withReport
```
public JobDescriptor withReport(JobReport report)
```
    Contains the configuration information for the job-completion report if you requested one in the Create Job request.
    
    Parameters:
    
    report - Contains the configuration information for the job-completion report if you requested one in the Create Job request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    A timestamp indicating when this job was created.
    
    Parameters:
    
    creationTime - A timestamp indicating when this job was created.
  - getCreationTime
```
public Date getCreationTime()
```
    A timestamp indicating when this job was created.
    
    Returns:
    
    A timestamp indicating when this job was created.
  - withCreationTime
```
public JobDescriptor withCreationTime(Date creationTime)
```
    A timestamp indicating when this job was created.
    
    Parameters:
    
    creationTime - A timestamp indicating when this job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTerminationDate
```
public void setTerminationDate(Date 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.
    
    Parameters:
    
    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.
  - getTerminationDate
```
public Date getTerminationDate()
```
    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.
  - withTerminationDate
```
public JobDescriptor withTerminationDate(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to execute the tasks for this job.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to execute the tasks for this job.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to execute the tasks for this job.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to execute the tasks for this job.
  - withRoleArn
```
public JobDescriptor withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to execute the tasks for this job.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to execute the tasks for this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSuspendedDate
```
public void setSuspendedDate(Date suspendedDate)
```
    The timestamp when this job was suspended, if it has been suspended.
    
    Parameters:
    
    suspendedDate - The timestamp when this job was suspended, if it has been suspended.
  - getSuspendedDate
```
public Date getSuspendedDate()
```
    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.
  - withSuspendedDate
```
public JobDescriptor withSuspendedDate(Date suspendedDate)
```
    The timestamp when this job was suspended, if it has been suspended.
    
    Parameters:
    
    suspendedDate - The timestamp when this job was suspended, if it has been suspended.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSuspendedCause
```
public void setSuspendedCause(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.
    
    Parameters:
    
    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.
  - getSuspendedCause
```
public String getSuspendedCause()
```
    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.
  - withSuspendedCause
```
public JobDescriptor withSuspendedCause(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public JobDescriptor clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class JobDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobDescriptor

Method Detail

setJobId

getJobId

withJobId

setConfirmationRequired

getConfirmationRequired

withConfirmationRequired

isConfirmationRequired

setDescription

getDescription

withDescription

setJobArn

getJobArn

withJobArn

setStatus

getStatus

withStatus

withStatus

setManifest

getManifest

withManifest

setOperation

getOperation

withOperation

setPriority

getPriority

withPriority

setProgressSummary

getProgressSummary

withProgressSummary

setStatusUpdateReason

getStatusUpdateReason

withStatusUpdateReason

getFailureReasons

setFailureReasons

withFailureReasons

withFailureReasons

setReport

getReport

withReport

setCreationTime

getCreationTime

withCreationTime

setTerminationDate

getTerminationDate

withTerminationDate

setRoleArn

getRoleArn

withRoleArn

setSuspendedDate

getSuspendedDate

withSuspendedDate

setSuspendedCause

getSuspendedCause

withSuspendedCause

toString

equals

hashCode

clone