CreateRestApiRequest (AWS SDK for Java

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

Constructors
Constructor and Description
`CreateRestApiRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
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()` [Required] 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)` [Required] 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)` [Required] 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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateRestApiRequest
```
public CreateRestApiRequest()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    [Required] The name of the RestApi.
    
    Parameters:
    
    name - [Required] The name of the RestApi.
  - getName
```
public String getName()
```
    [Required] The name of the RestApi.
    
    Returns:
    
    [Required] The name of the RestApi.
  - withName
```
public CreateRestApiRequest withName(String name)
```
    [Required] The name of the RestApi.
    
    Parameters:
    
    name - [Required] 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 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.
    
    Parameters:
    
    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.
  - getMinimumCompressionSize
```
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.
    
    Returns:
    
    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.
  - withMinimumCompressionSize
```
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.
    
    Parameters:
    
    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.
    
    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 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.
    Parameters:
    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.
    See Also:
    
    ApiKeySourceType
  - getApiKeySource
```
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.
    Returns:
    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.
    See Also:
    
    ApiKeySourceType
  - withApiKeySource
```
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.
    Parameters:
    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.
    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 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.
    Parameters:
    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.
    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.
  - setPolicy
```
public void setPolicy(String policy)
```
    A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
    
    Parameters:
    
    policy - A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
  - getPolicy
```
public String getPolicy()
```
    A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
    
    Returns:
    
    A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
  - withPolicy
```
public CreateRestApiRequest withPolicy(String policy)
```
    A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
    
    Parameters:
    
    policy - A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
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.
    
    Returns:
    
    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.
  - setTags
```
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.
    
    Parameters:
    
    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.
  - withTags
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateRestApiRequest addTagsEntry(String key,
                                         String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateRestApiRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisableExecuteApiEndpoint
```
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.
    
    Parameters:
    
    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.
  - getDisableExecuteApiEndpoint
```
public 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.
    
    Returns:
    
    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.
  - withDisableExecuteApiEndpoint
```
public 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDisableExecuteApiEndpoint
```
public 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.
    
    Returns:
    
    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.
  - 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 CreateRestApiRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateRestApiRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateRestApiRequest

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setVersion

getVersion

withVersion

setCloneFrom

getCloneFrom

withCloneFrom

getBinaryMediaTypes

setBinaryMediaTypes

withBinaryMediaTypes

withBinaryMediaTypes

setMinimumCompressionSize

getMinimumCompressionSize

withMinimumCompressionSize

setApiKeySource

getApiKeySource

withApiKeySource

withApiKeySource

setEndpointConfiguration

getEndpointConfiguration

withEndpointConfiguration

setPolicy

getPolicy

withPolicy

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setDisableExecuteApiEndpoint

getDisableExecuteApiEndpoint

withDisableExecuteApiEndpoint

isDisableExecuteApiEndpoint

toString

equals

hashCode

clone