Interface StartJobRequest.Builder

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

  • Method Details

    • clientToken

      StartJobRequest.Builder clientToken(String clientToken)

      A unique identifier for this request to ensure idempotency.

      Parameters:
      clientToken - A unique identifier for this request to ensure idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • action

      StartJobRequest.Builder action(String action)

      The action to perform on the input data.

      Parameters:
      action - The action to perform on the input data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • action

      StartJobRequest.Builder action(JobAction action)

      The action to perform on the input data.

      Parameters:
      action - The action to perform on the input data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • actionOptions

      StartJobRequest.Builder actionOptions(JobActionOptions actionOptions)

      Additional parameters that can be requested for each result.

      Parameters:
      actionOptions - Additional parameters that can be requested for each result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionOptions

      default StartJobRequest.Builder actionOptions(Consumer<JobActionOptions.Builder> actionOptions)

      Additional parameters that can be requested for each result.

      This is a convenience method that creates an instance of the JobActionOptions.Builder avoiding the need to create one manually via JobActionOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to actionOptions(JobActionOptions).

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

    • executionRoleArn

      StartJobRequest.Builder executionRoleArn(String executionRoleArn)

      The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.

      The IAM role must be created in the same Amazon Web Services account where you plan to run your job.

      For more information about configuring IAM roles for Amazon Location jobs, see Configure IAM permissions in the Amazon Location Service Developer Guide.

      Parameters:
      executionRoleArn - The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.

      The IAM role must be created in the same Amazon Web Services account where you plan to run your job.

      For more information about configuring IAM roles for Amazon Location jobs, see Configure IAM permissions in the Amazon Location Service Developer Guide.

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

    • inputOptions

      StartJobRequest.Builder inputOptions(JobInputOptions inputOptions)

      Configuration for input data location and format.

      Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.

      Parameters:
      inputOptions - Configuration for input data location and format.

      Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.

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

    • inputOptions

      default StartJobRequest.Builder inputOptions(Consumer<JobInputOptions.Builder> inputOptions)

      Configuration for input data location and format.

      Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.

      This is a convenience method that creates an instance of the JobInputOptions.Builder avoiding the need to create one manually via JobInputOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputOptions(JobInputOptions).

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

    • name

      StartJobRequest.Builder name(String name)

      An optional name for the job resource.

      Parameters:
      name - An optional name for the job resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputOptions

      StartJobRequest.Builder outputOptions(JobOutputOptions outputOptions)

      Configuration for output data location and format.

      Parameters:
      outputOptions - Configuration for output data location and format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputOptions

      default StartJobRequest.Builder outputOptions(Consumer<JobOutputOptions.Builder> outputOptions)

      Configuration for output data location and format.

      This is a convenience method that creates an instance of the JobOutputOptions.Builder avoiding the need to create one manually via JobOutputOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputOptions(JobOutputOptions).

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

    • tags

      StartJobRequest.Builder tags(Map<String,String> tags)

      Tags and corresponding values to be associated with the job.

      Parameters:
      tags - Tags and corresponding values to be associated with the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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