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

Class OutputFormatStructure

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.OutputFormatStructure

All Implemented Interfaces:

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

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

The structure that the model's output must adhere to.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OutputFormatStructure.Builder
static enum	OutputFormatStructure.Type

Method Summary

Modifier and Type	Method	Description
static OutputFormatStructure.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
static OutputFormatStructure	fromJsonSchema(Consumer<JsonSchemaDefinition.Builder> jsonSchema)	Create an instance of this class with jsonSchema() initialized to the given value.
static OutputFormatStructure	fromJsonSchema(JsonSchemaDefinition jsonSchema)	Create an instance of this class with jsonSchema() initialized to the given value.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final JsonSchemaDefinition	jsonSchema()	A JSON schema structure that the model's output must adhere to.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends OutputFormatStructure.Builder>	serializableBuilderClass()
OutputFormatStructure.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
OutputFormatStructure.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 Details

jsonSchema

public final JsonSchemaDefinition jsonSchema()

A JSON schema structure that the model's output must adhere to.

Returns:

A JSON schema structure that the model's output must adhere to.

toBuilder

public OutputFormatStructure.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OutputFormatStructure.Builder,OutputFormatStructure>

builder

public static OutputFormatStructure.Builder builder()

serializableBuilderClass

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

fromJsonSchema

public static OutputFormatStructure fromJsonSchema(JsonSchemaDefinition jsonSchema)

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

A JSON schema structure that the model's output must adhere to.

Parameters:

jsonSchema - A JSON schema structure that the model's output must adhere to.

fromJsonSchema

public static OutputFormatStructure fromJsonSchema(Consumer<JsonSchemaDefinition.Builder> jsonSchema)

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

A JSON schema structure that the model's output must adhere to.

Parameters:

jsonSchema - A JSON schema structure that the model's output must adhere to.

type

public OutputFormatStructure.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 OutputFormatStructure.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 OutputFormatStructure.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