Interface ApplyGuardrailResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BedrockRuntimeResponse.Builder, Buildable, CopyableBuilder<ApplyGuardrailResponse.Builder,ApplyGuardrailResponse>, SdkBuilder<ApplyGuardrailResponse.Builder,ApplyGuardrailResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ApplyGuardrailResponse

@Mutable
@NotThreadSafe
public static interface ApplyGuardrailResponse.Builder
extends BedrockRuntimeResponse.Builder, SdkPojo, CopyableBuilder<ApplyGuardrailResponse.Builder,ApplyGuardrailResponse>

Method Summary

Modifier and Type	Method	Description
ApplyGuardrailResponse.Builder	action(String action)	The action taken in the response from the guardrail.
ApplyGuardrailResponse.Builder	action(GuardrailAction action)	The action taken in the response from the guardrail.
ApplyGuardrailResponse.Builder	actionReason(String actionReason)	The reason for the action taken when harmful content is detected.
ApplyGuardrailResponse.Builder	assessments(Collection<GuardrailAssessment> assessments)	The assessment details in the response from the guardrail.
ApplyGuardrailResponse.Builder	assessments(Consumer<GuardrailAssessment.Builder>... assessments)	The assessment details in the response from the guardrail.
ApplyGuardrailResponse.Builder	assessments(GuardrailAssessment... assessments)	The assessment details in the response from the guardrail.
default ApplyGuardrailResponse.Builder	guardrailCoverage(Consumer<GuardrailCoverage.Builder> guardrailCoverage)	The guardrail coverage details in the apply guardrail response.
ApplyGuardrailResponse.Builder	guardrailCoverage(GuardrailCoverage guardrailCoverage)	The guardrail coverage details in the apply guardrail response.
ApplyGuardrailResponse.Builder	outputs(Collection<GuardrailOutputContent> outputs)	The output details in the response from the guardrail.
ApplyGuardrailResponse.Builder	outputs(Consumer<GuardrailOutputContent.Builder>... outputs)	The output details in the response from the guardrail.
ApplyGuardrailResponse.Builder	outputs(GuardrailOutputContent... outputs)	The output details in the response from the guardrail.
default ApplyGuardrailResponse.Builder	usage(Consumer<GuardrailUsage.Builder> usage)	The usage details in the response from the guardrail.
ApplyGuardrailResponse.Builder	usage(GuardrailUsage usage)	The usage details in the response from the guardrail.

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

build, responseMetadata, responseMetadata

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

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

usage

ApplyGuardrailResponse.Builder usage(GuardrailUsage usage)

The usage details in the response from the guardrail.

Parameters:

usage - The usage details in the response from the guardrail.

Returns:

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

usage

default ApplyGuardrailResponse.Builder usage(Consumer<GuardrailUsage.Builder> usage)

The usage details in the response from the guardrail.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to usage(GuardrailUsage).

Parameters:

usage - a consumer that will call methods on GuardrailUsage.Builder

Returns:

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

See Also:

• usage(GuardrailUsage)

action

ApplyGuardrailResponse.Builder action(String action)

The action taken in the response from the guardrail.

Parameters:

action - The action taken in the response from the guardrail.

Returns:

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

See Also:

• GuardrailAction
• GuardrailAction

action

ApplyGuardrailResponse.Builder action(GuardrailAction action)

The action taken in the response from the guardrail.

Parameters:

action - The action taken in the response from the guardrail.

Returns:

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

See Also:

• GuardrailAction
• GuardrailAction

actionReason

ApplyGuardrailResponse.Builder actionReason(String actionReason)

The reason for the action taken when harmful content is detected.

Parameters:

actionReason - The reason for the action taken when harmful content is detected.

Returns:

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

outputs

ApplyGuardrailResponse.Builder outputs(Collection<GuardrailOutputContent> outputs)

The output details in the response from the guardrail.

Parameters:

outputs - The output details in the response from the guardrail.

Returns:

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

outputs

ApplyGuardrailResponse.Builder outputs(GuardrailOutputContent... outputs)

The output details in the response from the guardrail.

Parameters:

outputs - The output details in the response from the guardrail.

Returns:

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

outputs

ApplyGuardrailResponse.Builder outputs(Consumer<GuardrailOutputContent.Builder>... outputs)

The output details in the response from the guardrail.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputs(List<GuardrailOutputContent>).

Parameters:

outputs - a consumer that will call methods on GuardrailOutputContent.Builder

Returns:

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

See Also:

• outputs(java.util.Collection<GuardrailOutputContent>)

assessments

ApplyGuardrailResponse.Builder assessments(Collection<GuardrailAssessment> assessments)

The assessment details in the response from the guardrail.

Parameters:

assessments - The assessment details in the response from the guardrail.

Returns:

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

assessments

ApplyGuardrailResponse.Builder assessments(GuardrailAssessment... assessments)

The assessment details in the response from the guardrail.

Parameters:

assessments - The assessment details in the response from the guardrail.

Returns:

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

assessments

ApplyGuardrailResponse.Builder assessments(Consumer<GuardrailAssessment.Builder>... assessments)

The assessment details in the response from the guardrail.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to assessments(List<GuardrailAssessment>).

Parameters:

assessments - a consumer that will call methods on GuardrailAssessment.Builder

Returns:

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

See Also:

• assessments(java.util.Collection<GuardrailAssessment>)

guardrailCoverage

ApplyGuardrailResponse.Builder guardrailCoverage(GuardrailCoverage guardrailCoverage)

The guardrail coverage details in the apply guardrail response.

Parameters:

guardrailCoverage - The guardrail coverage details in the apply guardrail response.

Returns:

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

guardrailCoverage

default ApplyGuardrailResponse.Builder guardrailCoverage(Consumer<GuardrailCoverage.Builder> guardrailCoverage)

The guardrail coverage details in the apply guardrail response.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to guardrailCoverage(GuardrailCoverage).

Parameters:

guardrailCoverage - a consumer that will call methods on GuardrailCoverage.Builder

Returns:

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

See Also:

• guardrailCoverage(GuardrailCoverage)