@Generated(value="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.
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.
Modifier and Type | Class and Description |
---|---|
static interface |
Model.Builder |
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) |
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 |
id()
The identifier for the model resource.
|
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.
|
copy
public final String id()
The identifier for the model resource.
public final String name()
The name of the model. Must be an alphanumeric string.
public final String description()
The description of the model.
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.
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.public final String contentType()
The content-type for the model.
public Model.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Model.Builder,Model>
public static Model.Builder builder()
public static Class<? extends Model.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()