Package software.amazon.awssdk.services.bedrockruntime.model

Interface ApplyGuardrailRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockRuntimeRequest.Builder, Buildable, CopyableBuilder<ApplyGuardrailRequest.Builder,ApplyGuardrailRequest>, SdkBuilder<ApplyGuardrailRequest.Builder,ApplyGuardrailRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ApplyGuardrailRequest

@Mutable
@NotThreadSafe
public static interface ApplyGuardrailRequest.Builder
extends BedrockRuntimeRequest.Builder, SdkPojo, CopyableBuilder<ApplyGuardrailRequest.Builder,ApplyGuardrailRequest>

Method Summary

Modifier and Type	Method	Description
ApplyGuardrailRequest.Builder	content(Collection<GuardrailContentBlock> content)	The content details used in the request to apply the guardrail.
ApplyGuardrailRequest.Builder	content(Consumer<GuardrailContentBlock.Builder>... content)	The content details used in the request to apply the guardrail.
ApplyGuardrailRequest.Builder	content(GuardrailContentBlock... content)	The content details used in the request to apply the guardrail.
ApplyGuardrailRequest.Builder	guardrailIdentifier(String guardrailIdentifier)	The guardrail identifier used in the request to apply the guardrail.
ApplyGuardrailRequest.Builder	guardrailVersion(String guardrailVersion)	The guardrail version used in the request to apply the guardrail.
ApplyGuardrailRequest.Builder	outputScope(String outputScope)	Specifies the scope of the output that you get in the response.
ApplyGuardrailRequest.Builder	outputScope(GuardrailOutputScope outputScope)	Specifies the scope of the output that you get in the response.
ApplyGuardrailRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ApplyGuardrailRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ApplyGuardrailRequest.Builder	source(String source)	The source of data used in the request to apply the guardrail.
ApplyGuardrailRequest.Builder	source(GuardrailContentSource source)	The source of data used in the request to apply the guardrail.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

guardrailIdentifier

ApplyGuardrailRequest.Builder guardrailIdentifier(String guardrailIdentifier)

The guardrail identifier used in the request to apply the guardrail.

Parameters:

guardrailIdentifier - The guardrail identifier used in the request to apply the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

guardrailVersion

ApplyGuardrailRequest.Builder guardrailVersion(String guardrailVersion)

The guardrail version used in the request to apply the guardrail.

Parameters:

guardrailVersion - The guardrail version used in the request to apply the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

source

ApplyGuardrailRequest.Builder source(String source)

The source of data used in the request to apply the guardrail.

Parameters:

source - The source of data used in the request to apply the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GuardrailContentSource, GuardrailContentSource

source

ApplyGuardrailRequest.Builder source(GuardrailContentSource source)

The source of data used in the request to apply the guardrail.

Parameters:

source - The source of data used in the request to apply the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GuardrailContentSource, GuardrailContentSource

content

ApplyGuardrailRequest.Builder content(Collection<GuardrailContentBlock> content)

The content details used in the request to apply the guardrail.

Parameters:

content - The content details used in the request to apply the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

content

ApplyGuardrailRequest.Builder content(GuardrailContentBlock... content)

The content details used in the request to apply the guardrail.

Parameters:

content - The content details used in the request to apply the guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

content

ApplyGuardrailRequest.Builder content(Consumer<GuardrailContentBlock.Builder>... content)

The content details used in the request to apply the guardrail.

This is a convenience method that creates an instance of the GuardrailContentBlock.Builder avoiding the need to create one manually via GuardrailContentBlock.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #content(List).

Parameters:

content - a consumer that will call methods on GuardrailContentBlock.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#content(java.util.Collection)

outputScope

ApplyGuardrailRequest.Builder outputScope(String 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GuardrailOutputScope, GuardrailOutputScope

outputScope

ApplyGuardrailRequest.Builder outputScope(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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GuardrailOutputScope, GuardrailOutputScope

overrideConfiguration

ApplyGuardrailRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ApplyGuardrailRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder