@Generated(value="software.amazon.awssdk:codegen") public final class CreateRestApiResponse extends ApiGatewayResponse implements ToCopyableBuilder<CreateRestApiResponse.Builder,CreateRestApiResponse>
Represents a REST API.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateRestApiResponse.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 CreateRestApiResponse.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)
Used to retrieve the value of a field from any class that extends
SdkResponse. |
boolean |
hasBinaryMediaTypes()
For responses, this returns true if the service returned a value for the BinaryMediaTypes property.
|
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasWarnings()
For responses, this returns true if the service returned a value for the Warnings property.
|
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 CreateRestApiResponse.Builder> |
serializableBuilderClass() |
Map<String,String> |
tags()
The collection of tags.
|
CreateRestApiResponse.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. |
responseMetadatasdkHttpResponsecopypublic 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()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasWarnings() method.
failonwarnings is turned on during API import.public final boolean hasBinaryMediaTypes()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasBinaryMediaTypes() method.
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.ApiKeySourceTypepublic 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.ApiKeySourceTypepublic 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()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
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 CreateRestApiResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateRestApiResponse.Builder,CreateRestApiResponse>toBuilder in class AwsResponsepublic static CreateRestApiResponse.Builder builder()
public static Class<? extends CreateRestApiResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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 SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will
again be available.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.