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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreatePromptRouterRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreatePromptRouterRequest.Builderbuilder()StringclientRequestToken()A unique, case-sensitive identifier that you provide to ensure idempotency of your requests.Stringdescription()An optional description of the prompt router to help identify its purpose.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)PromptRouterTargetModelfallbackModel()The default model to use when the routing criteria is not met.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasModels()For responses, this returns true if the service returned a value for the Models property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.List<PromptRouterTargetModel>models()A list of foundation models that the prompt router can route requests to.StringpromptRouterName()The name of the prompt router.RoutingCriteriaroutingCriteria()The criteria, which is the response quality difference, used to determine how incoming requests are routed to different models.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreatePromptRouterRequest.Builder>serializableBuilderClass()List<Tag>tags()An array of key-value pairs to apply to this resource as tags.CreatePromptRouterRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreatePromptRouterRequest.Builder,CreatePromptRouterRequest>- Specified by:
toBuilderin classBedrockRequest
-
builder
public static CreatePromptRouterRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreatePromptRouterRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-