Package software.amazon.awssdk.services.s3control.model

Interface JobListDescriptor.Builder

All Superinterfaces:

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

Enclosing class:

JobListDescriptor

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

Method Summary

Modifier and Type	Method	Description
JobListDescriptor.Builder	creationTime(Instant creationTime)	A timestamp indicating when the specified job was created.
JobListDescriptor.Builder	description(String description)	The user-specified description that was included in the specified job's Create Job request.
JobListDescriptor.Builder	jobId(String jobId)	The ID for the specified job.
JobListDescriptor.Builder	operation(String operation)	The operation that the specified job is configured to run on every object listed in the manifest.
JobListDescriptor.Builder	operation(OperationName operation)	The operation that the specified job is configured to run on every object listed in the manifest.
JobListDescriptor.Builder	priority(Integer priority)	The current priority for the specified job.
default JobListDescriptor.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.
JobListDescriptor.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.
JobListDescriptor.Builder	status(String status)	The specified job's current status.
JobListDescriptor.Builder	status(JobStatus status)	The specified job's current status.
JobListDescriptor.Builder	terminationDate(Instant terminationDate)	A timestamp indicating when the specified job terminated.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

jobId

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

description

JobListDescriptor.Builder description(String description)

The user-specified description that was included in the specified job's Create Job request.

Parameters:

description - The user-specified description that was included in the specified job's Create Job request.

Returns:

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

operation

JobListDescriptor.Builder operation(String operation)

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

Parameters:

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

Returns:

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

See Also:

OperationName, OperationName

operation

JobListDescriptor.Builder operation(OperationName operation)

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

Parameters:

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

Returns:

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

See Also:

OperationName, OperationName

priority

JobListDescriptor.Builder priority(Integer priority)

The current priority for the specified job.

Parameters:

priority - The current priority for the specified job.

Returns:

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

status

JobListDescriptor.Builder status(String status)

The specified job's current status.

Parameters:

status - The specified job's current status.

Returns:

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

See Also:

JobStatus, JobStatus

status

JobListDescriptor.Builder status(JobStatus status)

The specified job's current status.

Parameters:

status - The specified job's current status.

Returns:

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

See Also:

JobStatus, JobStatus

creationTime

JobListDescriptor.Builder creationTime(Instant creationTime)

A timestamp indicating when the specified job was created.

Parameters:

creationTime - A timestamp indicating when the specified job was created.

Returns:

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

terminationDate

JobListDescriptor.Builder terminationDate(Instant terminationDate)

A timestamp indicating when the specified 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 the specified 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.

progressSummary

JobListDescriptor.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 JobListDescriptor.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 method 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)