Class CreateRetrievalInstructionResponse

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.CreateRetrievalInstructionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateRetrievalInstructionResponse.Builder,CreateRetrievalInstructionResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateRetrievalInstructionResponse extends BedrockAgentResponse implements ToCopyableBuilder<CreateRetrievalInstructionResponse.Builder,CreateRetrievalInstructionResponse>

  • Method Details

    • retrievalInstructionId

      public final String retrievalInstructionId()

      The identifier of the newly created retrieval instruction.

      Returns:
      The identifier of the newly created retrieval instruction.

    • retrievalInstructionArn

      public final String retrievalInstructionArn()

      The ARN of the newly created retrieval instruction.

      Returns:
      The ARN of the newly created 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()

      Always INACTIVE on this response. The content review has not run when this call returns, so the resource is not yet usable.

      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:
      Always INACTIVE on this response. The content review has not run when this call returns, so the resource is not yet usable.
      See Also:

    • statusAsString

      public final String statusAsString()

      Always INACTIVE on this response. The content review has not run when this call returns, so the resource is not yet usable.

      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:
      Always INACTIVE on this response. The content review has not run when this call returns, so the resource is not yet usable.
      See Also:

    • lastTransitionStatus

      public final RetrievalInstructionLastTransitionStatus lastTransitionStatus()

      Always CREATING on this response. Poll GetRetrievalInstruction until this member is neither CREATING nor UPDATING, then read the outcome from it.

      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:
      Always CREATING on this response. Poll GetRetrievalInstruction until this member is neither CREATING nor UPDATING, then read the outcome from it.
      See Also:

    • lastTransitionStatusAsString

      public final String lastTransitionStatusAsString()

      Always CREATING on this response. Poll GetRetrievalInstruction until this member is neither CREATING nor UPDATING, then read the outcome from it.

      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:
      Always CREATING on this response. Poll GetRetrievalInstruction until this member is neither CREATING nor UPDATING, then read the outcome from it.
      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.

    • toBuilder

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

    • builder

      public static CreateRetrievalInstructionResponse.Builder builder()

    • serializableBuilderClass

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