com.amazonaws.services.apigateway.model

Class CreateRestApiResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.apigateway.model.CreateRestApiResult

All Implemented Interfaces:

Serializable, Cloneable

public class CreateRestApiResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Represents a REST API.

Create an API

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateRestApiResult()

Method Summary

Modifier and Type	Method and Description
CreateRestApiResult	clone()
boolean	equals(Object obj)
List<String>	getBinaryMediaTypes() The list of binary media types supported by the RestApi.
Date	getCreatedDate() The date when the API was created, in ISO 8601 format.
String	getDescription() The API's description.
String	getId() The API's identifier.
String	getName() The API's name.
String	getVersion() A version identifier for the API.
List<String>	getWarnings() The warning messages reported when failonwarnings is turned on during API import.
int	hashCode()
void	setBinaryMediaTypes(Collection<String> binaryMediaTypes) The list of binary media types supported by the RestApi.
void	setCreatedDate(Date createdDate) The date when the API was created, in ISO 8601 format.
void	setDescription(String description) The API's description.
void	setId(String id) The API's identifier.
void	setName(String name) The API's name.
void	setVersion(String version) A version identifier for the API.
void	setWarnings(Collection<String> warnings) The warning messages reported when failonwarnings is turned on during API import.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateRestApiResult	withBinaryMediaTypes(Collection<String> binaryMediaTypes) The list of binary media types supported by the RestApi.
CreateRestApiResult	withBinaryMediaTypes(String... binaryMediaTypes) The list of binary media types supported by the RestApi.
CreateRestApiResult	withCreatedDate(Date createdDate) The date when the API was created, in ISO 8601 format.
CreateRestApiResult	withDescription(String description) The API's description.
CreateRestApiResult	withId(String id) The API's identifier.
CreateRestApiResult	withName(String name) The API's name.
CreateRestApiResult	withVersion(String version) A version identifier for the API.
CreateRestApiResult	withWarnings(Collection<String> warnings) The warning messages reported when failonwarnings is turned on during API import.
CreateRestApiResult	withWarnings(String... warnings) The warning messages reported when failonwarnings is turned on during API import.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateRestApiResult

public CreateRestApiResult()

Method Detail

setId

public void setId(String id)

The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.

Parameters:

id - The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.

getId

public String getId()

The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.

Returns:

The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.

withId

public CreateRestApiResult withId(String id)

The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.

Parameters:

id - The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.

Returns:

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

setName

public void setName(String name)

The API's name.

Parameters:

name - The API's name.

getName

public String getName()

The API's name.

Returns:

The API's name.

withName

public CreateRestApiResult withName(String name)

The API's name.

Parameters:

name - The API's name.

Returns:

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

setDescription

public void setDescription(String description)

The API's description.

Parameters:

description - The API's description.

getDescription

public String getDescription()

The API's description.

Returns:

The API's description.

withDescription

public CreateRestApiResult withDescription(String description)

The API's description.

Parameters:

description - The API's description.

Returns:

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

setCreatedDate

public void setCreatedDate(Date createdDate)

The date when the API was created, in ISO 8601 format.

Parameters:

createdDate - The date when the API was created, in ISO 8601 format.

getCreatedDate

public Date getCreatedDate()

The date when the API was created, in ISO 8601 format.

Returns:

The date when the API was created, in ISO 8601 format.

withCreatedDate

public CreateRestApiResult withCreatedDate(Date createdDate)

The date when the API was created, in ISO 8601 format.

Parameters:

createdDate - The date when the API was created, in ISO 8601 format.

Returns:

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

setVersion

public void setVersion(String version)

A version identifier for the API.

Parameters:

version - A version identifier for the API.

getVersion

public String getVersion()

A version identifier for the API.

Returns:

A version identifier for the API.

withVersion

public CreateRestApiResult withVersion(String version)

A version identifier for the API.

Parameters:

version - A version identifier for the API.

Returns:

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

getWarnings

public List<String> getWarnings()

The warning messages reported when failonwarnings is turned on during API import.

Returns:

The warning messages reported when failonwarnings is turned on during API import.

setWarnings

public void setWarnings(Collection<String> warnings)

The warning messages reported when failonwarnings is turned on during API import.

Parameters:

warnings - The warning messages reported when failonwarnings is turned on during API import.

withWarnings

public CreateRestApiResult withWarnings(String... warnings)

The warning messages reported when failonwarnings is turned on during API import.

NOTE: This method appends the values to the existing list (if any). Use setWarnings(java.util.Collection) or withWarnings(java.util.Collection) if you want to override the existing values.

Parameters:

warnings - The warning messages reported when failonwarnings is turned on during API import.

Returns:

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

withWarnings

public CreateRestApiResult withWarnings(Collection<String> warnings)

The warning messages reported when failonwarnings is turned on during API import.

Parameters:

warnings - The warning messages reported when failonwarnings is turned on during API import.

Returns:

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

getBinaryMediaTypes

public List<String> getBinaryMediaTypes()

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Returns:

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

setBinaryMediaTypes

public void setBinaryMediaTypes(Collection<String> binaryMediaTypes)

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Parameters:

binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

withBinaryMediaTypes

public CreateRestApiResult withBinaryMediaTypes(String... binaryMediaTypes)

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

NOTE: This method appends the values to the existing list (if any). Use setBinaryMediaTypes(java.util.Collection) or withBinaryMediaTypes(java.util.Collection) if you want to override the existing values.

Parameters:

binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Returns:

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

withBinaryMediaTypes

public CreateRestApiResult withBinaryMediaTypes(Collection<String> binaryMediaTypes)

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Parameters:

binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

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

Overrides:

clone in class Object