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(value="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 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, for example, "application/json".
String	description() The description of the model.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<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.
List<SdkField<?>>	sdkFields()
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() Returns a string representation of this object.

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

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()

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 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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.