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.CreateGuardrailRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateGuardrailRequest.Builder,CreateGuardrailRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateGuardrailRequest
extends BedrockRequest
implements ToCopyableBuilder<CreateGuardrailRequest.Builder,CreateGuardrailRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateGuardrailRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`blockedInputMessaging()`	The message to return when the guardrail blocks a prompt.
`String`	`blockedOutputsMessaging()`	The message to return when the guardrail blocks a model response.
`static CreateGuardrailRequest.Builder`	`builder()`
`String`	`clientRequestToken()`	A unique, case-sensitive identifier to ensure that the API request completes no more than once.
`GuardrailContentPolicyConfig`	`contentPolicyConfig()`	The content filter policies to configure for the guardrail.
`GuardrailContextualGroundingPolicyConfig`	`contextualGroundingPolicyConfig()`	The contextual grounding policy configuration used to create a guardrail.
`GuardrailCrossRegionConfig`	`crossRegionConfig()`	The system-defined guardrail profile that you're using with your guardrail.
`String`	`description()`	A description of the guardrail.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`kmsKeyId()`	The ARN of the KMS key that you use to encrypt the guardrail.
`String`	`name()`	The name to give the guardrail.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`GuardrailSensitiveInformationPolicyConfig`	`sensitiveInformationPolicyConfig()`	The sensitive information policy to configure for the guardrail.
`static Class<? extends CreateGuardrailRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	The tags that you want to attach to the guardrail.
`CreateGuardrailRequest.Builder`	`toBuilder()`
`GuardrailTopicPolicyConfig`	`topicPolicyConfig()`	The topic policies to configure for the guardrail.
`String`	`toString()`	Returns a string representation of this object.
`GuardrailWordPolicyConfig`	`wordPolicyConfig()`	The word policy you configure for the guardrail.

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
  - name
```
public final String name()
```
    The name to give the guardrail.
    
    Returns:
    
    The name to give the guardrail.
  - description
```
public final String description()
```
    A description of the guardrail.
    
    Returns:
    
    A description of the guardrail.
  - topicPolicyConfig
```
public final GuardrailTopicPolicyConfig topicPolicyConfig()
```
    The topic policies to configure for the guardrail.
    
    Returns:
    
    The topic policies to configure for the guardrail.
  - contentPolicyConfig
```
public final GuardrailContentPolicyConfig contentPolicyConfig()
```
    The content filter policies to configure for the guardrail.
    
    Returns:
    
    The content filter policies to configure for the guardrail.
  - wordPolicyConfig
```
public final GuardrailWordPolicyConfig wordPolicyConfig()
```
    The word policy you configure for the guardrail.
    
    Returns:
    
    The word policy you configure for the guardrail.
  - sensitiveInformationPolicyConfig
```
public final GuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig()
```
    The sensitive information policy to configure for the guardrail.
    
    Returns:
    
    The sensitive information policy to configure for the guardrail.
  - contextualGroundingPolicyConfig
```
public final GuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig()
```
    The contextual grounding policy configuration used to create a guardrail.
    
    Returns:
    
    The contextual grounding policy configuration used to create a guardrail.
  - crossRegionConfig
```
public final GuardrailCrossRegionConfig crossRegionConfig()
```
    The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
    
    For more information, see the Amazon Bedrock User Guide.
    
    Returns:
    
    The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
    
    For more information, see the Amazon Bedrock User Guide.
  - blockedInputMessaging
```
public final String blockedInputMessaging()
```
    The message to return when the guardrail blocks a prompt.
    
    Returns:
    
    The message to return when the guardrail blocks a prompt.
  - blockedOutputsMessaging
```
public final String 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
```
public final String 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 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()
```
    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
```
public final String 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
```
public CreateGuardrailRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateGuardrailRequest.Builder,CreateGuardrailRequest>
    
    Specified by:
    
    toBuilder in class BedrockRequest
  - builder
```
public static CreateGuardrailRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateGuardrailRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateGuardrailRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

description

topicPolicyConfig

contentPolicyConfig

wordPolicyConfig

sensitiveInformationPolicyConfig

contextualGroundingPolicyConfig

crossRegionConfig

blockedInputMessaging

blockedOutputsMessaging

kmsKeyId

hasTags

tags

clientRequestToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField