Class CreateGuardrailRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateGuardrailRequest.Builder,
CreateGuardrailRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The message to return when the guardrail blocks a prompt.final String
The message to return when the guardrail blocks a model response.builder()
final String
A unique, case-sensitive identifier to ensure that the API request completes no more than once.The content filter policies to configure for the guardrail.final String
A description of the guardrail.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKeyId()
The ARN of the KMS key that you use to encrypt the guardrail.final String
name()
The name to give the guardrail.The sensitive information policy to configure for the guardrail.static Class
<? extends CreateGuardrailRequest.Builder> tags()
The tags that you want to attach to the guardrail.Take this object and create a builder that contains all of the current property values of this object.The topic policies to configure for the guardrail.final String
toString()
Returns a string representation of this object.The word policy you configure for the guardrail.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name to give the guardrail.
- Returns:
- The name to give the guardrail.
-
description
A description of the guardrail.
- Returns:
- A description of the guardrail.
-
topicPolicyConfig
The topic policies to configure for the guardrail.
- Returns:
- The topic policies to configure for the guardrail.
-
contentPolicyConfig
The content filter policies to configure for the guardrail.
- Returns:
- The content filter policies to configure for the guardrail.
-
wordPolicyConfig
The word policy you configure for the guardrail.
- Returns:
- The word policy you configure for the guardrail.
-
sensitiveInformationPolicyConfig
The sensitive information policy to configure for the guardrail.
- Returns:
- The sensitive information policy to configure for the guardrail.
-
blockedInputMessaging
The message to return when the guardrail blocks a prompt.
- Returns:
- The message to return when the guardrail blocks a prompt.
-
blockedOutputsMessaging
The message to return when the guardrail blocks a model response.
- Returns:
- The message to return when the guardrail blocks a model response.
-
kmsKeyId
The ARN of the KMS key that you use to encrypt the guardrail.
- Returns:
- The ARN of the KMS key that you use to encrypt the guardrail.
-
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
The tags that you want to attach to the guardrail.
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:
- The tags that you want to attach to the guardrail.
-
clientRequestToken
A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.
- Returns:
- A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.
-
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 interfaceToCopyableBuilder<CreateGuardrailRequest.Builder,
CreateGuardrailRequest> - Specified by:
toBuilder
in classBedrockRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-