software.amazon.awssdk.services.apigateway.model

Class Model

java.lang.Object

software.amazon.awssdk.services.apigateway.model.Model

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Model.Builder,Model>

@Generated(value="software.amazon.awssdk:codegen")
public final class Model
extends Object
implements StructuredPojo, ToCopyableBuilder<Model.Builder,Model>

Represents the data structure of a method's request or response payload.

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.

A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

Method, MethodResponse, Models and Mappings

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Model.Builder

Method Summary

Modifier and Type	Method and Description
static Model.Builder	builder()
String	contentType() The content-type for the model.
String	description() The description of the model.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The identifier for the model resource.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	name() The name of the model.
String	schema() The schema for the model.
static Class<? extends Model.Builder>	serializableBuilderClass()
Model.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public String id()

The identifier for the model resource.

Returns:

The identifier for the model resource.

name

public String name()

The name of the model. Must be an alphanumeric string.

Returns:

The name of the model. Must be an alphanumeric string.

description

public String description()

The description of the model.

Returns:

The description of the model.

schema

public String schema()

The schema for the model. For application/json models, this should be JSON-schema draft v4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Returns:

The schema for the model. For application/json models, this should be JSON-schema draft v4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

contentType

public String contentType()

The content-type for the model.

Returns:

The content-type for the model.

toBuilder

public Model.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Model.Builder,Model>

Returns:

a builder for type T

builder

public static Model.Builder builder()

serializableBuilderClass

public static Class<? extends Model.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.