Package software.amazon.awssdk.services.bedrockagentruntime.model

Class Metadata

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.Metadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Metadata.Builder,Metadata>

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

Provides information about the execution process for different types of invocations, such as model invocation, knowledge base invocation, agent collaborator invocation, guardrail invocation, and code interpreter Invocation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Metadata.Builder

Method Summary

Modifier and Type	Method	Description
static Metadata.Builder	builder()
String	clientRequestId()	A unique identifier associated with the downstream invocation.
Instant	endTime()	In the final response, endTime is the end time of the agent invocation operation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Long	operationTotalTimeMs()	The total time it took for the agent to complete execution.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Metadata.Builder>	serializableBuilderClass()
Instant	startTime()	In the final response, startTime is the start time of the agent invocation operation.
Metadata.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Long	totalTimeMs()	The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter).
Usage	usage()	Specific to model invocation and contains details about the usage of a foundation model.

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

clientRequestId

public final String clientRequestId()

A unique identifier associated with the downstream invocation. This ID can be used for tracing, debugging, and identifying specific invocations in customer logs or systems.

Returns:

A unique identifier associated with the downstream invocation. This ID can be used for tracing, debugging, and identifying specific invocations in customer logs or systems.

endTime

public final Instant endTime()

In the final response, endTime is the end time of the agent invocation operation.

Returns:

In the final response, endTime is the end time of the agent invocation operation.

operationTotalTimeMs

public final Long operationTotalTimeMs()

The total time it took for the agent to complete execution. This field is only set for the final response.

Returns:

The total time it took for the agent to complete execution. This field is only set for the final response.

startTime

public final Instant startTime()

In the final response, startTime is the start time of the agent invocation operation.

Returns:

In the final response, startTime is the start time of the agent invocation operation.

totalTimeMs

public final Long totalTimeMs()

The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter). It represents how long the individual invocation took.

Returns:

The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter). It represents how long the individual invocation took.

usage

public final Usage usage()

Specific to model invocation and contains details about the usage of a foundation model.

Returns:

Specific to model invocation and contains details about the usage of a foundation model.

toBuilder

public Metadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Metadata.Builder,Metadata>

builder

public static Metadata.Builder builder()

serializableBuilderClass

public static Class<? extends Metadata.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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo