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

Class GuardrailContentFilter

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.GuardrailContentFilter

All Implemented Interfaces:

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

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

The content filter for a guardrail.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailContentFilter.Builder

Method Summary

Modifier and Type	Method	Description
GuardrailContentPolicyAction	action()	The guardrail action.
String	actionAsString()	The guardrail action.
static GuardrailContentFilter.Builder	builder()
GuardrailContentFilterConfidence	confidence()	The guardrail confidence.
String	confidenceAsString()	The guardrail confidence.
Boolean	detected()	Indicates whether content that breaches the guardrail configuration is detected.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
GuardrailContentFilterStrength	filterStrength()	The filter strength setting for the guardrail content filter.
String	filterStrengthAsString()	The filter strength setting for the guardrail content filter.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailContentFilter.Builder>	serializableBuilderClass()
GuardrailContentFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
GuardrailContentFilterType	type()	The guardrail type.
String	typeAsString()	The guardrail type.

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

type

public final GuardrailContentFilterType type()

The guardrail type.

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

Returns:

The guardrail type.

See Also:

GuardrailContentFilterType

typeAsString

public final String typeAsString()

The guardrail type.

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

Returns:

The guardrail type.

See Also:

GuardrailContentFilterType

confidence

public final GuardrailContentFilterConfidence confidence()

The guardrail confidence.

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

Returns:

The guardrail confidence.

See Also:

GuardrailContentFilterConfidence

confidenceAsString

public final String confidenceAsString()

The guardrail confidence.

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

Returns:

The guardrail confidence.

See Also:

GuardrailContentFilterConfidence

filterStrength

public final GuardrailContentFilterStrength filterStrength()

The filter strength setting for the guardrail content filter.

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

Returns:

The filter strength setting for the guardrail content filter.

See Also:

GuardrailContentFilterStrength

filterStrengthAsString

public final String filterStrengthAsString()

The filter strength setting for the guardrail content filter.

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

Returns:

The filter strength setting for the guardrail content filter.

See Also:

GuardrailContentFilterStrength

action

public final GuardrailContentPolicyAction action()

The guardrail action.

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

Returns:

The guardrail action.

See Also:

GuardrailContentPolicyAction

actionAsString

public final String actionAsString()

The guardrail action.

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

Returns:

The guardrail action.

See Also:

GuardrailContentPolicyAction

detected

public final Boolean detected()

Indicates whether content that breaches the guardrail configuration is detected.

Returns:

Indicates whether content that breaches the guardrail configuration is detected.

toBuilder

public GuardrailContentFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailContentFilter.Builder,GuardrailContentFilter>

builder

public static GuardrailContentFilter.Builder builder()

serializableBuilderClass

public static Class<? extends GuardrailContentFilter.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