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

Class GuardrailContentFilter

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.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>

Details of the content filter used in the 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 action placed on the content by the Guardrail filter.
String	actionAsString()	The action placed on the content by the Guardrail filter.
static GuardrailContentFilter.Builder	builder()
GuardrailContentFilterConfidence	confidence()	The confidence level regarding the content detected in the filter by the Guardrail.
String	confidenceAsString()	The confidence level regarding the content detected in the filter by the Guardrail.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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 type of content detected in the filter by the Guardrail.
String	typeAsString()	The type of content detected in the filter by 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

action

public final GuardrailContentPolicyAction action()

The action placed on the content by the Guardrail filter.

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 action placed on the content by the Guardrail filter.

See Also:

GuardrailContentPolicyAction

actionAsString

public final String actionAsString()

The action placed on the content by the Guardrail filter.

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 action placed on the content by the Guardrail filter.

See Also:

GuardrailContentPolicyAction

confidence

public final GuardrailContentFilterConfidence confidence()

The confidence level regarding the content detected in the filter by the Guardrail.

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 confidence level regarding the content detected in the filter by the Guardrail.

See Also:

GuardrailContentFilterConfidence

confidenceAsString

public final String confidenceAsString()

The confidence level regarding the content detected in the filter by the Guardrail.

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 confidence level regarding the content detected in the filter by the Guardrail.

See Also:

GuardrailContentFilterConfidence

type

public final GuardrailContentFilterType type()

The type of content detected in the filter by the Guardrail.

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 type of content detected in the filter by the Guardrail.

See Also:

GuardrailContentFilterType

typeAsString

public final String typeAsString()

The type of content detected in the filter by the Guardrail.

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 type of content detected in the filter by the Guardrail.

See Also:

GuardrailContentFilterType

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