Class CreateRetrievalInstructionRequest

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

  • Method Details

    • clientToken

      public final String clientToken()

      A caller-supplied token that makes a retried create return the existing resource rather than a second one. The window is 8 hours.

      Returns:
      A caller-supplied token that makes a retried create return the existing resource rather than a second one. The window is 8 hours.

    • name

      public final String name()

      Specifies the name of the retrieval instruction.

      Returns:
      Specifies the name of the retrieval instruction.

    • instruction

      public final RetrievalInstructionContent instruction()

      The instruction content, as a set of named fields. Get does not return this field until the create review passes.

      Returns:
      The instruction content, as a set of named fields. Get does not return this field until the create review passes.

    • description

      public final String description()

      Specifies a description of the retrieval instruction.

      Returns:
      Specifies a description of the retrieval instruction.

    • customerEncryptionKeyArn

      public final String customerEncryptionKeyArn()

      The Amazon Resource Name (ARN) of a customer managed AWS Key Management Service (AWS KMS) key used to encrypt the instruction content at rest. If you omit it, the service uses an AWS owned key. You fix the key at create and cannot change it later.

      Returns:
      The Amazon Resource Name (ARN) of a customer managed AWS Key Management Service (AWS KMS) key used to encrypt the instruction content at rest. If you omit it, the service uses an AWS owned key. You fix the key at create and cannot change it later.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      Tags for the retrieval instruction.

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

      Returns:
      Tags for the retrieval instruction.

    • toBuilder

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

    • builder

      public static CreateRetrievalInstructionRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.