Interface ConverseStreamMetadataEvent.Builder

All Superinterfaces:

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

All Known Subinterfaces:

DefaultMetadata.Builder

Enclosing class:

ConverseStreamMetadataEvent

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

Method Summary

Modifier and Type	Method	Description
default ConverseStreamMetadataEvent.Builder	metrics(Consumer<ConverseStreamMetrics.Builder> metrics)	The metrics for the conversation stream metadata event.
ConverseStreamMetadataEvent.Builder	metrics(ConverseStreamMetrics metrics)	The metrics for the conversation stream metadata event.
default ConverseStreamMetadataEvent.Builder	performanceConfig(Consumer<PerformanceConfiguration.Builder> performanceConfig)	Model performance configuration metadata for the conversation stream event.
ConverseStreamMetadataEvent.Builder	performanceConfig(PerformanceConfiguration performanceConfig)	Model performance configuration metadata for the conversation stream event.
default ConverseStreamMetadataEvent.Builder	trace(Consumer<ConverseStreamTrace.Builder> trace)	The trace object in the response from ConverseStream that contains information about the guardrail behavior.
ConverseStreamMetadataEvent.Builder	trace(ConverseStreamTrace trace)	The trace object in the response from ConverseStream that contains information about the guardrail behavior.
default ConverseStreamMetadataEvent.Builder	usage(Consumer<TokenUsage.Builder> usage)	Usage information for the conversation stream event.
ConverseStreamMetadataEvent.Builder	usage(TokenUsage usage)	Usage information for the conversation stream event.

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

usage

ConverseStreamMetadataEvent.Builder usage(TokenUsage usage)

Usage information for the conversation stream event.

Parameters:

usage - Usage information for the conversation stream event.

Returns:

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

usage

default ConverseStreamMetadataEvent.Builder usage(Consumer<TokenUsage.Builder> usage)

Usage information for the conversation stream event.

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

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

Parameters:

usage - a consumer that will call methods on TokenUsage.Builder

Returns:

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

See Also:

• usage(TokenUsage)

metrics

ConverseStreamMetadataEvent.Builder metrics(ConverseStreamMetrics metrics)

The metrics for the conversation stream metadata event.

Parameters:

metrics - The metrics for the conversation stream metadata event.

Returns:

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

metrics

default ConverseStreamMetadataEvent.Builder metrics(Consumer<ConverseStreamMetrics.Builder> metrics)

The metrics for the conversation stream metadata event.

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

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

Parameters:

metrics - a consumer that will call methods on ConverseStreamMetrics.Builder

Returns:

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

See Also:

• metrics(ConverseStreamMetrics)

trace

ConverseStreamMetadataEvent.Builder trace(ConverseStreamTrace trace)

The trace object in the response from ConverseStream that contains information about the guardrail behavior.

Parameters:

trace - The trace object in the response from ConverseStream that contains information about the guardrail behavior.

Returns:

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

trace

default ConverseStreamMetadataEvent.Builder trace(Consumer<ConverseStreamTrace.Builder> trace)

The trace object in the response from ConverseStream that contains information about the guardrail behavior.

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

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

Parameters:

trace - a consumer that will call methods on ConverseStreamTrace.Builder

Returns:

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

See Also:

• trace(ConverseStreamTrace)

performanceConfig

ConverseStreamMetadataEvent.Builder performanceConfig(PerformanceConfiguration performanceConfig)

Model performance configuration metadata for the conversation stream event.

Parameters:

performanceConfig - Model performance configuration metadata for the conversation stream event.

Returns:

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

performanceConfig

default ConverseStreamMetadataEvent.Builder performanceConfig(Consumer<PerformanceConfiguration.Builder> performanceConfig)

Model performance configuration metadata for the conversation stream event.

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

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

Parameters:

performanceConfig - a consumer that will call methods on PerformanceConfiguration.Builder

Returns:

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

See Also:

• performanceConfig(PerformanceConfiguration)