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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfacestatic enum -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static OutputFormatStructurefromJsonSchema(Consumer<JsonSchemaDefinition.Builder> jsonSchema) Create an instance of this class withjsonSchema()initialized to the given value.static OutputFormatStructurefromJsonSchema(JsonSchemaDefinition jsonSchema) Create an instance of this class withjsonSchema()initialized to the given value.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final JsonSchemaDefinitionA JSON schema structure that the model's output must adhere to.static Class<? extends OutputFormatStructure.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.type()Retrieve an enum value representing which member of this object is populated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<OutputFormatStructure.Builder,OutputFormatStructure> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
fromJsonSchema
Create an instance of this class withjsonSchema()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 withjsonSchema()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
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beOutputFormatStructure.Type.UNKNOWN_TO_SDK_VERSIONif 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 beOutputFormatStructure.Type.UNKNOWN_TO_SDK_VERSIONif zero members are set, andnullif more than one member is set. -
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-