@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.
NOOP
Constructor and Description |
---|
CreateRestApiRequest() |
Modifier and Type | Method and Description |
---|---|
CreateRestApiRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateRestApiRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateRestApiRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getApiKeySource()
The source of the API key for metering 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.
|
Boolean |
getDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default
execute-api endpoint. |
EndpointConfiguration |
getEndpointConfiguration()
The endpoint configuration of this RestApi showing the endpoint types of the API.
|
Integer |
getMinimumCompressionSize()
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes,
inclusive) or disable compression (with a null value) on an API.
|
String |
getName()
The name of the RestApi.
|
String |
getPolicy()
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method
configuration.
|
Map<String,String> |
getTags()
The key-value map of strings.
|
String |
getVersion()
A version identifier for the API.
|
int |
hashCode() |
Boolean |
isDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default
execute-api endpoint. |
void |
setApiKeySource(String apiKeySource)
The source of the API key for metering 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 |
setDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default
execute-api endpoint. |
void |
setEndpointConfiguration(EndpointConfiguration endpointConfiguration)
The endpoint configuration of this RestApi showing the endpoint types of the API.
|
void |
setMinimumCompressionSize(Integer minimumCompressionSize)
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes,
inclusive) or disable compression (with a null value) on an API.
|
void |
setName(String name)
The name of the RestApi.
|
void |
setPolicy(String policy)
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method
configuration.
|
void |
setTags(Map<String,String> tags)
The key-value map of strings.
|
void |
setVersion(String version)
A version identifier for the API.
|
String |
toString()
Returns a string representation of this object.
|
CreateRestApiRequest |
withApiKeySource(ApiKeySourceType apiKeySource)
The source of the API key for metering requests according to a usage plan.
|
CreateRestApiRequest |
withApiKeySource(String apiKeySource)
The source of the API key for metering 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 |
withDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default
execute-api endpoint. |
CreateRestApiRequest |
withEndpointConfiguration(EndpointConfiguration endpointConfiguration)
The endpoint configuration of this RestApi showing the endpoint types of the API.
|
CreateRestApiRequest |
withMinimumCompressionSize(Integer minimumCompressionSize)
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes,
inclusive) or disable compression (with a null value) on an API.
|
CreateRestApiRequest |
withName(String name)
The name of the RestApi.
|
CreateRestApiRequest |
withPolicy(String policy)
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method
configuration.
|
CreateRestApiRequest |
withTags(Map<String,String> tags)
The key-value map of strings.
|
CreateRestApiRequest |
withVersion(String version)
A version identifier for the API.
|
addHandlerContext, 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
public void setName(String name)
The name of the RestApi.
name
- The name of the RestApi.public String getName()
The name of the RestApi.
public CreateRestApiRequest withName(String name)
The name of the RestApi.
name
- The name of the RestApi.public void setDescription(String description)
The description of the RestApi.
description
- The description of the RestApi.public String getDescription()
The description of the RestApi.
public CreateRestApiRequest withDescription(String description)
The description of the RestApi.
description
- The description of the RestApi.public void setVersion(String version)
A version identifier for the API.
version
- A version identifier for the API.public String getVersion()
A version identifier for the API.
public CreateRestApiRequest withVersion(String version)
A version identifier for the API.
version
- A version identifier for the API.public void setCloneFrom(String cloneFrom)
The ID of the RestApi that you want to clone from.
cloneFrom
- The ID of the RestApi that you want to clone from.public String getCloneFrom()
The ID of the RestApi that you want to clone from.
public CreateRestApiRequest withCloneFrom(String cloneFrom)
The ID of the RestApi that you want to clone from.
cloneFrom
- The ID of the RestApi that you want to clone from.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.
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.
binaryMediaTypes
- The list of binary media types supported by the RestApi. By default, the RestApi supports only
UTF-8-encoded text payloads.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.
binaryMediaTypes
- The list of binary media types supported by the RestApi. By default, the RestApi supports only
UTF-8-encoded text payloads.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.
binaryMediaTypes
- The list of binary media types supported by the RestApi. By default, the RestApi supports only
UTF-8-encoded text payloads.public void setMinimumCompressionSize(Integer minimumCompressionSize)
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
minimumCompressionSize
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M)
bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled,
compression or decompression is not applied on the payload if the payload size is smaller than this value.
Setting it to zero allows compression for any payload size.public Integer getMinimumCompressionSize()
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
public CreateRestApiRequest withMinimumCompressionSize(Integer minimumCompressionSize)
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
minimumCompressionSize
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M)
bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled,
compression or decompression is not applied on the payload if the payload size is smaller than this value.
Setting it to zero allows compression for any payload size.public void setApiKeySource(String apiKeySource)
The source of the API key for metering 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.
apiKeySource
- The source of the API key for metering 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.ApiKeySourceType
public String getApiKeySource()
The source of the API key for metering 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.
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.ApiKeySourceType
public CreateRestApiRequest withApiKeySource(String apiKeySource)
The source of the API key for metering 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.
apiKeySource
- The source of the API key for metering 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.ApiKeySourceType
public CreateRestApiRequest withApiKeySource(ApiKeySourceType apiKeySource)
The source of the API key for metering 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.
apiKeySource
- The source of the API key for metering 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.ApiKeySourceType
public void setEndpointConfiguration(EndpointConfiguration endpointConfiguration)
The endpoint configuration of this RestApi showing the endpoint types of the API.
endpointConfiguration
- The endpoint configuration of this RestApi showing the endpoint types of the API.public EndpointConfiguration getEndpointConfiguration()
The endpoint configuration of this RestApi showing the endpoint types of the API.
public CreateRestApiRequest withEndpointConfiguration(EndpointConfiguration endpointConfiguration)
The endpoint configuration of this RestApi showing the endpoint types of the API.
endpointConfiguration
- The endpoint configuration of this RestApi showing the endpoint types of the API.public void setPolicy(String policy)
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
policy
- A stringified JSON policy document that applies to this RestApi regardless of the caller and Method
configuration.public String getPolicy()
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
public CreateRestApiRequest withPolicy(String policy)
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
policy
- A stringified JSON policy document that applies to this RestApi regardless of the caller and Method
configuration.public Map<String,String> getTags()
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters
and must not start with aws:
. The tag value can be up to 256 characters.
aws:
. The tag value can be up to 256 characters.public void setTags(Map<String,String> tags)
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters
and must not start with aws:
. The tag value can be up to 256 characters.
tags
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128
characters and must not start with aws:
. The tag value can be up to 256 characters.public CreateRestApiRequest withTags(Map<String,String> tags)
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters
and must not start with aws:
. The tag value can be up to 256 characters.
tags
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128
characters and must not start with aws:
. The tag value can be up to 256 characters.public CreateRestApiRequest addTagsEntry(String key, String value)
public CreateRestApiRequest clearTagsEntries()
public void setDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default execute-api
endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
disableExecuteApiEndpoint
- Specifies whether clients can invoke your API by using the default execute-api
endpoint. By
default, clients can invoke your API with the default
https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a
custom domain name to invoke your API, disable the default endpointpublic Boolean getDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default execute-api
endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
execute-api
endpoint. By
default, clients can invoke your API with the default
https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a
custom domain name to invoke your API, disable the default endpointpublic CreateRestApiRequest withDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default execute-api
endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
disableExecuteApiEndpoint
- Specifies whether clients can invoke your API by using the default execute-api
endpoint. By
default, clients can invoke your API with the default
https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a
custom domain name to invoke your API, disable the default endpointpublic Boolean isDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default execute-api
endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
execute-api
endpoint. By
default, clients can invoke your API with the default
https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a
custom domain name to invoke your API, disable the default endpointpublic String toString()
toString
in class Object
Object.toString()
public CreateRestApiRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()