Package software.amazon.awssdk.services.apigateway.model

Class Model

java.lang.Object

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

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Model.Builder

Method Summary

Modifier and Type	Method	Description
static Model.Builder	builder()
String	contentType()	The content-type for the model.
String	description()	The description of the model.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The identifier for the model resource.
String	name()	The name of the model.
String	schema()	The schema for the model.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Model.Builder>	serializableBuilderClass()
Model.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

id

public final String id()

The identifier for the model resource.

Returns:

The identifier for the model resource.

name

public final 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 final String description()

The description of the model.

Returns:

The description of the model.

schema

public final String schema()

The schema for the model. For application/json models, this should be JSON schema draft 4 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 4 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 final String contentType()

The content-type for the model.

Returns:

The content-type for the model.

toBuilder

public Model.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Model.Builder,Model>

builder

public static Model.Builder builder()

serializableBuilderClass

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