Package software.amazon.awssdk.services.apigatewayv2.model

Class Model

java.lang.Object

software.amazon.awssdk.services.apigatewayv2.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 a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.

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, for example, "application/json".
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	modelId()	The model identifier.
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

contentType

public final String contentType()

The content-type for the model, for example, "application/json".

Returns:

The content-type for the model, for example, "application/json".

description

public final String description()

The description of the model.

Returns:

The description of the model.

modelId

public final String modelId()

The model identifier.

Returns:

The model identifier.

name

public final String name()

The name of the model. Must be alphanumeric.

Returns:

The name of the model. Must be alphanumeric.

schema

public final String schema()

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

Returns:

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