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:

  • Method Details

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

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

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

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

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

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Metadata.Builder,Metadata>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.