@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetRestApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Represents a REST API.
Constructor and Description |
---|
GetRestApiResult() |
Modifier and Type | Method and Description |
---|---|
GetRestApiResult |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
GetRestApiResult |
clearTagsEntries()
Removes all the entries added into Tags.
|
GetRestApiResult |
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.
|
GetRestApiResult |
withApiKeySource(ApiKeySourceType apiKeySource)
The source of the API key for metering requests according to a usage plan.
|
GetRestApiResult |
withApiKeySource(String apiKeySource)
The source of the API key for metering requests according to a usage plan.
|
GetRestApiResult |
withBinaryMediaTypes(Collection<String> binaryMediaTypes)
The list of binary media types supported by the RestApi.
|
GetRestApiResult |
withBinaryMediaTypes(String... binaryMediaTypes)
The list of binary media types supported by the RestApi.
|
GetRestApiResult |
withCreatedDate(Date createdDate)
The timestamp when the API was created.
|
GetRestApiResult |
withDescription(String description)
The API's description.
|
GetRestApiResult |
withDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default
execute-api endpoint. |
GetRestApiResult |
withEndpointConfiguration(EndpointConfiguration endpointConfiguration)
The endpoint configuration of this RestApi showing the endpoint types of the API.
|
GetRestApiResult |
withId(String id)
The API's identifier.
|
GetRestApiResult |
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.
|
GetRestApiResult |
withName(String name)
The API's name.
|
GetRestApiResult |
withPolicy(String policy)
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method
configuration.
|
GetRestApiResult |
withRootResourceId(String rootResourceId)
The API's root resource ID.
|
GetRestApiResult |
withTags(Map<String,String> tags)
The collection of tags.
|
GetRestApiResult |
withVersion(String version)
A version identifier for the API.
|
GetRestApiResult |
withWarnings(Collection<String> warnings)
The warning messages reported when
failonwarnings is turned on during API import. |
GetRestApiResult |
withWarnings(String... warnings)
The warning messages reported when
failonwarnings is turned on during API import. |
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setId(String id)
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
id
- The API's identifier. This identifier is unique across all of your APIs in API Gateway.public String getId()
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
public GetRestApiResult withId(String id)
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
id
- The API's identifier. This identifier is unique across all of your APIs in API Gateway.public void setName(String name)
The API's name.
name
- The API's name.public String getName()
The API's name.
public GetRestApiResult withName(String name)
The API's name.
name
- The API's name.public void setDescription(String description)
The API's description.
description
- The API's description.public String getDescription()
The API's description.
public GetRestApiResult withDescription(String description)
The API's description.
description
- The API's description.public void setCreatedDate(Date createdDate)
The timestamp when the API was created.
createdDate
- The timestamp when the API was created.public Date getCreatedDate()
The timestamp when the API was created.
public GetRestApiResult withCreatedDate(Date createdDate)
The timestamp when the API was created.
createdDate
- The timestamp when the API was created.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 GetRestApiResult withVersion(String version)
A version identifier for the API.
version
- A version identifier for the API.public List<String> getWarnings()
The warning messages reported when failonwarnings
is turned on during API import.
failonwarnings
is turned on during API import.public void setWarnings(Collection<String> warnings)
The warning messages reported when failonwarnings
is turned on during API import.
warnings
- The warning messages reported when failonwarnings
is turned on during API import.public GetRestApiResult 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.
warnings
- The warning messages reported when failonwarnings
is turned on during API import.public GetRestApiResult withWarnings(Collection<String> warnings)
The warning messages reported when failonwarnings
is turned on during API import.
warnings
- The warning messages reported when failonwarnings
is turned on during API import.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 GetRestApiResult 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 GetRestApiResult 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 GetRestApiResult 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 GetRestApiResult 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 GetRestApiResult 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 GetRestApiResult 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 GetRestApiResult 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 collection of tags. Each tag element is associated with a given resource.
public void setTags(Map<String,String> tags)
The collection of tags. Each tag element is associated with a given resource.
tags
- The collection of tags. Each tag element is associated with a given resource.public GetRestApiResult withTags(Map<String,String> tags)
The collection of tags. Each tag element is associated with a given resource.
tags
- The collection of tags. Each tag element is associated with a given resource.public GetRestApiResult addTagsEntry(String key, String value)
public GetRestApiResult 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 endpoint.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.
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.public GetRestApiResult 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 endpoint.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.
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.public void setRootResourceId(String rootResourceId)
The API's root resource ID.
rootResourceId
- The API's root resource ID.public String getRootResourceId()
The API's root resource ID.
public GetRestApiResult withRootResourceId(String rootResourceId)
The API's root resource ID.
rootResourceId
- The API's root resource ID.public String toString()
toString
in class Object
Object.toString()
public GetRestApiResult clone()