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

Class JsonSchemaDefinition

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.JsonSchemaDefinition

All Implemented Interfaces:

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

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

JSON schema structured output format options.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JsonSchemaDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static JsonSchemaDefinition.Builder	builder()
final String	description()	A description of the JSON schema.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	name()	The name of the JSON schema.
final String	schema()	The JSON schema to constrain the model's output.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends JsonSchemaDefinition.Builder>	serializableBuilderClass()
JsonSchemaDefinition.Builder	toBuilder()
final 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 Details

schema

public final String schema()

The JSON schema to constrain the model's output. For more information, see JSON Schema Reference.

Returns:

The JSON schema to constrain the model's output. For more information, see JSON Schema Reference.

name

public final String name()

The name of the JSON schema.

Returns:

The name of the JSON schema.

description

public final String description()

A description of the JSON schema.

Returns:

A description of the JSON schema.

toBuilder

public JsonSchemaDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JsonSchemaDefinition.Builder,JsonSchemaDefinition>

builder

public static JsonSchemaDefinition.Builder builder()

serializableBuilderClass

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