Class CitationEvent

java.lang.Object
software.amazon.awssdk.services.bedrockagentruntime.model.CitationEvent
All Implemented Interfaces:
Serializable, SdkPojo, RetrieveAndGenerateStreamResponseOutput, ToCopyableBuilder<CitationEvent.Builder,CitationEvent>
Direct Known Subclasses:
DefaultCitation
@Generated("software.amazon.awssdk:codegen") public class CitationEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CitationEvent.Builder,CitationEvent>, RetrieveAndGenerateStreamResponseOutput

A citation event.

See Also:

  • Method Details

    • citation

      @Deprecated public final Citation citation()
      Deprecated.
      Citation is deprecated. Please use GeneratedResponsePart and RetrievedReferences for citation event.

      The citation.

      Returns:
      The citation.

    • generatedResponsePart

      public final GeneratedResponsePart generatedResponsePart()

      The generated response to the citation event.

      Returns:
      The generated response to the citation event.

    • hasRetrievedReferences

      public final boolean hasRetrievedReferences()
      For responses, this returns true if the service returned a value for the RetrievedReferences 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.

    • retrievedReferences

      public final List<RetrievedReference> retrievedReferences()

      The retrieved references of the citation event.

      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 hasRetrievedReferences() method.

      Returns:
      The retrieved references of the citation event.

    • toBuilder

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

    • builder

      public static CitationEvent.Builder builder()

    • serializableBuilderClass

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

    • copy

      public final CitationEvent copy(Consumer<? super CitationEvent.Builder> modifier)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<CitationEvent.Builder,CitationEvent>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.

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

    • accept

      public void accept(RetrieveAndGenerateStreamResponseHandler.Visitor visitor)
      Calls the appropriate visit method depending on the subtype of CitationEvent.
      Specified by:
      accept in interface RetrieveAndGenerateStreamResponseOutput
      Parameters:
      visitor - Visitor to invoke.