@Generated(value="software.amazon.awssdk:codegen") public final class RestApi extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RestApi.Builder,RestApi>
Represents a REST API.
Modifier and Type | Class and Description |
---|---|
static interface |
RestApi.Builder |
Modifier and Type | Method and Description |
---|---|
ApiKeySourceType |
apiKeySource()
The source of the API key for metering requests according to a usage plan.
|
String |
apiKeySourceAsString()
The source of the API key for metering requests according to a usage plan.
|
List<String> |
binaryMediaTypes()
The list of binary media types supported by the RestApi.
|
static RestApi.Builder |
builder() |
Instant |
createdDate()
The timestamp when the API was created.
|
String |
description()
The API's description.
|
Boolean |
disableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default
execute-api endpoint. |
EndpointConfiguration |
endpointConfiguration()
The endpoint configuration of this RestApi showing the endpoint types of the API.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasBinaryMediaTypes()
Returns true if the BinaryMediaTypes property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
boolean |
hasWarnings()
Returns true if the Warnings property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
String |
id()
The API's identifier.
|
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.
|
String |
name()
The API's name.
|
String |
policy()
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method
configuration.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends RestApi.Builder> |
serializableBuilderClass() |
Map<String,String> |
tags()
The collection of tags.
|
RestApi.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
version()
A version identifier for the API.
|
List<String> |
warnings()
The warning messages reported when
failonwarnings is turned on during API import. |
copy
public final String id()
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
public final String name()
The API's name.
public final String description()
The API's description.
public final Instant createdDate()
The timestamp when the API was created.
public final String version()
A version identifier for the API.
public final boolean hasWarnings()
public final List<String> warnings()
The warning messages reported when failonwarnings
is turned on during API import.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasWarnings()
to see if a value was sent in this field.
failonwarnings
is turned on during API import.public final boolean hasBinaryMediaTypes()
public final List<String> binaryMediaTypes()
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasBinaryMediaTypes()
to see if a value was sent in this field.
public final 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.
public final 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.
If the service returns an enum value that is not available in the current SDK version, apiKeySource
will
return ApiKeySourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
apiKeySourceAsString()
.
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 final String apiKeySourceAsString()
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.
If the service returns an enum value that is not available in the current SDK version, apiKeySource
will
return ApiKeySourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
apiKeySourceAsString()
.
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 final EndpointConfiguration endpointConfiguration()
The endpoint configuration of this RestApi showing the endpoint types of the API.
public final String policy()
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
public final boolean hasTags()
public final Map<String,String> tags()
The collection of tags. Each tag element is associated with a given resource.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
public final 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.
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 RestApi.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RestApi.Builder,RestApi>
public static RestApi.Builder builder()
public static Class<? extends RestApi.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()