Class CreatePromptRouterRequest

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

  • Method Details

    • clientRequestToken

      public final String clientRequestToken()

      A unique, case-sensitive identifier that you provide to ensure idempotency of your requests. If not specified, the Amazon Web Services SDK automatically generates one for you.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure idempotency of your requests. If not specified, the Amazon Web Services SDK automatically generates one for you.

    • promptRouterName

      public final String promptRouterName()

      The name of the prompt router. The name must be unique within your Amazon Web Services account in the current region.

      Returns:
      The name of the prompt router. The name must be unique within your Amazon Web Services account in the current region.

    • hasModels

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

    • models

      public final List<PromptRouterTargetModel> models()

      A list of foundation models that the prompt router can route requests to. At least one model must be specified.

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

      Returns:
      A list of foundation models that the prompt router can route requests to. At least one model must be specified.

    • description

      public final String description()

      An optional description of the prompt router to help identify its purpose.

      Returns:
      An optional description of the prompt router to help identify its purpose.

    • routingCriteria

      public final RoutingCriteria routingCriteria()

      The criteria, which is the response quality difference, used to determine how incoming requests are routed to different models.

      Returns:
      The criteria, which is the response quality difference, used to determine how incoming requests are routed to different models.

    • fallbackModel

      public final PromptRouterTargetModel fallbackModel()

      The default model to use when the routing criteria is not met.

      Returns:
      The default model to use when the routing criteria is not met.

    • 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 List<Tag> tags()

      An array of key-value pairs to apply to this resource as tags. You can use tags to categorize and manage your Amazon Web Services resources.

      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:
      An array of key-value pairs to apply to this resource as tags. You can use tags to categorize and manage your Amazon Web Services resources.

    • toBuilder

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

    • builder

      public static CreatePromptRouterRequest.Builder builder()

    • serializableBuilderClass

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