software.amazon.awssdk.services.s3control.model

Interface JobDescriptor.Builder

All Superinterfaces:

Buildable, CopyableBuilder<JobDescriptor.Builder,JobDescriptor>, SdkBuilder<JobDescriptor.Builder,JobDescriptor>, SdkPojo

Enclosing class:

JobDescriptor

public static interface JobDescriptor.Builder
extends SdkPojo, CopyableBuilder<JobDescriptor.Builder,JobDescriptor>

Method Summary

Modifier and Type	Method and Description
JobDescriptor.Builder	confirmationRequired(Boolean confirmationRequired) Indicates whether confirmation is required before Amazon S3 begins running the specified job.
JobDescriptor.Builder	creationTime(Instant creationTime) A timestamp indicating when this job was created.
JobDescriptor.Builder	description(String description) The description for this job, if one was provided in this job's Create Job request.
JobDescriptor.Builder	failureReasons(Collection<JobFailure> failureReasons) If the specified job failed, this field contains information describing the failure.
JobDescriptor.Builder	failureReasons(Consumer<JobFailure.Builder>... failureReasons) If the specified job failed, this field contains information describing the failure.
JobDescriptor.Builder	failureReasons(JobFailure... failureReasons) If the specified job failed, this field contains information describing the failure.
JobDescriptor.Builder	jobArn(String jobArn) The Amazon Resource Name (ARN) for this job.
JobDescriptor.Builder	jobId(String jobId) The ID for the specified job.
default JobDescriptor.Builder	manifest(Consumer<JobManifest.Builder> manifest) The configuration information for the specified job's manifest object.
JobDescriptor.Builder	manifest(JobManifest manifest) The configuration information for the specified job's manifest object.
default JobDescriptor.Builder	operation(Consumer<JobOperation.Builder> operation) The operation that the specified job is configured to run on the objects listed in the manifest.
JobDescriptor.Builder	operation(JobOperation operation) The operation that the specified job is configured to run on the objects listed in the manifest.
JobDescriptor.Builder	priority(Integer priority) The priority of the specified job.
default JobDescriptor.Builder	progressSummary(Consumer<JobProgressSummary.Builder> 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.
JobDescriptor.Builder	progressSummary(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.
default JobDescriptor.Builder	report(Consumer<JobReport.Builder> report) Contains the configuration information for the job-completion report if you requested one in the Create Job request.
JobDescriptor.Builder	report(JobReport report) Contains the configuration information for the job-completion report if you requested one in the Create Job request.
JobDescriptor.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.
JobDescriptor.Builder	status(JobStatus status) The current status of the specified job.
JobDescriptor.Builder	status(String status) The current status of the specified job.
JobDescriptor.Builder	statusUpdateReason(String statusUpdateReason) The reason for updating the job.
JobDescriptor.Builder	suspendedCause(String suspendedCause) The reason why the specified job was suspended.
JobDescriptor.Builder	suspendedDate(Instant suspendedDate) The timestamp when this job was suspended, if it has been suspended.
JobDescriptor.Builder	terminationDate(Instant terminationDate) A timestamp indicating when this job terminated.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

jobId

JobDescriptor.Builder jobId(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.

confirmationRequired

JobDescriptor.Builder confirmationRequired(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.

description

JobDescriptor.Builder description(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.

jobArn

JobDescriptor.Builder jobArn(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.

status

JobDescriptor.Builder status(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, JobStatus

status

JobDescriptor.Builder status(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, JobStatus

manifest

JobDescriptor.Builder manifest(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.

manifest

default JobDescriptor.Builder manifest(Consumer<JobManifest.Builder> manifest)

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

This is a convenience that creates an instance of the JobManifest.Builder avoiding the need to create one manually via JobManifest.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to manifest(JobManifest).

Parameters:

manifest - a consumer that will call methods on JobManifest.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

manifest(JobManifest)

operation

JobDescriptor.Builder operation(JobOperation operation)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

operation

default JobDescriptor.Builder operation(Consumer<JobOperation.Builder> operation)

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

This is a convenience that creates an instance of the JobOperation.Builder avoiding the need to create one manually via JobOperation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to operation(JobOperation).

Parameters:

operation - a consumer that will call methods on JobOperation.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

operation(JobOperation)

priority

JobDescriptor.Builder priority(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.

progressSummary

JobDescriptor.Builder progressSummary(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

progressSummary

default JobDescriptor.Builder progressSummary(Consumer<JobProgressSummary.Builder> 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.

This is a convenience that creates an instance of the JobProgressSummary.Builder avoiding the need to create one manually via JobProgressSummary.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to progressSummary(JobProgressSummary).

Parameters:

progressSummary - a consumer that will call methods on JobProgressSummary.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

progressSummary(JobProgressSummary)

statusUpdateReason

JobDescriptor.Builder statusUpdateReason(String statusUpdateReason)

The reason for updating the job.

Parameters:

statusUpdateReason - The reason for updating the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

failureReasons

JobDescriptor.Builder failureReasons(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.

failureReasons

JobDescriptor.Builder failureReasons(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.

failureReasons

JobDescriptor.Builder failureReasons(Consumer<JobFailure.Builder>... failureReasons)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #failureReasons(List).

Parameters:

failureReasons - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#failureReasons(List)

report

JobDescriptor.Builder report(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.

report

default JobDescriptor.Builder report(Consumer<JobReport.Builder> report)

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

This is a convenience that creates an instance of the JobReport.Builder avoiding the need to create one manually via JobReport.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to report(JobReport).

Parameters:

report - a consumer that will call methods on JobReport.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

report(JobReport)

creationTime

JobDescriptor.Builder creationTime(Instant 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.

terminationDate

JobDescriptor.Builder terminationDate(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.

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.

roleArn

JobDescriptor.Builder roleArn(String roleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

suspendedDate

JobDescriptor.Builder suspendedDate(Instant 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.

suspendedCause

JobDescriptor.Builder suspendedCause(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.