CreateRestApiResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.apigateway.model.CreateRestApiResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateRestApiResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Represents a REST API.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateRestApiResult()

Constructors
Constructor and Description
`CreateRestApiResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateRestApiResult`	`addTagsEntry(String key, String value)` Add a single Tags entry
`CreateRestApiResult`	`clearTagsEntries()` Removes all the entries added into Tags.
`CreateRestApiResult`	`clone()`
`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.
`Date`	`getCreatedDate()` The timestamp when the API was created.
`String`	`getDescription()` The API's description.
`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.
`String`	`getId()` The API's identifier.
`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 API's name.
`String`	`getPolicy()` A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
`String`	`getRootResourceId()` The API's root resource ID.
`Map<String,String>`	`getTags()` The collection of tags.
`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()`
`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`	`setCreatedDate(Date createdDate)` The timestamp when the API was created.
`void`	`setDescription(String description)` The API's description.
`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`	`setId(String id)` The API's identifier.
`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 API's name.
`void`	`setPolicy(String policy)` A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
`void`	`setRootResourceId(String rootResourceId)` The API's root resource ID.
`void`	`setTags(Map<String,String> tags)` The collection of tags.
`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.
`CreateRestApiResult`	`withApiKeySource(ApiKeySourceType apiKeySource)` The source of the API key for metering requests according to a usage plan.
`CreateRestApiResult`	`withApiKeySource(String apiKeySource)` The source of the API key for metering requests according to a usage plan.
`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 timestamp when the API was created.
`CreateRestApiResult`	`withDescription(String description)` The API's description.
`CreateRestApiResult`	`withDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)` Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
`CreateRestApiResult`	`withEndpointConfiguration(EndpointConfiguration endpointConfiguration)` The endpoint configuration of this RestApi showing the endpoint types of the API.
`CreateRestApiResult`	`withId(String id)` The API's identifier.
`CreateRestApiResult`	`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.
`CreateRestApiResult`	`withName(String name)` The API's name.
`CreateRestApiResult`	`withPolicy(String policy)` A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
`CreateRestApiResult`	`withRootResourceId(String rootResourceId)` The API's root resource ID.
`CreateRestApiResult`	`withTags(Map<String,String> tags)` The collection of tags.
`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 API Gateway.
    
    Parameters:
    
    id - The API's identifier. This identifier is unique across all of your APIs in API Gateway.
  - getId
```
public String getId()
```
    The API's identifier. This identifier is unique across all of your APIs in API Gateway.
    
    Returns:
    
    The API's identifier. This identifier is unique across all of your APIs in API Gateway.
  - withId
```
public CreateRestApiResult withId(String id)
```
    The API's identifier. This identifier is unique across all of your APIs in API Gateway.
    
    Parameters:
    
    id - The API's identifier. This identifier is unique across all of your APIs in 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 timestamp when the API was created.
    
    Parameters:
    
    createdDate - The timestamp when the API was created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The timestamp when the API was created.
    
    Returns:
    
    The timestamp when the API was created.
  - withCreatedDate
```
public CreateRestApiResult withCreatedDate(Date createdDate)
```
    The timestamp when the API was created.
    
    Parameters:
    
    createdDate - The timestamp when the API was created.
    
    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.
  - 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 CreateRestApiResult 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 CreateRestApiResult 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 CreateRestApiResult 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 CreateRestApiResult 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 CreateRestApiResult 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 collection of tags. Each tag element is associated with a given resource.
    
    Returns:
    
    The collection of tags. Each tag element is associated with a given resource.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Parameters:
    
    tags - The collection of tags. Each tag element is associated with a given resource.
  - withTags
```
public CreateRestApiResult withTags(Map<String,String> tags)
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Parameters:
    
    tags - The collection of tags. Each tag element is associated with a given resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateRestApiResult addTagsEntry(String key,
                                        String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateRestApiResult 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 CreateRestApiResult 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.
  - setRootResourceId
```
public void setRootResourceId(String rootResourceId)
```
    The API's root resource ID.
    
    Parameters:
    
    rootResourceId - The API's root resource ID.
  - getRootResourceId
```
public String getRootResourceId()
```
    The API's root resource ID.
    
    Returns:
    
    The API's root resource ID.
  - withRootResourceId
```
public CreateRestApiResult withRootResourceId(String rootResourceId)
```
    The API's root resource ID.
    
    Parameters:
    
    rootResourceId - The API's root resource ID.
    
    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 CreateRestApiResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.639

Class CreateRestApiResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

CreateRestApiResult

Method Detail

setId

getId

withId

setName

getName

withName

setDescription

getDescription

withDescription

setCreatedDate

getCreatedDate

withCreatedDate

setVersion

getVersion

withVersion

getWarnings

setWarnings

withWarnings

withWarnings

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

setRootResourceId

getRootResourceId

withRootResourceId

toString

equals

hashCode

clone