Interface StartBatchJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartBatchJobRequest.Builder,StartBatchJobRequest>, M2Request.Builder, SdkBuilder<StartBatchJobRequest.Builder,StartBatchJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartBatchJobRequest

@Mutable
@NotThreadSafe
public static interface StartBatchJobRequest.Builder
extends M2Request.Builder, SdkPojo, CopyableBuilder<StartBatchJobRequest.Builder,StartBatchJobRequest>

Method Summary

Modifier and Type	Method	Description
StartBatchJobRequest.Builder	applicationId(String applicationId)	The unique identifier of the application associated with this batch job.
StartBatchJobRequest.Builder	authSecretsManagerArn(String authSecretsManagerArn)	The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation.
default StartBatchJobRequest.Builder	batchJobIdentifier(Consumer<BatchJobIdentifier.Builder> batchJobIdentifier)	The unique identifier of the batch job.
StartBatchJobRequest.Builder	batchJobIdentifier(BatchJobIdentifier batchJobIdentifier)	The unique identifier of the batch job.
StartBatchJobRequest.Builder	jobParams(Map<String,String> jobParams)	The collection of batch job parameters.
StartBatchJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartBatchJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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.m2.model.M2Request.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

applicationId

StartBatchJobRequest.Builder applicationId(String applicationId)

The unique identifier of the application associated with this batch job.

Parameters:

applicationId - The unique identifier of the application associated with this batch job.

Returns:

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

authSecretsManagerArn

StartBatchJobRequest.Builder authSecretsManagerArn(String authSecretsManagerArn)

The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation.

Parameters:

authSecretsManagerArn - The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation.

Returns:

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

batchJobIdentifier

StartBatchJobRequest.Builder batchJobIdentifier(BatchJobIdentifier batchJobIdentifier)

The unique identifier of the batch job.

Parameters:

batchJobIdentifier - The unique identifier of the batch job.

Returns:

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

batchJobIdentifier

default StartBatchJobRequest.Builder batchJobIdentifier(Consumer<BatchJobIdentifier.Builder> batchJobIdentifier)

The unique identifier of the batch job.

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

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

Parameters:

batchJobIdentifier - a consumer that will call methods on BatchJobIdentifier.Builder

Returns:

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

See Also:

• batchJobIdentifier(BatchJobIdentifier)

jobParams

StartBatchJobRequest.Builder jobParams(Map<String,String> jobParams)

The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.

Parameters:

jobParams - The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.

Returns:

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

overrideConfiguration

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

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