Interface ApiGatewayManagementApiAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aApiGatewayManagementApiAsyncClient
.create()
Create aApiGatewayManagementApiAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.deleteConnection
(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest) Delete the connection with the provided id.deleteConnection
(DeleteConnectionRequest deleteConnectionRequest) Delete the connection with the provided id.default CompletableFuture
<GetConnectionResponse> getConnection
(Consumer<GetConnectionRequest.Builder> getConnectionRequest) Get information about the connection with the provided id.default CompletableFuture
<GetConnectionResponse> getConnection
(GetConnectionRequest getConnectionRequest) Get information about the connection with the provided id.postToConnection
(Consumer<PostToConnectionRequest.Builder> postToConnectionRequest) Sends the provided data to the specified connection.postToConnection
(PostToConnectionRequest postToConnectionRequest) Sends the provided data to the specified connection.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
deleteConnection
default CompletableFuture<DeleteConnectionResponse> deleteConnection(DeleteConnectionRequest deleteConnectionRequest) Delete the connection with the provided id.
- Parameters:
deleteConnectionRequest
-- Returns:
- A Java Future containing the result of the DeleteConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GoneException The connection with the provided id no longer exists.
- LimitExceededException The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
- ForbiddenException The caller is not authorized to invoke this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiGatewayManagementApiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConnection
default CompletableFuture<DeleteConnectionResponse> deleteConnection(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest) Delete the connection with the provided id.
This is a convenience which creates an instance of the
DeleteConnectionRequest.Builder
avoiding the need to create one manually viaDeleteConnectionRequest.builder()
- Parameters:
deleteConnectionRequest
- AConsumer
that will call methods onDeleteConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GoneException The connection with the provided id no longer exists.
- LimitExceededException The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
- ForbiddenException The caller is not authorized to invoke this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiGatewayManagementApiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConnection
default CompletableFuture<GetConnectionResponse> getConnection(GetConnectionRequest getConnectionRequest) Get information about the connection with the provided id.
- Parameters:
getConnectionRequest
-- Returns:
- A Java Future containing the result of the GetConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GoneException The connection with the provided id no longer exists.
- LimitExceededException The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
- ForbiddenException The caller is not authorized to invoke this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiGatewayManagementApiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConnection
default CompletableFuture<GetConnectionResponse> getConnection(Consumer<GetConnectionRequest.Builder> getConnectionRequest) Get information about the connection with the provided id.
This is a convenience which creates an instance of the
GetConnectionRequest.Builder
avoiding the need to create one manually viaGetConnectionRequest.builder()
- Parameters:
getConnectionRequest
- AConsumer
that will call methods onGetConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GoneException The connection with the provided id no longer exists.
- LimitExceededException The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
- ForbiddenException The caller is not authorized to invoke this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiGatewayManagementApiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
postToConnection
default CompletableFuture<PostToConnectionResponse> postToConnection(PostToConnectionRequest postToConnectionRequest) Sends the provided data to the specified connection.
- Parameters:
postToConnectionRequest
-- Returns:
- A Java Future containing the result of the PostToConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GoneException The connection with the provided id no longer exists.
- LimitExceededException The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
- PayloadTooLargeException The data has exceeded the maximum size allowed.
- ForbiddenException The caller is not authorized to invoke this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiGatewayManagementApiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
postToConnection
default CompletableFuture<PostToConnectionResponse> postToConnection(Consumer<PostToConnectionRequest.Builder> postToConnectionRequest) Sends the provided data to the specified connection.
This is a convenience which creates an instance of the
PostToConnectionRequest.Builder
avoiding the need to create one manually viaPostToConnectionRequest.builder()
- Parameters:
postToConnectionRequest
- AConsumer
that will call methods onPostToConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PostToConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GoneException The connection with the provided id no longer exists.
- LimitExceededException The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
- PayloadTooLargeException The data has exceeded the maximum size allowed.
- ForbiddenException The caller is not authorized to invoke this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiGatewayManagementApiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aApiGatewayManagementApiAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aApiGatewayManagementApiAsyncClient
.
-