Package software.amazon.awssdk.services.bedrockruntime.model

Class ConverseStreamMetadataEvent

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamMetadataEvent

All Implemented Interfaces:

Serializable, SdkPojo, ConverseStreamOutput, ToCopyableBuilder<ConverseStreamMetadataEvent.Builder,ConverseStreamMetadataEvent>

Direct Known Subclasses:

DefaultMetadata

@Generated("software.amazon.awssdk:codegen")
public class ConverseStreamMetadataEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConverseStreamMetadataEvent.Builder,ConverseStreamMetadataEvent>, ConverseStreamOutput

A conversation stream metadata event.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConverseStreamMetadataEvent.Builder
protected static class	ConverseStreamMetadataEvent.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamOutput

ConverseStreamOutput.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamOutput

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConverseStreamMetadataEvent(ConverseStreamMetadataEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
void	accept(ConverseStreamResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of ConverseStreamMetadataEvent.
static ConverseStreamMetadataEvent.Builder	builder()
ConverseStreamMetadataEvent	copy(Consumer<? super ConverseStreamMetadataEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ConverseStreamMetrics	metrics()	The metrics for the conversation stream metadata event.
List<SdkField<?>>	sdkFields()
static Class<? extends ConverseStreamMetadataEvent.Builder>	serializableBuilderClass()
ConverseStreamMetadataEvent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ConverseStreamTrace	trace()	The trace object in the response from ConverseStream that contains information about the guardrail behavior.
TokenUsage	usage()	Usage information for the conversation stream event.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamOutput

sdkEventType

Constructor Detail

ConverseStreamMetadataEvent

protected ConverseStreamMetadataEvent(ConverseStreamMetadataEvent.BuilderImpl builder)

Method Detail

usage

public final TokenUsage usage()

Usage information for the conversation stream event.

Returns:

Usage information for the conversation stream event.

metrics

public final ConverseStreamMetrics metrics()

The metrics for the conversation stream metadata event.

Returns:

The metrics for the conversation stream metadata event.

trace

public final ConverseStreamTrace trace()

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

Returns:

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

toBuilder

public ConverseStreamMetadataEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConverseStreamMetadataEvent.Builder,ConverseStreamMetadataEvent>

builder

public static ConverseStreamMetadataEvent.Builder builder()

serializableBuilderClass

public static Class<? extends ConverseStreamMetadataEvent.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

copy

public final ConverseStreamMetadataEvent copy(Consumer<? super ConverseStreamMetadataEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<ConverseStreamMetadataEvent.Builder,ConverseStreamMetadataEvent>

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

accept

public void accept(ConverseStreamResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of ConverseStreamMetadataEvent.

Specified by:

accept in interface ConverseStreamOutput

Parameters:

visitor - Visitor to invoke.