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

Class OutputFormat

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.OutputFormat

All Implemented Interfaces:

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

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

Structured output parameters to control the model's response.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OutputFormat.Builder

Method Summary

Modifier and Type	Method	Description
static OutputFormat.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends OutputFormat.Builder>	serializableBuilderClass()
final OutputFormatStructure	structure()	The structure that the model's output must adhere to.
OutputFormat.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
final OutputFormatType	type()	The type of structured output format.
final String	typeAsString()	The type of structured output format.

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

type

public final OutputFormatType type()

The type of structured output format.

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

Returns:

The type of structured output format.

See Also:

• OutputFormatType

typeAsString

public final String typeAsString()

The type of structured output format.

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

Returns:

The type of structured output format.

See Also:

• OutputFormatType

structure

public final OutputFormatStructure structure()

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

Returns:

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

toBuilder

public OutputFormat.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OutputFormat.Builder,OutputFormat>

builder

public static OutputFormat.Builder builder()

serializableBuilderClass

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