Package software.amazon.awssdk.services.bedrock.model

Interface GetGuardrailResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BedrockResponse.Builder, Buildable, CopyableBuilder<GetGuardrailResponse.Builder,GetGuardrailResponse>, SdkBuilder<GetGuardrailResponse.Builder,GetGuardrailResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetGuardrailResponse

@Mutable
@NotThreadSafe
public static interface GetGuardrailResponse.Builder
extends BedrockResponse.Builder, SdkPojo, CopyableBuilder<GetGuardrailResponse.Builder,GetGuardrailResponse>

Method Summary

Modifier and Type	Method	Description
GetGuardrailResponse.Builder	blockedInputMessaging(String blockedInputMessaging)	The message that the guardrail returns when it blocks a prompt.
GetGuardrailResponse.Builder	blockedOutputsMessaging(String blockedOutputsMessaging)	The message that the guardrail returns when it blocks a model response.
default GetGuardrailResponse.Builder	contentPolicy(Consumer<GuardrailContentPolicy.Builder> contentPolicy)	The content policy that was configured for the guardrail.
GetGuardrailResponse.Builder	contentPolicy(GuardrailContentPolicy contentPolicy)	The content policy that was configured for the guardrail.
default GetGuardrailResponse.Builder	contextualGroundingPolicy(Consumer<GuardrailContextualGroundingPolicy.Builder> contextualGroundingPolicy)	The contextual grounding policy used in the guardrail.
GetGuardrailResponse.Builder	contextualGroundingPolicy(GuardrailContextualGroundingPolicy contextualGroundingPolicy)	The contextual grounding policy used in the guardrail.
GetGuardrailResponse.Builder	createdAt(Instant createdAt)	The date and time at which the guardrail was created.
default GetGuardrailResponse.Builder	crossRegionDetails(Consumer<GuardrailCrossRegionDetails.Builder> crossRegionDetails)	Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
GetGuardrailResponse.Builder	crossRegionDetails(GuardrailCrossRegionDetails crossRegionDetails)	Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
GetGuardrailResponse.Builder	description(String description)	The description of the guardrail.
GetGuardrailResponse.Builder	failureRecommendations(String... failureRecommendations)	Appears if the status of the guardrail is FAILED.
GetGuardrailResponse.Builder	failureRecommendations(Collection<String> failureRecommendations)	Appears if the status of the guardrail is FAILED.
GetGuardrailResponse.Builder	guardrailArn(String guardrailArn)	The ARN of the guardrail.
GetGuardrailResponse.Builder	guardrailId(String guardrailId)	The unique identifier of the guardrail.
GetGuardrailResponse.Builder	kmsKeyArn(String kmsKeyArn)	The ARN of the KMS key that encrypts the guardrail.
GetGuardrailResponse.Builder	name(String name)	The name of the guardrail.
default GetGuardrailResponse.Builder	sensitiveInformationPolicy(Consumer<GuardrailSensitiveInformationPolicy.Builder> sensitiveInformationPolicy)	The sensitive information policy that was configured for the guardrail.
GetGuardrailResponse.Builder	sensitiveInformationPolicy(GuardrailSensitiveInformationPolicy sensitiveInformationPolicy)	The sensitive information policy that was configured for the guardrail.
GetGuardrailResponse.Builder	status(String status)	The status of the guardrail.
GetGuardrailResponse.Builder	status(GuardrailStatus status)	The status of the guardrail.
GetGuardrailResponse.Builder	statusReasons(String... statusReasons)	Appears if the status is FAILED.
GetGuardrailResponse.Builder	statusReasons(Collection<String> statusReasons)	Appears if the status is FAILED.
default GetGuardrailResponse.Builder	topicPolicy(Consumer<GuardrailTopicPolicy.Builder> topicPolicy)	The topic policy that was configured for the guardrail.
GetGuardrailResponse.Builder	topicPolicy(GuardrailTopicPolicy topicPolicy)	The topic policy that was configured for the guardrail.
GetGuardrailResponse.Builder	updatedAt(Instant updatedAt)	The date and time at which the guardrail was updated.
GetGuardrailResponse.Builder	version(String version)	The version of the guardrail.
default GetGuardrailResponse.Builder	wordPolicy(Consumer<GuardrailWordPolicy.Builder> wordPolicy)	The word policy that was configured for the guardrail.
GetGuardrailResponse.Builder	wordPolicy(GuardrailWordPolicy wordPolicy)	The word policy that was configured for the guardrail.

Methods inherited from interface software.amazon.awssdk.services.bedrock.model.BedrockResponse.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 Detail

name

GetGuardrailResponse.Builder name(String name)

The name of the guardrail.

Parameters:

name - The name of the guardrail.

Returns:

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

description

GetGuardrailResponse.Builder description(String description)

The description of the guardrail.

Parameters:

description - The description of the guardrail.

Returns:

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

guardrailId

GetGuardrailResponse.Builder guardrailId(String guardrailId)

The unique identifier of the guardrail.

Parameters:

guardrailId - The unique identifier of the guardrail.

Returns:

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

guardrailArn

GetGuardrailResponse.Builder guardrailArn(String guardrailArn)

The ARN of the guardrail.

Parameters:

guardrailArn - The ARN of the guardrail.

Returns:

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

version

GetGuardrailResponse.Builder version(String version)

The version of the guardrail.

Parameters:

version - The version of the guardrail.

Returns:

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

status

GetGuardrailResponse.Builder status(String status)

The status of the guardrail.

Parameters:

status - The status of the guardrail.

Returns:

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

See Also:

GuardrailStatus, GuardrailStatus

status

GetGuardrailResponse.Builder status(GuardrailStatus status)

The status of the guardrail.

Parameters:

status - The status of the guardrail.

Returns:

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

See Also:

GuardrailStatus, GuardrailStatus

topicPolicy

GetGuardrailResponse.Builder topicPolicy(GuardrailTopicPolicy topicPolicy)

The topic policy that was configured for the guardrail.

Parameters:

topicPolicy - The topic policy that was configured for the guardrail.

Returns:

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

topicPolicy

default GetGuardrailResponse.Builder topicPolicy(Consumer<GuardrailTopicPolicy.Builder> topicPolicy)

The topic policy that was configured for the guardrail.

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

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

Parameters:

topicPolicy - a consumer that will call methods on GuardrailTopicPolicy.Builder

Returns:

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

See Also:

topicPolicy(GuardrailTopicPolicy)

contentPolicy

GetGuardrailResponse.Builder contentPolicy(GuardrailContentPolicy contentPolicy)

The content policy that was configured for the guardrail.

Parameters:

contentPolicy - The content policy that was configured for the guardrail.

Returns:

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

contentPolicy

default GetGuardrailResponse.Builder contentPolicy(Consumer<GuardrailContentPolicy.Builder> contentPolicy)

The content policy that was configured for the guardrail.

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

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

Parameters:

contentPolicy - a consumer that will call methods on GuardrailContentPolicy.Builder

Returns:

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

See Also:

contentPolicy(GuardrailContentPolicy)

wordPolicy

GetGuardrailResponse.Builder wordPolicy(GuardrailWordPolicy wordPolicy)

The word policy that was configured for the guardrail.

Parameters:

wordPolicy - The word policy that was configured for the guardrail.

Returns:

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

wordPolicy

default GetGuardrailResponse.Builder wordPolicy(Consumer<GuardrailWordPolicy.Builder> wordPolicy)

The word policy that was configured for the guardrail.

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

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

Parameters:

wordPolicy - a consumer that will call methods on GuardrailWordPolicy.Builder

Returns:

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

See Also:

wordPolicy(GuardrailWordPolicy)

sensitiveInformationPolicy

GetGuardrailResponse.Builder sensitiveInformationPolicy(GuardrailSensitiveInformationPolicy sensitiveInformationPolicy)

The sensitive information policy that was configured for the guardrail.

Parameters:

sensitiveInformationPolicy - The sensitive information policy that was configured for the guardrail.

Returns:

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

sensitiveInformationPolicy

default GetGuardrailResponse.Builder sensitiveInformationPolicy(Consumer<GuardrailSensitiveInformationPolicy.Builder> sensitiveInformationPolicy)

The sensitive information policy that was configured for the guardrail.

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

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

Parameters:

sensitiveInformationPolicy - a consumer that will call methods on GuardrailSensitiveInformationPolicy.Builder

Returns:

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

See Also:

sensitiveInformationPolicy(GuardrailSensitiveInformationPolicy)

contextualGroundingPolicy

GetGuardrailResponse.Builder contextualGroundingPolicy(GuardrailContextualGroundingPolicy contextualGroundingPolicy)

The contextual grounding policy used in the guardrail.

Parameters:

contextualGroundingPolicy - The contextual grounding policy used in the guardrail.

Returns:

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

contextualGroundingPolicy

default GetGuardrailResponse.Builder contextualGroundingPolicy(Consumer<GuardrailContextualGroundingPolicy.Builder> contextualGroundingPolicy)

The contextual grounding policy used in the guardrail.

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

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

Parameters:

contextualGroundingPolicy - a consumer that will call methods on GuardrailContextualGroundingPolicy.Builder

Returns:

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

See Also:

contextualGroundingPolicy(GuardrailContextualGroundingPolicy)

crossRegionDetails

GetGuardrailResponse.Builder crossRegionDetails(GuardrailCrossRegionDetails crossRegionDetails)

Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

Parameters:

crossRegionDetails - Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

Returns:

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

crossRegionDetails

default GetGuardrailResponse.Builder crossRegionDetails(Consumer<GuardrailCrossRegionDetails.Builder> crossRegionDetails)

Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

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

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

Parameters:

crossRegionDetails - a consumer that will call methods on GuardrailCrossRegionDetails.Builder

Returns:

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

See Also:

crossRegionDetails(GuardrailCrossRegionDetails)

createdAt

GetGuardrailResponse.Builder createdAt(Instant createdAt)

The date and time at which the guardrail was created.

Parameters:

createdAt - The date and time at which the guardrail was created.

Returns:

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

updatedAt

GetGuardrailResponse.Builder updatedAt(Instant updatedAt)

The date and time at which the guardrail was updated.

Parameters:

updatedAt - The date and time at which the guardrail was updated.

Returns:

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

statusReasons

GetGuardrailResponse.Builder statusReasons(Collection<String> statusReasons)

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

Parameters:

statusReasons - Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

Returns:

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

statusReasons

GetGuardrailResponse.Builder statusReasons(String... statusReasons)

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

Parameters:

statusReasons - Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

Returns:

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

failureRecommendations

GetGuardrailResponse.Builder failureRecommendations(Collection<String> failureRecommendations)

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

Parameters:

failureRecommendations - Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

Returns:

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

failureRecommendations

GetGuardrailResponse.Builder failureRecommendations(String... failureRecommendations)

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

Parameters:

failureRecommendations - Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

Returns:

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

blockedInputMessaging

GetGuardrailResponse.Builder blockedInputMessaging(String blockedInputMessaging)

The message that the guardrail returns when it blocks a prompt.

Parameters:

blockedInputMessaging - The message that the guardrail returns when it blocks a prompt.

Returns:

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

blockedOutputsMessaging

GetGuardrailResponse.Builder blockedOutputsMessaging(String blockedOutputsMessaging)

The message that the guardrail returns when it blocks a model response.

Parameters:

blockedOutputsMessaging - The message that the guardrail returns when it blocks a model response.

Returns:

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

kmsKeyArn

GetGuardrailResponse.Builder kmsKeyArn(String kmsKeyArn)

The ARN of the KMS key that encrypts the guardrail.

Parameters:

kmsKeyArn - The ARN of the KMS key that encrypts the guardrail.

Returns:

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