Interface CreateJobRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateJobRequest.Builder,
,CreateJobRequest> S3ControlRequest.Builder
,SdkBuilder<CreateJobRequest.Builder,
,CreateJobRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateJobRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Web Services account ID that creates the job.clientRequestToken
(String clientRequestToken) An idempotency token to ensure that you don't accidentally submit the same request twice.confirmationRequired
(Boolean confirmationRequired) Indicates whether confirmation is required before Amazon S3 runs the job.description
(String description) A description for this job.default CreateJobRequest.Builder
manifest
(Consumer<JobManifest.Builder> manifest) Configuration parameters for the manifest.manifest
(JobManifest manifest) Configuration parameters for the manifest.default CreateJobRequest.Builder
manifestGenerator
(Consumer<JobManifestGenerator.Builder> manifestGenerator) The attribute container for the ManifestGenerator details.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.operation
(JobOperation operation) The action that you want this job to perform on every object listed in the manifest.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The numerical priority for this job.default CreateJobRequest.Builder
report
(Consumer<JobReport.Builder> report) Configuration parameters for the optional job-completion report.Configuration parameters for the optional job-completion report.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.tags
(Collection<S3Tag> tags) A set of tags to associate with the S3 Batch Operations job.tags
(Consumer<S3Tag.Builder>... tags) A set of tags to associate with the S3 Batch Operations job.A set of tags to associate with the S3 Batch Operations job.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.s3control.model.S3ControlRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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 theJobOperation.Builder
avoiding the need to create one manually viaJobOperation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooperation(JobOperation)
.- Parameters:
operation
- a consumer that will call methods onJobOperation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Configuration parameters for the optional job-completion report.
This is a convenience method that creates an instance of theJobReport.Builder
avoiding the need to create one manually viaJobReport.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toreport(JobReport)
.- Parameters:
report
- a consumer that will call methods onJobReport.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
Configuration parameters for the manifest.
This is a convenience method that creates an instance of theJobManifest.Builder
avoiding the need to create one manually viaJobManifest.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomanifest(JobManifest)
.- Parameters:
manifest
- a consumer that will call methods onJobManifest.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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
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 theS3Tag.Builder
avoiding the need to create one manually viaS3Tag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<S3Tag>)
.- Parameters:
tags
- a consumer that will call methods onS3Tag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theJobManifestGenerator.Builder
avoiding the need to create one manually viaJobManifestGenerator.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomanifestGenerator(JobManifestGenerator)
.- Parameters:
manifestGenerator
- a consumer that will call methods onJobManifestGenerator.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-