com.amazonaws.services.apigatewaymanagementapi

Class AmazonApiGatewayManagementApiAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.apigatewaymanagementapi.AmazonApiGatewayManagementApiClient

com.amazonaws.services.apigatewaymanagementapi.AmazonApiGatewayManagementApiAsyncClient

All Implemented Interfaces:

AmazonApiGatewayManagementApi, AmazonApiGatewayManagementApiAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonApiGatewayManagementApiAsyncClient
extends AmazonApiGatewayManagementApiClient
implements AmazonApiGatewayManagementApiAsync

Client for accessing AmazonApiGatewayManagementApi asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

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

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.apigatewaymanagementapi.AmazonApiGatewayManagementApi

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonApiGatewayManagementApiAsyncClientBuilder	asyncBuilder()
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<PostToConnectionResult>	postToConnectionAsync(PostToConnectionRequest request) Sends the provided data to the specified connection.
Future<PostToConnectionResult>	postToConnectionAsync(PostToConnectionRequest request, AsyncHandler<PostToConnectionRequest,PostToConnectionResult> asyncHandler) Sends the provided data to the specified connection.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.apigatewaymanagementapi.AmazonApiGatewayManagementApiClient

builder, getCachedResponseMetadata, postToConnection

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.apigatewaymanagementapi.AmazonApiGatewayManagementApi

getCachedResponseMetadata, postToConnection

Method Detail

asyncBuilder

public static AmazonApiGatewayManagementApiAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

postToConnectionAsync

public Future<PostToConnectionResult> postToConnectionAsync(PostToConnectionRequest request)

Description copied from interface: AmazonApiGatewayManagementApiAsync

Sends the provided data to the specified connection.

Specified by:

postToConnectionAsync in interface AmazonApiGatewayManagementApiAsync

Returns:

A Java Future containing the result of the PostToConnection operation returned by the service.

See Also:

AWS API Documentation

postToConnectionAsync

public Future<PostToConnectionResult> postToConnectionAsync(PostToConnectionRequest request,
                                                            AsyncHandler<PostToConnectionRequest,PostToConnectionResult> asyncHandler)

Description copied from interface: AmazonApiGatewayManagementApiAsync

Sends the provided data to the specified connection.

Specified by:

postToConnectionAsync in interface AmazonApiGatewayManagementApiAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the PostToConnection operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonApiGatewayManagementApi

Overrides:

shutdown in class AmazonWebServiceClient