software.amazon.awssdk.services.kafka

Interface KafkaAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface KafkaAsyncClient
extends SdkClient

Service client for accessing Kafka asynchronously. This can be created using the static builder() method.

The operations for managing an Amazon MSK cluster.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static KafkaAsyncClientBuilder	builder() Create a builder that can be used to configure and create a KafkaAsyncClient.
static KafkaAsyncClient	create() Create a KafkaAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateClusterResponse>	createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) Creates a new MSK cluster.
default CompletableFuture<CreateClusterResponse>	createCluster(CreateClusterRequest createClusterRequest) Creates a new MSK cluster.
default CompletableFuture<DeleteClusterResponse>	deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
default CompletableFuture<DeleteClusterResponse>	deleteCluster(DeleteClusterRequest deleteClusterRequest) Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
default CompletableFuture<DescribeClusterResponse>	describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest) Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
default CompletableFuture<DescribeClusterResponse>	describeCluster(DescribeClusterRequest describeClusterRequest) Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
default CompletableFuture<GetBootstrapBrokersResponse>	getBootstrapBrokers(Consumer<GetBootstrapBrokersRequest.Builder> getBootstrapBrokersRequest) A list of brokers that a client application can use to bootstrap.
default CompletableFuture<GetBootstrapBrokersResponse>	getBootstrapBrokers(GetBootstrapBrokersRequest getBootstrapBrokersRequest) A list of brokers that a client application can use to bootstrap.
default CompletableFuture<ListClustersResponse>	listClusters() Returns a list of clusters in an account.
default CompletableFuture<ListClustersResponse>	listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest) Returns a list of clusters in an account.
default CompletableFuture<ListClustersResponse>	listClusters(ListClustersRequest listClustersRequest) Returns a list of clusters in an account.
default CompletableFuture<ListNodesResponse>	listNodes(Consumer<ListNodesRequest.Builder> listNodesRequest) Returns a list of the broker nodes in the cluster.
default CompletableFuture<ListNodesResponse>	listNodes(ListNodesRequest listNodesRequest) Returns a list of the broker nodes in the cluster.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static KafkaAsyncClient create()

Create a KafkaAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static KafkaAsyncClientBuilder builder()

Create a builder that can be used to configure and create a KafkaAsyncClient.

createCluster

default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)

Creates a new MSK cluster.

Parameters:

createClusterRequest -

Returns:

A Java Future containing the result of the CreateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• UnauthorizedException The request is not authorized. The provided credentials couldn't be validated.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• ServiceUnavailableException 503 response
• TooManyRequestsException 429 response
• ConflictException This cluster name already exists. Retry your request using another name.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createCluster

default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)

Creates a new MSK cluster.

This is a convenience which creates an instance of the CreateClusterRequest.Builder avoiding the need to create one manually via CreateClusterRequest.builder()

Parameters:

createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CreateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• UnauthorizedException The request is not authorized. The provided credentials couldn't be validated.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• ServiceUnavailableException 503 response
• TooManyRequestsException 429 response
• ConflictException This cluster name already exists. Retry your request using another name.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteCluster

default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest)

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

Parameters:

deleteClusterRequest -

Returns:

A Java Future containing the result of the DeleteCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotFoundException The resource could not be found due to incorrect input. Correct your request and then retry it.
• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteCluster

default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)

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

This is a convenience which creates an instance of the DeleteClusterRequest.Builder avoiding the need to create one manually via DeleteClusterRequest.builder()

Parameters:

deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotFoundException The resource could not be found due to incorrect input. Correct your request and then retry it.
• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeCluster

default CompletableFuture<DescribeClusterResponse> describeCluster(DescribeClusterRequest describeClusterRequest)

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

Parameters:

describeClusterRequest -

Returns:

A Java Future containing the result of the DescribeCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotFoundException The resource could not be found due to incorrect input. Correct your request and then retry it.
• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• UnauthorizedException The request is not authorized. The provided credentials couldn't be validated.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

describeCluster

default CompletableFuture<DescribeClusterResponse> describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)

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

This is a convenience which creates an instance of the DescribeClusterRequest.Builder avoiding the need to create one manually via DescribeClusterRequest.builder()

Parameters:

describeClusterRequest - A Consumer that will call methods on DescribeClusterRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DescribeCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotFoundException The resource could not be found due to incorrect input. Correct your request and then retry it.
• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• UnauthorizedException The request is not authorized. The provided credentials couldn't be validated.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getBootstrapBrokers

default CompletableFuture<GetBootstrapBrokersResponse> getBootstrapBrokers(GetBootstrapBrokersRequest getBootstrapBrokersRequest)

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

Parameters:

getBootstrapBrokersRequest -

Returns:

A Java Future containing the result of the GetBootstrapBrokers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• UnauthorizedException The request is not authorized. The provided credentials couldn't be validated.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• ConflictException This cluster name already exists. Retry your request using another name.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getBootstrapBrokers

default CompletableFuture<GetBootstrapBrokersResponse> getBootstrapBrokers(Consumer<GetBootstrapBrokersRequest.Builder> getBootstrapBrokersRequest)

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

This is a convenience which creates an instance of the GetBootstrapBrokersRequest.Builder avoiding the need to create one manually via GetBootstrapBrokersRequest.builder()

Parameters:

getBootstrapBrokersRequest - A Consumer that will call methods on GetBootstrapBrokersRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetBootstrapBrokers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• UnauthorizedException The request is not authorized. The provided credentials couldn't be validated.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• ConflictException This cluster name already exists. Retry your request using another name.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listClusters

default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)

Returns a list of clusters in an account.

Parameters:

listClustersRequest -

Returns:

A Java Future containing the result of the ListClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• UnauthorizedException The request is not authorized. The provided credentials couldn't be validated.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listClusters

default CompletableFuture<ListClustersResponse> listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)

Returns a list of clusters in an account.

This is a convenience which creates an instance of the ListClustersRequest.Builder avoiding the need to create one manually via ListClustersRequest.builder()

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• UnauthorizedException The request is not authorized. The provided credentials couldn't be validated.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listClusters

default CompletableFuture<ListClustersResponse> listClusters()

Returns a list of clusters in an account.

Returns:

A Java Future containing the result of the ListClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• UnauthorizedException The request is not authorized. The provided credentials couldn't be validated.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listNodes

default CompletableFuture<ListNodesResponse> listNodes(ListNodesRequest listNodesRequest)

Returns a list of the broker nodes in the cluster.

Parameters:

listNodesRequest -

Returns:

A Java Future containing the result of the ListNodes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotFoundException The resource could not be found due to incorrect input. Correct your request and then retry it.
• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listNodes

default CompletableFuture<ListNodesResponse> listNodes(Consumer<ListNodesRequest.Builder> listNodesRequest)

Returns a list of the broker nodes in the cluster.

This is a convenience which creates an instance of the ListNodesRequest.Builder avoiding the need to create one manually via ListNodesRequest.builder()

Parameters:

listNodesRequest - A Consumer that will call methods on ListNodesRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListNodes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• NotFoundException The resource could not be found due to incorrect input. Correct your request and then retry it.
• BadRequestException Bad request due to incorrect input. Correct your request and then retry it.
• InternalServerErrorException There was an unexpected internal server error. Retrying your request might resolve the issue.
• ForbiddenException Access forbidden. Check your credentials and then retry your request.
• 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.
• KafkaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation