com.amazonaws.services.apigatewayv2.model

Class Model

java.lang.Object

com.amazonaws.services.apigatewayv2.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 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

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, for example, "application/json".
String	getDescription() The description of the model.
String	getModelId() The model identifier.
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, for example, "application/json".
void	setDescription(String description) The description of the model.
void	setModelId(String modelId) The model identifier.
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.
Model	withContentType(String contentType) The content-type for the model, for example, "application/json".
Model	withDescription(String description) The description of the model.
Model	withModelId(String modelId) The model identifier.
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

setContentType

public void setContentType(String contentType)

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

Parameters:

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

getContentType

public String getContentType()

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

Returns:

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

withContentType

public Model withContentType(String contentType)

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

Parameters:

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

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.

setModelId

public void setModelId(String modelId)

The model identifier.

Parameters:

modelId - The model identifier.

getModelId

public String getModelId()

The model identifier.

Returns:

The model identifier.

withModelId

public Model withModelId(String modelId)

The model identifier.

Parameters:

modelId - The model identifier.

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 alphanumeric.

Parameters:

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

getName

public String getName()

The name of the model. Must be alphanumeric.

Returns:

The name of the model. Must be alphanumeric.

withName

public Model withName(String name)

The name of the model. Must be alphanumeric.

Parameters:

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

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 4 model.

Parameters:

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

getSchema

public String getSchema()

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.

withSchema

public Model withSchema(String schema)

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

Parameters:

schema - The schema for the model. For application/json models, this should be JSON schema draft 4 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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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.