com.amazonaws.services.kafka

Class AWSKafkaAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.kafka.AWSKafkaClient

com.amazonaws.services.kafka.AWSKafkaAsyncClient

All Implemented Interfaces:

AWSKafka, AWSKafkaAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSKafkaAsyncClient
extends AWSKafkaClient
implements AWSKafkaAsync

Client for accessing Kafka 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 operations for managing an Amazon MSK cluster.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.kafka.AWSKafka

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSKafkaAsyncClientBuilder	asyncBuilder()
Future<CreateClusterResult>	createClusterAsync(CreateClusterRequest request) Creates a new MSK cluster.
Future<CreateClusterResult>	createClusterAsync(CreateClusterRequest request, AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler) Creates a new MSK cluster.
Future<DeleteClusterResult>	deleteClusterAsync(DeleteClusterRequest request) Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
Future<DeleteClusterResult>	deleteClusterAsync(DeleteClusterRequest request, AsyncHandler<DeleteClusterRequest,DeleteClusterResult> asyncHandler) Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
Future<DescribeClusterResult>	describeClusterAsync(DescribeClusterRequest request) Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
Future<DescribeClusterResult>	describeClusterAsync(DescribeClusterRequest request, AsyncHandler<DescribeClusterRequest,DescribeClusterResult> asyncHandler) Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
Future<GetBootstrapBrokersResult>	getBootstrapBrokersAsync(GetBootstrapBrokersRequest request) A list of brokers that a client application can use to bootstrap.
Future<GetBootstrapBrokersResult>	getBootstrapBrokersAsync(GetBootstrapBrokersRequest request, AsyncHandler<GetBootstrapBrokersRequest,GetBootstrapBrokersResult> asyncHandler) A list of brokers that a client application can use to bootstrap.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListClustersResult>	listClustersAsync(ListClustersRequest request) Returns a list of clusters in an account.
Future<ListClustersResult>	listClustersAsync(ListClustersRequest request, AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler) Returns a list of clusters in an account.
Future<ListNodesResult>	listNodesAsync(ListNodesRequest request) Returns a list of the broker nodes in the cluster.
Future<ListNodesResult>	listNodesAsync(ListNodesRequest request, AsyncHandler<ListNodesRequest,ListNodesResult> asyncHandler) Returns a list of the broker nodes in the cluster.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.kafka.AWSKafkaClient

builder, createCluster, deleteCluster, describeCluster, getBootstrapBrokers, getCachedResponseMetadata, listClusters, listNodes

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.kafka.AWSKafka

createCluster, deleteCluster, describeCluster, getBootstrapBrokers, getCachedResponseMetadata, listClusters, listNodes

Method Detail

asyncBuilder

public static AWSKafkaAsyncClientBuilder 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.

createClusterAsync

public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request)

Description copied from interface: AWSKafkaAsync

Creates a new MSK cluster.

Specified by:

createClusterAsync in interface AWSKafkaAsync

Returns:

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

See Also:

AWS API Documentation

createClusterAsync

public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request,
                                                      AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)

Description copied from interface: AWSKafkaAsync

Creates a new MSK cluster.

Specified by:

createClusterAsync in interface AWSKafkaAsync

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 CreateCluster operation returned by the service.

See Also:

AWS API Documentation

deleteClusterAsync

public Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request)

Description copied from interface: AWSKafkaAsync

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

Specified by:

deleteClusterAsync in interface AWSKafkaAsync

Returns:

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

See Also:

AWS API Documentation

deleteClusterAsync

public Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request,
                                                      AsyncHandler<DeleteClusterRequest,DeleteClusterResult> asyncHandler)

Description copied from interface: AWSKafkaAsync

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

Specified by:

deleteClusterAsync in interface AWSKafkaAsync

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 DeleteCluster operation returned by the service.

See Also:

AWS API Documentation

describeClusterAsync

public Future<DescribeClusterResult> describeClusterAsync(DescribeClusterRequest request)

Description copied from interface: AWSKafkaAsync

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

Specified by:

describeClusterAsync in interface AWSKafkaAsync

Returns:

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

See Also:

AWS API Documentation

describeClusterAsync

public Future<DescribeClusterResult> describeClusterAsync(DescribeClusterRequest request,
                                                          AsyncHandler<DescribeClusterRequest,DescribeClusterResult> asyncHandler)

Description copied from interface: AWSKafkaAsync

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

Specified by:

describeClusterAsync in interface AWSKafkaAsync

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 DescribeCluster operation returned by the service.

See Also:

AWS API Documentation

getBootstrapBrokersAsync

public Future<GetBootstrapBrokersResult> getBootstrapBrokersAsync(GetBootstrapBrokersRequest request)

Description copied from interface: AWSKafkaAsync

A list of brokers that a client application can use to bootstrap.

Specified by:

getBootstrapBrokersAsync in interface AWSKafkaAsync

Returns:

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

See Also:

AWS API Documentation

getBootstrapBrokersAsync

public Future<GetBootstrapBrokersResult> getBootstrapBrokersAsync(GetBootstrapBrokersRequest request,
                                                                  AsyncHandler<GetBootstrapBrokersRequest,GetBootstrapBrokersResult> asyncHandler)

Description copied from interface: AWSKafkaAsync

A list of brokers that a client application can use to bootstrap.

Specified by:

getBootstrapBrokersAsync in interface AWSKafkaAsync

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 GetBootstrapBrokers operation returned by the service.

See Also:

AWS API Documentation

listClustersAsync

public Future<ListClustersResult> listClustersAsync(ListClustersRequest request)

Description copied from interface: AWSKafkaAsync

Returns a list of clusters in an account.

Specified by:

listClustersAsync in interface AWSKafkaAsync

Returns:

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

See Also:

AWS API Documentation

listClustersAsync

public Future<ListClustersResult> listClustersAsync(ListClustersRequest request,
                                                    AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)

Description copied from interface: AWSKafkaAsync

Returns a list of clusters in an account.

Specified by:

listClustersAsync in interface AWSKafkaAsync

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 ListClusters operation returned by the service.

See Also:

AWS API Documentation

listNodesAsync

public Future<ListNodesResult> listNodesAsync(ListNodesRequest request)

Description copied from interface: AWSKafkaAsync

Returns a list of the broker nodes in the cluster.

Specified by:

listNodesAsync in interface AWSKafkaAsync

Returns:

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

See Also:

AWS API Documentation

listNodesAsync

public Future<ListNodesResult> listNodesAsync(ListNodesRequest request,
                                              AsyncHandler<ListNodesRequest,ListNodesResult> asyncHandler)

Description copied from interface: AWSKafkaAsync

Returns a list of the broker nodes in the cluster.

Specified by:

listNodesAsync in interface AWSKafkaAsync

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 ListNodes 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 AWSKafka

Overrides:

shutdown in class AmazonWebServiceClient