Class Api
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Api.Builder,
Api>
Represents an API.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com.final Boolean
Specifies whether an API is managed by API Gateway.final String
apiId()
The API ID.final String
An API key selection expression.static Api.Builder
builder()
final Cors
A CORS configuration.final Instant
The timestamp when the API was created.final String
The description of the API.final Boolean
Specifies whether clients can invoke your API by using the default execute-api endpoint.final Boolean
Avoid validating models when creating a deployment.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) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ImportInfo property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the Warnings property.The validation information during API import.final String
name()
The name of the API.final ProtocolType
The API protocol.final String
The API protocol.final String
The route selection expression for the API.static Class
<? extends Api.Builder> tags()
A collection of tags associated with the API.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.warnings()
The warning messages reported when failonwarnings is turned on during API import.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
apiEndpoint
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
- Returns:
- The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
-
apiGatewayManaged
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
- Returns:
- Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
-
apiId
The API ID.
- Returns:
- The API ID.
-
apiKeySelectionExpression
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
- Returns:
- An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
-
corsConfiguration
A CORS configuration. Supported only for HTTP APIs.
- Returns:
- A CORS configuration. Supported only for HTTP APIs.
-
createdDate
The timestamp when the API was created.
- Returns:
- The timestamp when the API was created.
-
description
The description of the API.
- Returns:
- The description of the API.
-
disableSchemaValidation
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- Returns:
- Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
-
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:
- 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.
-
hasImportInfo
public final boolean hasImportInfo()For responses, this returns true if the service returned a value for the ImportInfo 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. -
importInfo
The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
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
hasImportInfo()
method.- Returns:
- The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
-
name
The name of the API.
- Returns:
- The name of the API.
-
protocolType
The API protocol.
If the service returns an enum value that is not available in the current SDK version,
protocolType
will returnProtocolType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolTypeAsString()
.- Returns:
- The API protocol.
- See Also:
-
protocolTypeAsString
The API protocol.
If the service returns an enum value that is not available in the current SDK version,
protocolType
will returnProtocolType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolTypeAsString()
.- Returns:
- The API protocol.
- See Also:
-
routeSelectionExpression
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
- Returns:
- The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
-
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
A collection of tags associated with the API.
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:
- A collection of tags associated with the API.
-
version
A version identifier for the API.
- Returns:
- A version identifier for the API.
-
hasWarnings
public final boolean hasWarnings()For responses, this returns true if the service returned a value for the Warnings 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. -
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.- Returns:
- The warning messages reported when failonwarnings is turned on during API import.
-
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<Api.Builder,
Api> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-