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

Interface ModelInvocationJobSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ModelInvocationJobSummary.Builder,ModelInvocationJobSummary>, SdkBuilder<ModelInvocationJobSummary.Builder,ModelInvocationJobSummary>, SdkPojo

Enclosing class:

ModelInvocationJobSummary

public static interface ModelInvocationJobSummary.Builder
extends SdkPojo, CopyableBuilder<ModelInvocationJobSummary.Builder,ModelInvocationJobSummary>

Method Summary

Modifier and Type	Method	Description
ModelInvocationJobSummary.Builder	clientRequestToken(String clientRequestToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
ModelInvocationJobSummary.Builder	endTime(Instant endTime)	The time at which the batch inference job ended.
default ModelInvocationJobSummary.Builder	inputDataConfig(Consumer<ModelInvocationJobInputDataConfig.Builder> inputDataConfig)	Details about the location of the input to the batch inference job.
ModelInvocationJobSummary.Builder	inputDataConfig(ModelInvocationJobInputDataConfig inputDataConfig)	Details about the location of the input to the batch inference job.
ModelInvocationJobSummary.Builder	jobArn(String jobArn)	The Amazon Resource Name (ARN) of the batch inference job.
ModelInvocationJobSummary.Builder	jobExpirationTime(Instant jobExpirationTime)	The time at which the batch inference job times or timed out.
ModelInvocationJobSummary.Builder	jobName(String jobName)	The name of the batch inference job.
ModelInvocationJobSummary.Builder	lastModifiedTime(Instant lastModifiedTime)	The time at which the batch inference job was last modified.
ModelInvocationJobSummary.Builder	message(String message)	If the batch inference job failed, this field contains a message describing why the job failed.
ModelInvocationJobSummary.Builder	modelId(String modelId)	The unique identifier of the foundation model used for model inference.
default ModelInvocationJobSummary.Builder	outputDataConfig(Consumer<ModelInvocationJobOutputDataConfig.Builder> outputDataConfig)	Details about the location of the output of the batch inference job.
ModelInvocationJobSummary.Builder	outputDataConfig(ModelInvocationJobOutputDataConfig outputDataConfig)	Details about the location of the output of the batch inference job.
ModelInvocationJobSummary.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference.
ModelInvocationJobSummary.Builder	status(String status)	The status of the batch inference job.
ModelInvocationJobSummary.Builder	status(ModelInvocationJobStatus status)	The status of the batch inference job.
ModelInvocationJobSummary.Builder	submitTime(Instant submitTime)	The time at which the batch inference job was submitted.
ModelInvocationJobSummary.Builder	timeoutDurationInHours(Integer timeoutDurationInHours)	The number of hours after which the batch inference job was set to time out.

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

jobArn

ModelInvocationJobSummary.Builder jobArn(String jobArn)

The Amazon Resource Name (ARN) of the batch inference job.

Parameters:

jobArn - The Amazon Resource Name (ARN) of the batch inference job.

Returns:

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

jobName

ModelInvocationJobSummary.Builder jobName(String jobName)

The name of the batch inference job.

Parameters:

jobName - The name of the batch inference job.

Returns:

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

modelId

ModelInvocationJobSummary.Builder modelId(String modelId)

The unique identifier of the foundation model used for model inference.

Parameters:

modelId - The unique identifier of the foundation model used for model inference.

Returns:

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

clientRequestToken

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

roleArn

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

status

ModelInvocationJobSummary.Builder status(String status)

The status of the batch inference job.

Parameters:

status - The status of the batch inference job.

Returns:

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

See Also:

• ModelInvocationJobStatus
• ModelInvocationJobStatus

status

ModelInvocationJobSummary.Builder status(ModelInvocationJobStatus status)

The status of the batch inference job.

Parameters:

status - The status of the batch inference job.

Returns:

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

See Also:

• ModelInvocationJobStatus
• ModelInvocationJobStatus

message

ModelInvocationJobSummary.Builder message(String message)

If the batch inference job failed, this field contains a message describing why the job failed.

Parameters:

message - If the batch inference job failed, this field contains a message describing why the job failed.

Returns:

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

submitTime

ModelInvocationJobSummary.Builder submitTime(Instant submitTime)

The time at which the batch inference job was submitted.

Parameters:

submitTime - The time at which the batch inference job was submitted.

Returns:

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

lastModifiedTime

ModelInvocationJobSummary.Builder lastModifiedTime(Instant lastModifiedTime)

The time at which the batch inference job was last modified.

Parameters:

lastModifiedTime - The time at which the batch inference job was last modified.

Returns:

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

endTime

ModelInvocationJobSummary.Builder endTime(Instant endTime)

The time at which the batch inference job ended.

Parameters:

endTime - The time at which the batch inference job ended.

Returns:

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

inputDataConfig

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

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

ModelInvocationJobSummary.Builder timeoutDurationInHours(Integer timeoutDurationInHours)

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

Parameters:

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

Returns:

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

jobExpirationTime

ModelInvocationJobSummary.Builder jobExpirationTime(Instant jobExpirationTime)

The time at which the batch inference job times or timed out.

Parameters:

jobExpirationTime - The time at which the batch inference job times or timed out.

Returns:

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