Class Span

java.lang.Object
software.amazon.awssdk.services.qconnect.model.Span
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Span.Builder,Span>
@Generated("software.amazon.awssdk:codegen") public final class Span extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Span.Builder,Span>

A span represents a unit of work during AI agent execution, capturing timing, status, and contextual attributes.

See Also:

  • Method Details

    • spanId

      public final String spanId()

      Unique span identifier

      Returns:
      Unique span identifier

    • assistantId

      public final String assistantId()

      UUID of the Connect AI Assistant resource

      Returns:
      UUID of the Connect AI Assistant resource

    • sessionId

      public final String sessionId()

      UUID of the Connect AI Session resource

      Returns:
      UUID of the Connect AI Session resource

    • parentSpanId

      public final String parentSpanId()

      Parent span identifier for hierarchy. Null for root spans.

      Returns:
      Parent span identifier for hierarchy. Null for root spans.

    • spanName

      public final String spanName()

      Service-defined operation name

      Returns:
      Service-defined operation name

    • spanType

      public final SpanType spanType()

      Operation relationship type

      If the service returns an enum value that is not available in the current SDK version, spanType will return SpanType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from spanTypeAsString().

      Returns:
      Operation relationship type
      See Also:

    • spanTypeAsString

      public final String spanTypeAsString()

      Operation relationship type

      If the service returns an enum value that is not available in the current SDK version, spanType will return SpanType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from spanTypeAsString().

      Returns:
      Operation relationship type
      See Also:

    • startTimestamp

      public final Instant startTimestamp()

      Operation start time in milliseconds since epoch

      Returns:
      Operation start time in milliseconds since epoch

    • endTimestamp

      public final Instant endTimestamp()

      Operation end time in milliseconds since epoch

      Returns:
      Operation end time in milliseconds since epoch

    • status

      public final SpanStatus status()

      Span completion status

      If the service returns an enum value that is not available in the current SDK version, status will return SpanStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Span completion status
      See Also:

    • statusAsString

      public final String statusAsString()

      Span completion status

      If the service returns an enum value that is not available in the current SDK version, status will return SpanStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Span completion status
      See Also:

    • requestId

      public final String requestId()

      The service request ID that initiated the operation

      Returns:
      The service request ID that initiated the operation

    • attributes

      public final SpanAttributes attributes()

      Span-specific contextual attributes

      Returns:
      Span-specific contextual attributes

    • toBuilder

      public Span.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<Span.Builder,Span>
      Returns:
      a builder for type T

    • builder

      public static Span.Builder builder()

    • serializableBuilderClass

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