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

Class GuardrailStreamConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.GuardrailStreamConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GuardrailStreamConfiguration.Builder,GuardrailStreamConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class GuardrailStreamConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GuardrailStreamConfiguration.Builder,GuardrailStreamConfiguration>

Configuration information for a guardrail that you use with the ConverseStream action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailStreamConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static GuardrailStreamConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	guardrailIdentifier()	The identifier for the guardrail.
String	guardrailVersion()	The version of the guardrail.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailStreamConfiguration.Builder>	serializableBuilderClass()
GuardrailStreamProcessingMode	streamProcessingMode()	The processing mode.
String	streamProcessingModeAsString()	The processing mode.
GuardrailStreamConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
GuardrailTrace	trace()	The trace behavior for the guardrail.
String	traceAsString()	The trace behavior for the guardrail.

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 identifier for the guardrail.

Returns:

The identifier for the guardrail.

guardrailVersion

public final String guardrailVersion()

The version of the guardrail.

Returns:

The version of the guardrail.

trace

public final GuardrailTrace trace()

The trace behavior for the guardrail.

If the service returns an enum value that is not available in the current SDK version, trace will return GuardrailTrace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from traceAsString().

Returns:

The trace behavior for the guardrail.

See Also:

GuardrailTrace

traceAsString

public final String traceAsString()

The trace behavior for the guardrail.

If the service returns an enum value that is not available in the current SDK version, trace will return GuardrailTrace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from traceAsString().

Returns:

The trace behavior for the guardrail.

See Also:

GuardrailTrace

streamProcessingMode

public final GuardrailStreamProcessingMode streamProcessingMode()

The processing mode.

The processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.

If the service returns an enum value that is not available in the current SDK version, streamProcessingMode will return GuardrailStreamProcessingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamProcessingModeAsString().

Returns:

The processing mode.

The processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.

See Also:

GuardrailStreamProcessingMode

streamProcessingModeAsString

public final String streamProcessingModeAsString()

The processing mode.

The processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.

If the service returns an enum value that is not available in the current SDK version, streamProcessingMode will return GuardrailStreamProcessingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamProcessingModeAsString().

Returns:

The processing mode.

The processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.

See Also:

GuardrailStreamProcessingMode

toBuilder

public GuardrailStreamConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailStreamConfiguration.Builder,GuardrailStreamConfiguration>

builder

public static GuardrailStreamConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends GuardrailStreamConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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