Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface GuardrailTrace.Builder

All Superinterfaces:

Buildable, CopyableBuilder<GuardrailTrace.Builder,GuardrailTrace>, SdkBuilder<GuardrailTrace.Builder,GuardrailTrace>, SdkPojo

Enclosing class:

GuardrailTrace

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

Method Summary

Modifier and Type	Method	Description
GuardrailTrace.Builder	action(String action)	The trace action details used with the Guardrail.
GuardrailTrace.Builder	action(GuardrailAction action)	The trace action details used with the Guardrail.
GuardrailTrace.Builder	inputAssessments(Collection<GuardrailAssessment> inputAssessments)	The details of the input assessments used in the Guardrail Trace.
GuardrailTrace.Builder	inputAssessments(Consumer<GuardrailAssessment.Builder>... inputAssessments)	The details of the input assessments used in the Guardrail Trace.
GuardrailTrace.Builder	inputAssessments(GuardrailAssessment... inputAssessments)	The details of the input assessments used in the Guardrail Trace.
default GuardrailTrace.Builder	metadata(Consumer<Metadata.Builder> metadata)	Contains information about the Guardrail output.
GuardrailTrace.Builder	metadata(Metadata metadata)	Contains information about the Guardrail output.
GuardrailTrace.Builder	outputAssessments(Collection<GuardrailAssessment> outputAssessments)	The details of the output assessments used in the Guardrail Trace.
GuardrailTrace.Builder	outputAssessments(Consumer<GuardrailAssessment.Builder>... outputAssessments)	The details of the output assessments used in the Guardrail Trace.
GuardrailTrace.Builder	outputAssessments(GuardrailAssessment... outputAssessments)	The details of the output assessments used in the Guardrail Trace.
GuardrailTrace.Builder	traceId(String traceId)	The details of the trace Id used in the Guardrail Trace.

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 Details

action

GuardrailTrace.Builder action(String action)

The trace action details used with the Guardrail.

Parameters:

action - The trace action details used with the Guardrail.

Returns:

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

See Also:

• GuardrailAction
• GuardrailAction

action

GuardrailTrace.Builder action(GuardrailAction action)

The trace action details used with the Guardrail.

Parameters:

action - The trace action details used with the Guardrail.

Returns:

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

See Also:

• GuardrailAction
• GuardrailAction

inputAssessments

GuardrailTrace.Builder inputAssessments(Collection<GuardrailAssessment> inputAssessments)

The details of the input assessments used in the Guardrail Trace.

Parameters:

inputAssessments - The details of the input assessments used in the Guardrail Trace.

Returns:

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

inputAssessments

GuardrailTrace.Builder inputAssessments(GuardrailAssessment... inputAssessments)

The details of the input assessments used in the Guardrail Trace.

Parameters:

inputAssessments - The details of the input assessments used in the Guardrail Trace.

Returns:

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

inputAssessments

GuardrailTrace.Builder inputAssessments(Consumer<GuardrailAssessment.Builder>... inputAssessments)

The details of the input assessments used in the Guardrail Trace.

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 inputAssessments(List<GuardrailAssessment>).

Parameters:

inputAssessments - 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:

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

metadata

GuardrailTrace.Builder metadata(Metadata metadata)

Contains information about the Guardrail output.

Parameters:

metadata - Contains information about the Guardrail output.

Returns:

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

metadata

default GuardrailTrace.Builder metadata(Consumer<Metadata.Builder> metadata)

Contains information about the Guardrail output.

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

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

Parameters:

metadata - a consumer that will call methods on Metadata.Builder

Returns:

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

See Also:

• metadata(Metadata)

outputAssessments

GuardrailTrace.Builder outputAssessments(Collection<GuardrailAssessment> outputAssessments)

The details of the output assessments used in the Guardrail Trace.

Parameters:

outputAssessments - The details of the output assessments used in the Guardrail Trace.

Returns:

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

outputAssessments

GuardrailTrace.Builder outputAssessments(GuardrailAssessment... outputAssessments)

The details of the output assessments used in the Guardrail Trace.

Parameters:

outputAssessments - The details of the output assessments used in the Guardrail Trace.

Returns:

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

outputAssessments

GuardrailTrace.Builder outputAssessments(Consumer<GuardrailAssessment.Builder>... outputAssessments)

The details of the output assessments used in the Guardrail Trace.

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 outputAssessments(List<GuardrailAssessment>).

Parameters:

outputAssessments - 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:

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

traceId

GuardrailTrace.Builder traceId(String traceId)

The details of the trace Id used in the Guardrail Trace.

Parameters:

traceId - The details of the trace Id used in the Guardrail Trace.

Returns:

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