software.amazon.awssdk.services.s3control.model

Interface CreateJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>, S3ControlRequest.Builder, SdkBuilder<CreateJobRequest.Builder,CreateJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateJobRequest

public static interface CreateJobRequest.Builder
extends S3ControlRequest.Builder, SdkPojo, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

Method Summary

Modifier and Type	Method and Description
CreateJobRequest.Builder	accountId(String accountId) The Amazon Web Services account ID that creates the job.
CreateJobRequest.Builder	clientRequestToken(String clientRequestToken) An idempotency token to ensure that you don't accidentally submit the same request twice.
CreateJobRequest.Builder	confirmationRequired(Boolean confirmationRequired) Indicates whether confirmation is required before Amazon S3 runs the job.
CreateJobRequest.Builder	description(String description) A description for this job.
default CreateJobRequest.Builder	manifest(Consumer<JobManifest.Builder> manifest) Configuration parameters for the manifest.
CreateJobRequest.Builder	manifest(JobManifest manifest) Configuration parameters for the manifest.
default CreateJobRequest.Builder	manifestGenerator(Consumer<JobManifestGenerator.Builder> manifestGenerator) The attribute container for the ManifestGenerator details.
CreateJobRequest.Builder	manifestGenerator(JobManifestGenerator manifestGenerator) The attribute container for the ManifestGenerator details.
default CreateJobRequest.Builder	operation(Consumer<JobOperation.Builder> operation) The action that you want this job to perform on every object listed in the manifest.
CreateJobRequest.Builder	operation(JobOperation operation) The action that you want this job to perform on every object listed in the manifest.
CreateJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateJobRequest.Builder	priority(Integer priority) The numerical priority for this job.
default CreateJobRequest.Builder	report(Consumer<JobReport.Builder> report) Configuration parameters for the optional job-completion report.
CreateJobRequest.Builder	report(JobReport report) Configuration parameters for the optional job-completion report.
CreateJobRequest.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.
CreateJobRequest.Builder	tags(Collection<S3Tag> tags) A set of tags to associate with the S3 Batch Operations job.
CreateJobRequest.Builder	tags(Consumer<S3Tag.Builder>... tags) A set of tags to associate with the S3 Batch Operations job.
CreateJobRequest.Builder	tags(S3Tag... tags) A set of tags to associate with the S3 Batch Operations job.

Methods inherited from interface software.amazon.awssdk.services.s3control.model.S3ControlRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

accountId

CreateJobRequest.Builder accountId(String accountId)

The Amazon Web Services account ID that creates the job.

Parameters:

accountId - The Amazon Web Services account ID that creates the job.

Returns:

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

confirmationRequired

CreateJobRequest.Builder confirmationRequired(Boolean confirmationRequired)

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

Parameters:

confirmationRequired - Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

Returns:

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

operation

CreateJobRequest.Builder operation(JobOperation operation)

The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

Parameters:

operation - The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

Returns:

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

operation

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

The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

This is a convenience method 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)

report

CreateJobRequest.Builder report(JobReport report)

Configuration parameters for the optional job-completion report.

Parameters:

report - Configuration parameters for the optional job-completion report.

Returns:

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

report

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

Configuration parameters for the optional job-completion report.

This is a convenience method 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)

clientRequestToken

CreateJobRequest.Builder clientRequestToken(String clientRequestToken)

An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

Parameters:

clientRequestToken - An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

Returns:

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

manifest

CreateJobRequest.Builder manifest(JobManifest manifest)

Configuration parameters for the manifest.

Parameters:

manifest - Configuration parameters for the manifest.

Returns:

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

manifest

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

Configuration parameters for the manifest.

This is a convenience method 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)

description

CreateJobRequest.Builder description(String description)

A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

Parameters:

description - A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

Returns:

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

priority

CreateJobRequest.Builder priority(Integer priority)

The numerical priority for this job. Higher numbers indicate higher priority.

Parameters:

priority - The numerical priority for this job. Higher numbers indicate higher priority.

Returns:

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

roleArn

CreateJobRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

Parameters:

roleArn - The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

Returns:

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

tags

CreateJobRequest.Builder tags(Collection<S3Tag> tags)

A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

Parameters:

tags - A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

Returns:

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

tags

CreateJobRequest.Builder tags(S3Tag... tags)

A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

Parameters:

tags - A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

Returns:

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

tags

CreateJobRequest.Builder tags(Consumer<S3Tag.Builder>... tags)

A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

This is a convenience method 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 #tags(List).

Parameters:

tags - 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:

#tags(List)

manifestGenerator

CreateJobRequest.Builder manifestGenerator(JobManifestGenerator manifestGenerator)

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

Parameters:

manifestGenerator - The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

Returns:

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

manifestGenerator

default CreateJobRequest.Builder manifestGenerator(Consumer<JobManifestGenerator.Builder> manifestGenerator)

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

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

Parameters:

manifestGenerator - a consumer that will call methods on JobManifestGenerator.Builder

Returns:

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

See Also:

manifestGenerator(JobManifestGenerator)

overrideConfiguration

CreateJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder