Package software.amazon.awssdk.services.bedrock.model

Interface CreateModelInvocationJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockRequest.Builder, Buildable, CopyableBuilder<CreateModelInvocationJobRequest.Builder,CreateModelInvocationJobRequest>, SdkBuilder<CreateModelInvocationJobRequest.Builder,CreateModelInvocationJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateModelInvocationJobRequest

public static interface CreateModelInvocationJobRequest.Builder
extends BedrockRequest.Builder, SdkPojo, CopyableBuilder<CreateModelInvocationJobRequest.Builder,CreateModelInvocationJobRequest>

Method Summary

Modifier and Type	Method	Description
CreateModelInvocationJobRequest.Builder	clientRequestToken(String clientRequestToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
default CreateModelInvocationJobRequest.Builder	inputDataConfig(Consumer<ModelInvocationJobInputDataConfig.Builder> inputDataConfig)	Details about the location of the input to the batch inference job.
CreateModelInvocationJobRequest.Builder	inputDataConfig(ModelInvocationJobInputDataConfig inputDataConfig)	Details about the location of the input to the batch inference job.
CreateModelInvocationJobRequest.Builder	jobName(String jobName)	A name to give the batch inference job.
CreateModelInvocationJobRequest.Builder	modelId(String modelId)	The unique identifier of the foundation model to use for the batch inference job.
default CreateModelInvocationJobRequest.Builder	outputDataConfig(Consumer<ModelInvocationJobOutputDataConfig.Builder> outputDataConfig)	Details about the location of the output of the batch inference job.
CreateModelInvocationJobRequest.Builder	outputDataConfig(ModelInvocationJobOutputDataConfig outputDataConfig)	Details about the location of the output of the batch inference job.
CreateModelInvocationJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateModelInvocationJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateModelInvocationJobRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference.
CreateModelInvocationJobRequest.Builder	tags(Collection<Tag> tags)	Any tags to associate with the batch inference job.
CreateModelInvocationJobRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Any tags to associate with the batch inference job.
CreateModelInvocationJobRequest.Builder	tags(Tag... tags)	Any tags to associate with the batch inference job.
CreateModelInvocationJobRequest.Builder	timeoutDurationInHours(Integer timeoutDurationInHours)	The number of hours after which to force the batch inference job to time out.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrock.model.BedrockRequest.Builder

build

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

copy

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

jobName

CreateModelInvocationJobRequest.Builder jobName(String jobName)

A name to give the batch inference job.

Parameters:

jobName - A name to give the batch inference job.

Returns:

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

roleArn

CreateModelInvocationJobRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

Returns:

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

clientRequestToken

CreateModelInvocationJobRequest.Builder clientRequestToken(String clientRequestToken)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Parameters:

clientRequestToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Returns:

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

modelId

CreateModelInvocationJobRequest.Builder modelId(String modelId)

The unique identifier of the foundation model to use for the batch inference job.

Parameters:

modelId - The unique identifier of the foundation model to use for the batch inference job.

Returns:

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

inputDataConfig

CreateModelInvocationJobRequest.Builder inputDataConfig(ModelInvocationJobInputDataConfig inputDataConfig)

Details about the location of the input to the batch inference job.

Parameters:

inputDataConfig - Details about the location of the input to the batch inference job.

Returns:

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

inputDataConfig

default CreateModelInvocationJobRequest.Builder inputDataConfig(Consumer<ModelInvocationJobInputDataConfig.Builder> inputDataConfig)

Details about the location of the input to the batch inference job.

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

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

Parameters:

inputDataConfig - a consumer that will call methods on ModelInvocationJobInputDataConfig.Builder

Returns:

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

See Also:

• inputDataConfig(ModelInvocationJobInputDataConfig)

outputDataConfig

CreateModelInvocationJobRequest.Builder outputDataConfig(ModelInvocationJobOutputDataConfig outputDataConfig)

Details about the location of the output of the batch inference job.

Parameters:

outputDataConfig - Details about the location of the output of the batch inference job.

Returns:

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

outputDataConfig

default CreateModelInvocationJobRequest.Builder outputDataConfig(Consumer<ModelInvocationJobOutputDataConfig.Builder> outputDataConfig)

Details about the location of the output of the batch inference job.

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

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

Parameters:

outputDataConfig - a consumer that will call methods on ModelInvocationJobOutputDataConfig.Builder

Returns:

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

See Also:

• outputDataConfig(ModelInvocationJobOutputDataConfig)

timeoutDurationInHours

CreateModelInvocationJobRequest.Builder timeoutDurationInHours(Integer timeoutDurationInHours)

The number of hours after which to force the batch inference job to time out.

Parameters:

timeoutDurationInHours - The number of hours after which to force the batch inference job to time out.

Returns:

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

tags

CreateModelInvocationJobRequest.Builder tags(Collection<Tag> tags)

Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

Parameters:

tags - Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

Returns:

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

tags

CreateModelInvocationJobRequest.Builder tags(Tag... tags)

Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

Parameters:

tags - Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

Returns:

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

tags

CreateModelInvocationJobRequest.Builder tags(Consumer<Tag.Builder>... tags)

Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

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

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

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

overrideConfiguration

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

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