Package software.amazon.awssdk.services.bedrockagentruntime.model

Class APISchema

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.APISchema

All Implemented Interfaces:

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

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

Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static APISchema.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static APISchema	fromPayload(String payload)	Create an instance of this class with payload() initialized to the given value.
static APISchema	fromS3(Consumer<S3Identifier.Builder> s3)	Create an instance of this class with s3() initialized to the given value.
static APISchema	fromS3(S3Identifier s3)	Create an instance of this class with s3() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	payload()	The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
S3Identifier	s3()	Contains details about the S3 object containing the OpenAPI schema for the action group.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends APISchema.Builder>	serializableBuilderClass()
APISchema.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
APISchema.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

payload

public final String payload()

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.

Returns:

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.

s3

public final S3Identifier s3()

Contains details about the S3 object containing the OpenAPI schema for the action group.

Returns:

Contains details about the S3 object containing the OpenAPI schema for the action group.

toBuilder

public APISchema.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<APISchema.Builder,APISchema>

builder

public static APISchema.Builder builder()

serializableBuilderClass

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

fromPayload

public static APISchema fromPayload(String payload)

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

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.

Parameters:

payload - The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.

fromS3

public static APISchema fromS3(S3Identifier s3)

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

Contains details about the S3 object containing the OpenAPI schema for the action group.

Parameters:

s3 - Contains details about the S3 object containing the OpenAPI schema for the action group.

fromS3

public static APISchema fromS3(Consumer<S3Identifier.Builder> s3)

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

Contains details about the S3 object containing the OpenAPI schema for the action group.

Parameters:

s3 - Contains details about the S3 object containing the OpenAPI schema for the action group.

type

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