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

Class GuardrailTopic

java.lang.Object

software.amazon.awssdk.services.bedrock.model.GuardrailTopic

All Implemented Interfaces:

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

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

Details about topics for the guardrail to identify and deny.

This data type is used in the following API operations:

• GetGuardrail response body

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailTopic.Builder

Method Summary

Modifier and Type	Method	Description
static GuardrailTopic.Builder	builder()
String	definition()	A definition of the topic to deny.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	examples()	A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExamples()	For responses, this returns true if the service returned a value for the Examples property.
int	hashCode()
GuardrailTopicAction	inputAction()	The action to take when harmful content is detected in the input.
String	inputActionAsString()	The action to take when harmful content is detected in the input.
Boolean	inputEnabled()	Indicates whether guardrail evaluation is enabled on the input.
String	name()	The name of the topic to deny.
GuardrailTopicAction	outputAction()	The action to take when harmful content is detected in the output.
String	outputActionAsString()	The action to take when harmful content is detected in the output.
Boolean	outputEnabled()	Indicates whether guardrail evaluation is enabled on the output.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailTopic.Builder>	serializableBuilderClass()
GuardrailTopic.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
GuardrailTopicType	type()	Specifies to deny the topic.
String	typeAsString()	Specifies to deny the topic.

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

name

public final String name()

The name of the topic to deny.

Returns:

The name of the topic to deny.

definition

public final String definition()

A definition of the topic to deny.

Returns:

A definition of the topic to deny.

hasExamples

public final boolean hasExamples()

For responses, this returns true if the service returned a value for the Examples property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

examples

public final List<String> examples()

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExamples() method.

Returns:

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

type

public final GuardrailTopicType type()

Specifies to deny the topic.

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

Returns:

Specifies to deny the topic.

See Also:

GuardrailTopicType

typeAsString

public final String typeAsString()

Specifies to deny the topic.

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

Returns:

Specifies to deny the topic.

See Also:

GuardrailTopicType

inputAction

public final GuardrailTopicAction inputAction()

The action to take when harmful content is detected in the input. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• NONE – Take no action but return detection information in the trace response.

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

Returns:

The action to take when harmful content is detected in the input. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• NONE – Take no action but return detection information in the trace response.

See Also:

GuardrailTopicAction

inputActionAsString

public final String inputActionAsString()

The action to take when harmful content is detected in the input. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• NONE – Take no action but return detection information in the trace response.

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

Returns:

The action to take when harmful content is detected in the input. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• NONE – Take no action but return detection information in the trace response.

See Also:

GuardrailTopicAction

outputAction

public final GuardrailTopicAction outputAction()

The action to take when harmful content is detected in the output. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• NONE – Take no action but return detection information in the trace response.

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

Returns:

The action to take when harmful content is detected in the output. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• NONE – Take no action but return detection information in the trace response.

See Also:

GuardrailTopicAction

outputActionAsString

public final String outputActionAsString()

The action to take when harmful content is detected in the output. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• NONE – Take no action but return detection information in the trace response.

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

Returns:

The action to take when harmful content is detected in the output. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• NONE – Take no action but return detection information in the trace response.

See Also:

GuardrailTopicAction

inputEnabled

public final Boolean inputEnabled()

Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

Returns:

Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

outputEnabled

public final Boolean outputEnabled()

Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

Returns:

Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

toBuilder

public GuardrailTopic.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailTopic.Builder,GuardrailTopic>

builder

public static GuardrailTopic.Builder builder()

serializableBuilderClass

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