Class RetrievalInstructionSummary

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

A summary of a retrieval instruction, without the content.

See Also:

  • Method Details

    • retrievalInstructionId

      public final String retrievalInstructionId()

      The identifier of the retrieval instruction.

      Returns:
      The identifier of the retrieval instruction.

    • retrievalInstructionArn

      public final String retrievalInstructionArn()

      The ARN of the retrieval instruction.

      Returns:
      The ARN of the retrieval instruction.

    • name

      public final String name()

      The name of the retrieval instruction.

      Returns:
      The name of the retrieval instruction.

    • status

      public final RetrievalInstructionStatus status()

      Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time.

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

      Returns:
      Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time.
      See Also:

    • statusAsString

      public final String statusAsString()

      Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time.

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

      Returns:
      Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time.
      See Also:

    • lastTransitionStatus

      public final RetrievalInstructionLastTransitionStatus lastTransitionStatus()

      The outcome or in-progress state of the most recent create or update of the retrieval instruction.

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

      Returns:
      The outcome or in-progress state of the most recent create or update of the retrieval instruction.
      See Also:

    • lastTransitionStatusAsString

      public final String lastTransitionStatusAsString()

      The outcome or in-progress state of the most recent create or update of the retrieval instruction.

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

      Returns:
      The outcome or in-progress state of the most recent create or update of the retrieval instruction.
      See Also:

    • createdAt

      public final Instant createdAt()

      When you created the retrieval instruction.

      Returns:
      When you created the retrieval instruction.

    • updatedAt

      public final Instant updatedAt()

      When the retrieval instruction was last updated.

      Returns:
      When the retrieval instruction was last updated.

    • description

      public final String description()

      A description of the retrieval instruction.

      Returns:
      A description of the retrieval instruction.

    • toBuilder

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

    • builder

      public static RetrievalInstructionSummary.Builder builder()

    • serializableBuilderClass

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