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

Class GuardrailConverseContentBlock

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.GuardrailConverseContentBlock

All Implemented Interfaces:

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

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

A content block for selective guarding with the Converse or ConverseStream API operations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailConverseContentBlock.Builder
static class	GuardrailConverseContentBlock.Type

Method Summary

Modifier and Type	Method	Description
static GuardrailConverseContentBlock.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static GuardrailConverseContentBlock	fromImage(Consumer<GuardrailConverseImageBlock.Builder> image)	Create an instance of this class with image() initialized to the given value.
static GuardrailConverseContentBlock	fromImage(GuardrailConverseImageBlock image)	Create an instance of this class with image() initialized to the given value.
static GuardrailConverseContentBlock	fromText(Consumer<GuardrailConverseTextBlock.Builder> text)	Create an instance of this class with text() initialized to the given value.
static GuardrailConverseContentBlock	fromText(GuardrailConverseTextBlock text)	Create an instance of this class with text() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
GuardrailConverseImageBlock	image()	Image within converse content block to be evaluated by the guardrail.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailConverseContentBlock.Builder>	serializableBuilderClass()
GuardrailConverseTextBlock	text()	The text to guard.
GuardrailConverseContentBlock.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
GuardrailConverseContentBlock.Type	type()	Retrieve an enum value representing which member of this object is populated.

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 GuardrailConverseTextBlock text()

The text to guard.

Returns:

The text to guard.

image

public final GuardrailConverseImageBlock image()

Image within converse content block to be evaluated by the guardrail.

Returns:

Image within converse content block to be evaluated by the guardrail.

toBuilder

public GuardrailConverseContentBlock.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailConverseContentBlock.Builder,GuardrailConverseContentBlock>

builder

public static GuardrailConverseContentBlock.Builder builder()

serializableBuilderClass

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

fromText

public static GuardrailConverseContentBlock fromText(GuardrailConverseTextBlock text)

Create an instance of this class with text() initialized to the given value.

The text to guard.

Parameters:

text - The text to guard.

fromText

public static GuardrailConverseContentBlock fromText(Consumer<GuardrailConverseTextBlock.Builder> text)

Create an instance of this class with text() initialized to the given value.

The text to guard.

Parameters:

text - The text to guard.

fromImage

public static GuardrailConverseContentBlock fromImage(GuardrailConverseImageBlock image)

Create an instance of this class with image() initialized to the given value.

Image within converse content block to be evaluated by the guardrail.

Parameters:

image - Image within converse content block to be evaluated by the guardrail.

fromImage

public static GuardrailConverseContentBlock fromImage(Consumer<GuardrailConverseImageBlock.Builder> image)

Create an instance of this class with image() initialized to the given value.

Image within converse content block to be evaluated by the guardrail.

Parameters:

image - Image within converse content block to be evaluated by the guardrail.

type

public GuardrailConverseContentBlock.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be GuardrailConverseContentBlock.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be GuardrailConverseContentBlock.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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