java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeRequest
    - - software.amazon.awssdk.services.bedrockruntime.model.ApplyGuardrailRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ApplyGuardrailRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ApplyGuardrailRequest.Builder`	`builder()`
`List<GuardrailContentBlock>`	`content()`	The content details used in the request to apply the guardrail.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`guardrailIdentifier()`	The guardrail identifier used in the request to apply the guardrail.
`String`	`guardrailVersion()`	The guardrail version used in the request to apply the guardrail.
`boolean`	`hasContent()`	For responses, this returns true if the service returned a value for the Content property.
`int`	`hashCode()`
`GuardrailOutputScope`	`outputScope()`	Specifies the scope of the output that you get in the response.
`String`	`outputScopeAsString()`	Specifies the scope of the output that you get in the response.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ApplyGuardrailRequest.Builder>`	`serializableBuilderClass()`
`GuardrailContentSource`	`source()`	The source of data used in the request to apply the guardrail.
`String`	`sourceAsString()`	The source of data used in the request to apply the guardrail.
`ApplyGuardrailRequest.Builder`	`toBuilder()`
`String`	`toString()`	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
  - guardrailIdentifier
```
public final String guardrailIdentifier()
```
    The guardrail identifier used in the request to apply the guardrail.
    
    Returns:
    
    The guardrail identifier used in the request to apply the guardrail.
  - guardrailVersion
```
public final String guardrailVersion()
```
    The guardrail version used in the request to apply the guardrail.
    
    Returns:
    
    The guardrail version used in the request to apply the guardrail.
  - source
```
public final GuardrailContentSource source()
```
    The source of data used in the request to apply the guardrail.
    
    If the service returns an enum value that is not available in the current SDK version, source will return GuardrailContentSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceAsString().
    
    Returns:
    
    The source of data used in the request to apply the guardrail.
    
    See Also:
    
    GuardrailContentSource
  - sourceAsString
```
public final String sourceAsString()
```
    The source of data used in the request to apply the guardrail.
    
    If the service returns an enum value that is not available in the current SDK version, source will return GuardrailContentSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceAsString().
    
    Returns:
    
    The source of data used in the request to apply the guardrail.
    
    See Also:
    
    GuardrailContentSource
  - hasContent
```
public final boolean hasContent()
```
    For responses, this returns true if the service returned a value for the Content 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.
  - content
```
public final List<GuardrailContentBlock> content()
```
    The content details used in the request to apply 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 hasContent() method.
    
    Returns:
    
    The content details used in the request to apply the guardrail.
  - outputScope
```
public final GuardrailOutputScope outputScope()
```
    Specifies the scope of the output that you get in the response. Set to FULL to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.
    
    Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).
    
    If the service returns an enum value that is not available in the current SDK version, outputScope will return GuardrailOutputScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputScopeAsString().
    
    Returns:
    
    Specifies the scope of the output that you get in the response. Set to FULL to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.
    
    Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).
    
    See Also:
    
    GuardrailOutputScope
  - outputScopeAsString
```
public final String outputScopeAsString()
```
    Specifies the scope of the output that you get in the response. Set to FULL to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.
    
    Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).
    
    If the service returns an enum value that is not available in the current SDK version, outputScope will return GuardrailOutputScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputScopeAsString().
    
    Returns:
    
    Specifies the scope of the output that you get in the response. Set to FULL to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.
    
    Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).
    
    See Also:
    
    GuardrailOutputScope
  - toBuilder
```
public ApplyGuardrailRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ApplyGuardrailRequest.Builder,ApplyGuardrailRequest>
    
    Specified by:
    
    toBuilder in class BedrockRuntimeRequest
  - builder
```
public static ApplyGuardrailRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ApplyGuardrailRequest.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 ApplyGuardrailRequest

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

guardrailIdentifier

guardrailVersion

source

sourceAsString

hasContent

content

outputScope

outputScopeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField