Interface PutInvocationStepRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentRuntimeRequest.Builder, Buildable, CopyableBuilder<PutInvocationStepRequest.Builder,PutInvocationStepRequest>, SdkBuilder<PutInvocationStepRequest.Builder,PutInvocationStepRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutInvocationStepRequest

@Mutable
@NotThreadSafe
public static interface PutInvocationStepRequest.Builder
extends BedrockAgentRuntimeRequest.Builder, SdkPojo, CopyableBuilder<PutInvocationStepRequest.Builder,PutInvocationStepRequest>

Method Summary

Modifier and Type	Method	Description
PutInvocationStepRequest.Builder	invocationIdentifier(String invocationIdentifier)	The unique identifier (in UUID format) of the invocation to add the invocation step to.
PutInvocationStepRequest.Builder	invocationStepId(String invocationStepId)	The unique identifier of the invocation step in UUID format.
PutInvocationStepRequest.Builder	invocationStepTime(Instant invocationStepTime)	The timestamp for when the invocation step occurred.
PutInvocationStepRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
PutInvocationStepRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default PutInvocationStepRequest.Builder	payload(Consumer<InvocationStepPayload.Builder> payload)	The payload for the invocation step, including text and images for the interaction.
PutInvocationStepRequest.Builder	payload(InvocationStepPayload payload)	The payload for the invocation step, including text and images for the interaction.
PutInvocationStepRequest.Builder	sessionIdentifier(String sessionIdentifier)	The unique identifier for the session to add the invocation step to.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest.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, sdkFieldNameToField, sdkFields

Method Details

sessionIdentifier

PutInvocationStepRequest.Builder sessionIdentifier(String sessionIdentifier)

The unique identifier for the session to add the invocation step to. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

Parameters:

sessionIdentifier - The unique identifier for the session to add the invocation step to. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

Returns:

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

invocationIdentifier

PutInvocationStepRequest.Builder invocationIdentifier(String invocationIdentifier)

The unique identifier (in UUID format) of the invocation to add the invocation step to.

Parameters:

invocationIdentifier - The unique identifier (in UUID format) of the invocation to add the invocation step to.

Returns:

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

invocationStepTime

PutInvocationStepRequest.Builder invocationStepTime(Instant invocationStepTime)

The timestamp for when the invocation step occurred.

Parameters:

invocationStepTime - The timestamp for when the invocation step occurred.

Returns:

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

payload

PutInvocationStepRequest.Builder payload(InvocationStepPayload payload)

The payload for the invocation step, including text and images for the interaction.

Parameters:

payload - The payload for the invocation step, including text and images for the interaction.

Returns:

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

payload

default PutInvocationStepRequest.Builder payload(Consumer<InvocationStepPayload.Builder> payload)

The payload for the invocation step, including text and images for the interaction.

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

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

Parameters:

payload - a consumer that will call methods on InvocationStepPayload.Builder

Returns:

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

See Also:

• payload(InvocationStepPayload)

invocationStepId

PutInvocationStepRequest.Builder invocationStepId(String invocationStepId)

The unique identifier of the invocation step in UUID format.

Parameters:

invocationStepId - The unique identifier of the invocation step in UUID format.

Returns:

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

overrideConfiguration

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

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