com.amazonaws.services.apigateway.model

Class Model

java.lang.Object

com.amazonaws.services.apigateway.model.Model

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Model
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Model()

Method Summary

Modifier and Type	Method and Description
Model	clone()
boolean	equals(Object obj)
String	getContentType() The content-type for the model.
String	getDescription() The description of the model.
String	getId() The identifier for the model resource.
String	getName() The name of the model.
String	getSchema() The schema for the model.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setContentType(String contentType) The content-type for the model.
void	setDescription(String description) The description of the model.
void	setId(String id) The identifier for the model resource.
void	setName(String name) The name of the model.
void	setSchema(String schema) The schema for the model.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Model	withContentType(String contentType) The content-type for the model.
Model	withDescription(String description) The description of the model.
Model	withId(String id) The identifier for the model resource.
Model	withName(String name) The name of the model.
Model	withSchema(String schema) The schema for the model.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Model

public Model()

Method Detail

setId

public void setId(String id)

The identifier for the model resource.

Parameters:

id - The identifier for the model resource.

getId

public String getId()

The identifier for the model resource.

Returns:

The identifier for the model resource.

withId

public Model withId(String id)

The identifier for the model resource.

Parameters:

id - The identifier for the model resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

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

Parameters:

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

getName

public String getName()

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

Returns:

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

withName

public Model withName(String name)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The description of the model.

Parameters:

description - The description of the model.

getDescription

public String getDescription()

The description of the model.

Returns:

The description of the model.

withDescription

public Model withDescription(String description)

The description of the model.

Parameters:

description - The description of the model.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSchema

public void setSchema(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.

Parameters:

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.

getSchema

public String getSchema()

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.

withSchema

public Model withSchema(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setContentType

public void setContentType(String contentType)

The content-type for the model.

Parameters:

contentType - The content-type for the model.

getContentType

public String getContentType()

The content-type for the model.

Returns:

The content-type for the model.

withContentType

public Model withContentType(String contentType)

The content-type for the model.

Parameters:

contentType - The content-type for the model.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Model clone()

Overrides:

clone in class Object

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.