com.amazonaws.services.apigateway.model

Class CreateRestApiRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.CreateRestApiRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

The POST Request to add a new RestApi resource to your collection.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateRestApiRequest()

Method Summary

Modifier and Type	Method and Description
CreateRestApiRequest	clone()
boolean	equals(Object obj)
String	getApiKeySource() The source of the API key for metring requests according to a usage plan.
List<String>	getBinaryMediaTypes() The list of binary media types supported by the RestApi.
String	getCloneFrom() The ID of the RestApi that you want to clone from.
String	getDescription() The description of the RestApi.
EndpointConfiguration	getEndpointConfiguration() The endpoint configuration of this RestApi showing the endpoint types of the API.
Integer	getMinimumCompressionSize() A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API.
String	getName() The name of the RestApi.
String	getVersion() A version identifier for the API.
int	hashCode()
void	setApiKeySource(String apiKeySource) The source of the API key for metring requests according to a usage plan.
void	setBinaryMediaTypes(Collection<String> binaryMediaTypes) The list of binary media types supported by the RestApi.
void	setCloneFrom(String cloneFrom) The ID of the RestApi that you want to clone from.
void	setDescription(String description) The description of the RestApi.
void	setEndpointConfiguration(EndpointConfiguration endpointConfiguration) The endpoint configuration of this RestApi showing the endpoint types of the API.
void	setMinimumCompressionSize(Integer minimumCompressionSize) A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API.
void	setName(String name) The name of the RestApi.
void	setVersion(String version) A version identifier for the API.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateRestApiRequest	withApiKeySource(ApiKeySourceType apiKeySource) The source of the API key for metring requests according to a usage plan.
CreateRestApiRequest	withApiKeySource(String apiKeySource) The source of the API key for metring requests according to a usage plan.
CreateRestApiRequest	withBinaryMediaTypes(Collection<String> binaryMediaTypes) The list of binary media types supported by the RestApi.
CreateRestApiRequest	withBinaryMediaTypes(String... binaryMediaTypes) The list of binary media types supported by the RestApi.
CreateRestApiRequest	withCloneFrom(String cloneFrom) The ID of the RestApi that you want to clone from.
CreateRestApiRequest	withDescription(String description) The description of the RestApi.
CreateRestApiRequest	withEndpointConfiguration(EndpointConfiguration endpointConfiguration) The endpoint configuration of this RestApi showing the endpoint types of the API.
CreateRestApiRequest	withMinimumCompressionSize(Integer minimumCompressionSize) A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API.
CreateRestApiRequest	withName(String name) The name of the RestApi.
CreateRestApiRequest	withVersion(String version) A version identifier for the API.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateRestApiRequest

public CreateRestApiRequest()

Method Detail

setName

public void setName(String name)

The name of the RestApi.

Parameters:

name - The name of the RestApi.

getName

public String getName()

The name of the RestApi.

Returns:

The name of the RestApi.

withName

public CreateRestApiRequest withName(String name)

The name of the RestApi.

Parameters:

name - The name of the RestApi.

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

Parameters:

description - The description of the RestApi.

getDescription

public String getDescription()

The description of the RestApi.

Returns:

The description of the RestApi.

withDescription

public CreateRestApiRequest withDescription(String description)

The description of the RestApi.

Parameters:

description - The description of the RestApi.

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

setCloneFrom

public void setCloneFrom(String cloneFrom)

The ID of the RestApi that you want to clone from.

Parameters:

cloneFrom - The ID of the RestApi that you want to clone from.

getCloneFrom

public String getCloneFrom()

The ID of the RestApi that you want to clone from.

Returns:

The ID of the RestApi that you want to clone from.

withCloneFrom

public CreateRestApiRequest withCloneFrom(String cloneFrom)

The ID of the RestApi that you want to clone from.

Parameters:

cloneFrom - The ID of the RestApi that you want to clone from.

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

setMinimumCompressionSize

public void setMinimumCompressionSize(Integer minimumCompressionSize)

A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API. When compression is enabled, compression or decompression are not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Parameters:

minimumCompressionSize - A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API. When compression is enabled, compression or decompression are not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

getMinimumCompressionSize

public Integer getMinimumCompressionSize()

A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API. When compression is enabled, compression or decompression are not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Returns:

A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API. When compression is enabled, compression or decompression are not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

withMinimumCompressionSize

public CreateRestApiRequest withMinimumCompressionSize(Integer minimumCompressionSize)

A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API. When compression is enabled, compression or decompression are not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Parameters:

minimumCompressionSize - A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API. When compression is enabled, compression or decompression are not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Returns:

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

setApiKeySource

public void setApiKeySource(String apiKeySource)

The source of the API key for metring requests according to a usage plan. Valid values are

• HEADER to read the API key from the X-API-Key header of a request.
• AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Parameters:

apiKeySource - The source of the API key for metring requests according to a usage plan. Valid values are

• HEADER to read the API key from the X-API-Key header of a request.
• AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

See Also:

ApiKeySourceType

getApiKeySource

public String getApiKeySource()

The source of the API key for metring requests according to a usage plan. Valid values are

• HEADER to read the API key from the X-API-Key header of a request.
• AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Returns:

The source of the API key for metring requests according to a usage plan. Valid values are

• HEADER to read the API key from the X-API-Key header of a request.
• AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

See Also:

ApiKeySourceType

withApiKeySource

public CreateRestApiRequest withApiKeySource(String apiKeySource)

The source of the API key for metring requests according to a usage plan. Valid values are

• HEADER to read the API key from the X-API-Key header of a request.
• AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Parameters:

apiKeySource - The source of the API key for metring requests according to a usage plan. Valid values are

• HEADER to read the API key from the X-API-Key header of a request.
• AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Returns:

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

See Also:

ApiKeySourceType

withApiKeySource

public CreateRestApiRequest withApiKeySource(ApiKeySourceType apiKeySource)

The source of the API key for metring requests according to a usage plan. Valid values are

• HEADER to read the API key from the X-API-Key header of a request.
• AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Parameters:

apiKeySource - The source of the API key for metring requests according to a usage plan. Valid values are

• HEADER to read the API key from the X-API-Key header of a request.
• AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Returns:

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

See Also:

ApiKeySourceType

setEndpointConfiguration

public void setEndpointConfiguration(EndpointConfiguration endpointConfiguration)

The endpoint configuration of this RestApi showing the endpoint types of the API.

Parameters:

endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.

getEndpointConfiguration

public EndpointConfiguration getEndpointConfiguration()

The endpoint configuration of this RestApi showing the endpoint types of the API.

Returns:

The endpoint configuration of this RestApi showing the endpoint types of the API.

withEndpointConfiguration

public CreateRestApiRequest withEndpointConfiguration(EndpointConfiguration endpointConfiguration)

The endpoint configuration of this RestApi showing the endpoint types of the API.

Parameters:

endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.

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

Overrides:

clone in class AmazonWebServiceRequest