Interface StartRunBatchRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartRunBatchRequest.Builder,StartRunBatchRequest>, OmicsRequest.Builder, SdkBuilder<StartRunBatchRequest.Builder,StartRunBatchRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartRunBatchRequest

@Mutable
@NotThreadSafe
public static interface StartRunBatchRequest.Builder
extends OmicsRequest.Builder, SdkPojo, CopyableBuilder<StartRunBatchRequest.Builder,StartRunBatchRequest>

Method Summary

Modifier and Type	Method	Description
StartRunBatchRequest.Builder	batchName(String batchName)	An optional user-friendly name for the run batch.
default StartRunBatchRequest.Builder	batchRunSettings(Consumer<BatchRunSettings.Builder> batchRunSettings)	The individual run configurations.
StartRunBatchRequest.Builder	batchRunSettings(BatchRunSettings batchRunSettings)	The individual run configurations.
default StartRunBatchRequest.Builder	defaultRunSetting(Consumer<DefaultRunSetting.Builder> defaultRunSetting)	Shared configuration applied to all runs in the batch.
StartRunBatchRequest.Builder	defaultRunSetting(DefaultRunSetting defaultRunSetting)	Shared configuration applied to all runs in the batch.
StartRunBatchRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartRunBatchRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
StartRunBatchRequest.Builder	requestId(String requestId)	A client token used to deduplicate retry requests and prevent duplicate batches from being created.
StartRunBatchRequest.Builder	tags(Map<String,String> tags)	AWS tags to associate with the batch resource.

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.omics.model.OmicsRequest.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

batchName

StartRunBatchRequest.Builder batchName(String batchName)

An optional user-friendly name for the run batch.

Parameters:

batchName - An optional user-friendly name for the run batch.

Returns:

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

requestId

StartRunBatchRequest.Builder requestId(String requestId)

A client token used to deduplicate retry requests and prevent duplicate batches from being created.

Parameters:

requestId - A client token used to deduplicate retry requests and prevent duplicate batches from being created.

Returns:

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

tags

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

AWS tags to associate with the batch resource. These tags are not inherited by individual runs. To tag individual runs, use defaultRunSetting.runTags.

Parameters:

tags - AWS tags to associate with the batch resource. These tags are not inherited by individual runs. To tag individual runs, use defaultRunSetting.runTags.

Returns:

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

defaultRunSetting

StartRunBatchRequest.Builder defaultRunSetting(DefaultRunSetting defaultRunSetting)

Shared configuration applied to all runs in the batch. See DefaultRunSetting.

Parameters:

defaultRunSetting - Shared configuration applied to all runs in the batch. See DefaultRunSetting.

Returns:

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

defaultRunSetting

default StartRunBatchRequest.Builder defaultRunSetting(Consumer<DefaultRunSetting.Builder> defaultRunSetting)

Shared configuration applied to all runs in the batch. See DefaultRunSetting.

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

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

Parameters:

defaultRunSetting - a consumer that will call methods on DefaultRunSetting.Builder

Returns:

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

See Also:

• defaultRunSetting(DefaultRunSetting)

batchRunSettings

StartRunBatchRequest.Builder batchRunSettings(BatchRunSettings batchRunSettings)

The individual run configurations. Specify exactly one of inlineSettings or s3UriSettings. See BatchRunSettings.

Parameters:

batchRunSettings - The individual run configurations. Specify exactly one of inlineSettings or s3UriSettings. See BatchRunSettings.

Returns:

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

batchRunSettings

default StartRunBatchRequest.Builder batchRunSettings(Consumer<BatchRunSettings.Builder> batchRunSettings)

The individual run configurations. Specify exactly one of inlineSettings or s3UriSettings. See BatchRunSettings.

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

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

Parameters:

batchRunSettings - a consumer that will call methods on BatchRunSettings.Builder

Returns:

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

See Also:

• batchRunSettings(BatchRunSettings)

overrideConfiguration

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

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