Class CreateRestApiRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateRestApiRequest.Builder,
CreateRestApiRequest>
The POST Request to add a new RestApi resource to your collection.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ApiKeySourceType
The source of the API key for metering requests according to a usage plan.final String
The source of the API key for metering requests according to a usage plan.The list of binary media types supported by the RestApi.static CreateRestApiRequest.Builder
builder()
final String
The ID of the RestApi that you want to clone from.final String
The description of the RestApi.final Boolean
Specifies whether clients can invoke your API by using the defaultexecute-api
endpoint.final EndpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the BinaryMediaTypes property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Integer
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.final String
name()
The name of the RestApi.final String
policy()
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.static Class
<? extends CreateRestApiRequest.Builder> tags()
The key-value map of strings.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
version()
A version identifier for the API.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the RestApi.
- Returns:
- The name of the RestApi.
-
description
The description of the RestApi.
- Returns:
- The description of the RestApi.
-
version
A version identifier for the API.
- Returns:
- A version identifier for the API.
-
cloneFrom
The ID of the RestApi that you want to clone from.
- Returns:
- The ID of the RestApi that you want to clone from.
-
hasBinaryMediaTypes
public final boolean hasBinaryMediaTypes()For responses, this returns true if the service returned a value for the BinaryMediaTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
-
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:
- 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.
-
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 theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.If the service returns an enum value that is not available in the current SDK version,
apiKeySource
will returnApiKeySourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapiKeySourceAsString()
.- 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 theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer. - See Also:
-
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 theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.If the service returns an enum value that is not available in the current SDK version,
apiKeySource
will returnApiKeySourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapiKeySourceAsString()
.- 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 theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer. - See Also:
-
endpointConfiguration
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.
-
policy
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.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.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.- 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.
-
disableExecuteApiEndpoint
Specifies whether clients can invoke your API by using the default
execute-api
endpoint. By default, clients can invoke your API with the defaulthttps://{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 defaulthttps://{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
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateRestApiRequest.Builder,
CreateRestApiRequest> - Specified by:
toBuilder
in classApiGatewayRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-