Class GetRetrievalInstructionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.bedrockagent.model.BedrockAgentResponse
software.amazon.awssdk.services.bedrockagent.model.GetRetrievalInstructionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetRetrievalInstructionResponse.Builder,GetRetrievalInstructionResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetRetrievalInstructionResponse extends BedrockAgentResponse implements ToCopyableBuilder<GetRetrievalInstructionResponse.Builder,GetRetrievalInstructionResponse>

  • 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()

      Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.

      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:
      Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
      See Also:

    • statusAsString

      public final String statusAsString()

      Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.

      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:
      Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
      See Also:

    • lastTransitionStatus

      public final RetrievalInstructionLastTransitionStatus lastTransitionStatus()

      The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.

      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. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.
      See Also:

    • lastTransitionStatusAsString

      public final String lastTransitionStatusAsString()

      The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.

      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. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.
      See Also:

    • instruction

      public final RetrievalInstructionContent instruction()

      The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE. Absent until the first create review passes. Always present on a numbered version.

      Returns:
      The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE. Absent until the first create review passes. Always present on a numbered version.

    • createdAt

      public final Instant createdAt()

      When the retrieval instruction was created. On a numbered version, when that version was created.

      Returns:
      When the retrieval instruction was created. On a numbered version, when that version was created.

    • updatedAt

      public final Instant updatedAt()

      When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.

      Returns:
      When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.

    • description

      public final String description()

      A description of the retrieval instruction. On a numbered version, the description of that version.

      Returns:
      A description of the retrieval instruction. On a numbered version, the description of that version.

    • customerEncryptionKeyArn

      public final String customerEncryptionKeyArn()

      The ARN of the customer managed KMS key protecting this content, when one was supplied at create.

      Returns:
      The ARN of the customer managed KMS key protecting this content, when one was supplied at create.

    • hasLastTransitionStatusReasons

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

    • lastTransitionStatusReasons

      public final List<RetrievalInstructionFailureReason> lastTransitionStatusReasons()

      Why the most recent create or update was rejected. One entry for each rejected field, or a single entry when the review itself failed. Each entry has a machine-readable code and a message, and names the field when it applies to one. The service includes this field only when lastTransitionStatus is CREATE_FAILED or UPDATE_FAILED. Never present on a numbered version.

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

      Returns:
      Why the most recent create or update was rejected. One entry for each rejected field, or a single entry when the review itself failed. Each entry has a machine-readable code and a message, and names the field when it applies to one. The service includes this field only when lastTransitionStatus is CREATE_FAILED or UPDATE_FAILED. Never present on a numbered version.

    • version

      public final String version()

      The version this response describes: a version number, or DRAFT.

      Returns:
      The version this response describes: a version number, or DRAFT.

    • latestVersion

      public final String latestVersion()

      The largest version number that currently exists for this retrieval instruction, that is, the newest version you can retrieve. Present only on a DRAFT read, and only when at least one version exists. Because version numbers are never reused, deleting versions can leave gaps: this is the newest existing version, not a count and not the highest number ever created.

      Returns:
      The largest version number that currently exists for this retrieval instruction, that is, the newest version you can retrieve. Present only on a DRAFT read, and only when at least one version exists. Because version numbers are never reused, deleting versions can leave gaps: this is the newest existing version, not a count and not the highest number ever created.

    • toBuilder

      public GetRetrievalInstructionResponse.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<GetRetrievalInstructionResponse.Builder,GetRetrievalInstructionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetRetrievalInstructionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetRetrievalInstructionResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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