Interface CreateJobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>, S3ControlRequest.Builder, SdkBuilder<CreateJobRequest.Builder,CreateJobRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateJobRequest
@Mutable @NotThreadSafe public static interface CreateJobRequest.Builder extends S3ControlRequest.Builder, SdkPojo, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

  • Method Details

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

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

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

    • 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 S3Tag.Builder avoiding the need to create one manually via S3Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<S3Tag>).

      Parameters:
      tags - a consumer that will call methods on S3Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • overrideConfiguration

      CreateJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.