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

Class GuardrailConverseTextBlock

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.GuardrailConverseTextBlock

All Implemented Interfaces:

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

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

A text block that contains text that you want to assess with a guardrail. For more information, see GuardrailConverseContentBlock.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailConverseTextBlock.Builder

Method Summary

Modifier and Type	Method	Description
static GuardrailConverseTextBlock.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasQualifiers()	For responses, this returns true if the service returned a value for the Qualifiers property.
List<GuardrailConverseContentQualifier>	qualifiers()	The qualifier details for the guardrails contextual grounding filter.
List<String>	qualifiersAsStrings()	The qualifier details for the guardrails contextual grounding filter.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailConverseTextBlock.Builder>	serializableBuilderClass()
String	text()	The text that you want to guard.
GuardrailConverseTextBlock.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

text

public final String text()

The text that you want to guard.

Returns:

The text that you want to guard.

qualifiers

public final List<GuardrailConverseContentQualifier> qualifiers()

The qualifier details for the guardrails contextual grounding filter.

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 hasQualifiers() method.

Returns:

The qualifier details for the guardrails contextual grounding filter.

hasQualifiers

public final boolean hasQualifiers()

For responses, this returns true if the service returned a value for the Qualifiers 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.

qualifiersAsStrings

public final List<String> qualifiersAsStrings()

The qualifier details for the guardrails contextual grounding filter.

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 hasQualifiers() method.

Returns:

The qualifier details for the guardrails contextual grounding filter.

toBuilder

public GuardrailConverseTextBlock.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailConverseTextBlock.Builder,GuardrailConverseTextBlock>

builder

public static GuardrailConverseTextBlock.Builder builder()

serializableBuilderClass

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