Class AgenticRetrieveTraceEventAttributes

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

Attributes describing the details of an agentic retrieval trace event.

See Also:

  • Method Details

    • hasActions

      public final boolean hasActions()
      For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • actions

      public final List<AgenticRetrieveAction> actions()

      The list of actions taken during this step.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActions() method.

      Returns:
      The list of actions taken during this step.

    • hasFailures

      public final boolean hasFailures()
      For responses, this returns true if the service returned a value for the Failures property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • failures

      public final List<AgenticRetrieveFailure> failures()

      Failures that occurred during this step.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFailures() method.

      Returns:
      Failures that occurred during this step.

    • message

      public final String message()

      A human-readable message describing the trace event.

      Returns:
      A human-readable message describing the trace event.

    • hasRetrievalMetadata

      public final boolean hasRetrievalMetadata()
      For responses, this returns true if the service returned a value for the RetrievalMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • retrievalMetadata

      public final List<AgenticRetrieveSourceMetadata> retrievalMetadata()

      Metadata about the retrieval sources used.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRetrievalMetadata() method.

      Returns:
      Metadata about the retrieval sources used.

    • hasRetrievalResponse

      public final boolean hasRetrievalResponse()
      For responses, this returns true if the service returned a value for the RetrievalResponse property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • retrievalResponse

      public final List<AgenticRetrieveTraceResultItem> retrievalResponse()

      The retrieval results from this step.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRetrievalResponse() method.

      Returns:
      The retrieval results from this step.

    • status

      public final AgenticRetrieveStatus status()

      The status of the current step.

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

      Returns:
      The status of the current step.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the current step.

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

      Returns:
      The status of the current step.
      See Also:

    • step

      public final AgenticRetrieveStep step()

      The current step in the retrieval process.

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

      Returns:
      The current step in the retrieval process.
      See Also:

    • stepAsString

      public final String stepAsString()

      The current step in the retrieval process.

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

      Returns:
      The current step in the retrieval process.
      See Also:

    • hasWarnings

      public final boolean hasWarnings()
      For responses, this returns true if the service returned a value for the Warnings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • warnings

      public final List<AgenticRetrieveWarning> warnings()

      Warnings generated during this step.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWarnings() method.

      Returns:
      Warnings generated during this step.

    • toBuilder

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

    • builder

      public static AgenticRetrieveTraceEventAttributes.Builder builder()

    • serializableBuilderClass

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