java.lang.Object
- com.oracle.bmc.http.internal.BaseAsyncClient
- - com.oracle.bmc.managedkafka.KafkaClusterAsyncClient

All Implemented Interfaces:

KafkaClusterAsync, AutoCloseable
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240901")
public class KafkaClusterAsyncClient
extends BaseAsyncClient
implements KafkaClusterAsync
```
Async client implementation for KafkaCluster service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class KafkaClusterAsyncClient.Builder
Builder class for this client.

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`clientCommonLibraryVersion`	Compatible SDK version, provided by the codegen.
`Optional<String>`	`minimumClientCommonLibraryVersionFromClient`	Minimum compatible SDK version, maybe provided by the codegen.
`static Service`	`SERVICE`	Service instance for KafkaCluster.

Constructor Summary

Constructors
Constructor	Description
`KafkaClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`KafkaClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`KafkaClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`KafkaClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`KafkaClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`KafkaClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`KafkaClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)`	Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static KafkaClusterAsyncClient.Builder`	`builder()`	Create a builder for this client.
`Future<CancelWorkRequestResponse>`	`cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)`	Cancels a work request.
`Future<ChangeKafkaClusterCompartmentResponse>`	`changeKafkaClusterCompartment(ChangeKafkaClusterCompartmentRequest request, AsyncHandler<ChangeKafkaClusterCompartmentRequest,ChangeKafkaClusterCompartmentResponse> handler)`	Moves a KafkaCluster into a different compartment within the same tenancy.
`Future<ChangeKafkaClusterConfigCompartmentResponse>`	`changeKafkaClusterConfigCompartment(ChangeKafkaClusterConfigCompartmentRequest request, AsyncHandler<ChangeKafkaClusterConfigCompartmentRequest,ChangeKafkaClusterConfigCompartmentResponse> handler)`	Moves a KafkaClusterConfig into a different compartment within the same tenancy.
`protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>`	`clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)`
`void`	`close()`
`Future<CreateKafkaClusterResponse>`	`createKafkaCluster(CreateKafkaClusterRequest request, AsyncHandler<CreateKafkaClusterRequest,CreateKafkaClusterResponse> handler)`	Creates a KafkaCluster.
`Future<CreateKafkaClusterConfigResponse>`	`createKafkaClusterConfig(CreateKafkaClusterConfigRequest request, AsyncHandler<CreateKafkaClusterConfigRequest,CreateKafkaClusterConfigResponse> handler)`	Creates a KafkaClusterConfig.
`Future<DeleteKafkaClusterResponse>`	`deleteKafkaCluster(DeleteKafkaClusterRequest request, AsyncHandler<DeleteKafkaClusterRequest,DeleteKafkaClusterResponse> handler)`	Deletes a KafkaCluster.
`Future<DeleteKafkaClusterConfigResponse>`	`deleteKafkaClusterConfig(DeleteKafkaClusterConfigRequest request, AsyncHandler<DeleteKafkaClusterConfigRequest,DeleteKafkaClusterConfigResponse> handler)`	Deletes a KafkaClusterConfig.
`Future<DeleteKafkaClusterConfigVersionResponse>`	`deleteKafkaClusterConfigVersion(DeleteKafkaClusterConfigVersionRequest request, AsyncHandler<DeleteKafkaClusterConfigVersionRequest,DeleteKafkaClusterConfigVersionResponse> handler)`	Deletes a KafkaClusterConfig version.
`Future<DisableSuperuserResponse>`	`disableSuperuser(DisableSuperuserRequest request, AsyncHandler<DisableSuperuserRequest,DisableSuperuserResponse> handler)`	Removes the SASL superuser to the Kafka cluster.
`Future<EnableSuperuserResponse>`	`enableSuperuser(EnableSuperuserRequest request, AsyncHandler<EnableSuperuserRequest,EnableSuperuserResponse> handler)`	Adds a SASL superuser to the Kafka cluster.
`String`	`getClientCommonLibraryVersion()`
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`
`Future<GetKafkaClusterResponse>`	`getKafkaCluster(GetKafkaClusterRequest request, AsyncHandler<GetKafkaClusterRequest,GetKafkaClusterResponse> handler)`	Gets information about a KafkaCluster.
`Future<GetKafkaClusterConfigResponse>`	`getKafkaClusterConfig(GetKafkaClusterConfigRequest request, AsyncHandler<GetKafkaClusterConfigRequest,GetKafkaClusterConfigResponse> handler)`	Gets information about a KafkaClusterConfig.
`Future<GetKafkaClusterConfigVersionResponse>`	`getKafkaClusterConfigVersion(GetKafkaClusterConfigVersionRequest request, AsyncHandler<GetKafkaClusterConfigVersionRequest,GetKafkaClusterConfigVersionResponse> handler)`	Gets information about a KafkaClusterConfig version.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`Future<GetWorkRequestResponse>`	`getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)`	Gets the details of a work request.
`Future<ListKafkaClusterConfigsResponse>`	`listKafkaClusterConfigs(ListKafkaClusterConfigsRequest request, AsyncHandler<ListKafkaClusterConfigsRequest,ListKafkaClusterConfigsResponse> handler)`	Gets a list of KafkaClusterConfigs.
`Future<ListKafkaClusterConfigVersionsResponse>`	`listKafkaClusterConfigVersions(ListKafkaClusterConfigVersionsRequest request, AsyncHandler<ListKafkaClusterConfigVersionsRequest,ListKafkaClusterConfigVersionsResponse> handler)`	Gets a list of KafkaClusterConfig Versions.
`Future<ListKafkaClustersResponse>`	`listKafkaClusters(ListKafkaClustersRequest request, AsyncHandler<ListKafkaClustersRequest,ListKafkaClustersResponse> handler)`	Gets a list of KafkaClusters.
`Future<ListWorkRequestErrorsResponse>`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)`	Lists the errors for a work request.
`Future<ListWorkRequestLogsResponse>`	`listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)`	Lists the logs for a work request.
`Future<ListWorkRequestsResponse>`	`listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)`	Lists the work requests in a compartment.
`void`	`populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)`	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`void`	`setEndpoint(String endpoint)`
`void`	`setRegion(Region region)`	Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)`	Sets the region to call (ex, ‘us-phoenix-1’).
`void`	`updateBaseEndpoint(String endpoint)`	This method should be used for parameterized endpoint templates only.
`Future<UpdateKafkaClusterResponse>`	`updateKafkaCluster(UpdateKafkaClusterRequest request, AsyncHandler<UpdateKafkaClusterRequest,UpdateKafkaClusterResponse> handler)`	Updates a KafkaCluster.
`Future<UpdateKafkaClusterConfigResponse>`	`updateKafkaClusterConfig(UpdateKafkaClusterConfigRequest request, AsyncHandler<UpdateKafkaClusterConfigRequest,UpdateKafkaClusterConfigResponse> handler)`	Updates a KafkaClusterConfig.
`void`	`useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable
close

Methods inherited from interface com.oracle.bmc.managedkafka.KafkaClusterAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for KafkaCluster.
  - clientCommonLibraryVersion
```
public final String clientCommonLibraryVersion
```
    Compatible SDK version, provided by the codegen.
  - minimumClientCommonLibraryVersionFromClient
```
public final Optional<String> minimumClientCommonLibraryVersionFromClient
```
    Minimum compatible SDK version, maybe provided by the codegen.
- Constructor Detail
  - KafkaClusterAsyncClient
```
@Deprecated
public KafkaClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KafkaClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - KafkaClusterAsyncClient
```
@Deprecated
public KafkaClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KafkaClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - KafkaClusterAsyncClient
```
@Deprecated
public KafkaClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KafkaClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - KafkaClusterAsyncClient
```
@Deprecated
public KafkaClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KafkaClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - KafkaClusterAsyncClient
```
@Deprecated
public KafkaClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               List<ClientConfigurator> additionalClientConfigurators)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KafkaClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - KafkaClusterAsyncClient
```
@Deprecated
public KafkaClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               List<ClientConfigurator> additionalClientConfigurators,
                               String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KafkaClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
  - KafkaClusterAsyncClient
```
@Deprecated
public KafkaClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                               List<ClientConfigurator> additionalClientConfigurators,
                               String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see KafkaClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
- Method Detail
  - builder
```
public static KafkaClusterAsyncClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: KafkaClusterAsync
    
    Sets the region to call (ex, Region.US_PHOENIX_1).
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.
    
    Specified by:
    
    setRegion in interface KafkaClusterAsync
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: KafkaClusterAsync
    
    Sets the region to call (ex, ‘us-phoenix-1’).
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Specified by:
    
    setRegion in interface KafkaClusterAsync
    
    Parameters:
    
    regionId - The public region ID.
  - cancelWorkRequest
```
public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request,
                                                           AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Cancels a work request.
    
    Specified by:
    
    cancelWorkRequest in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - changeKafkaClusterCompartment
```
public Future<ChangeKafkaClusterCompartmentResponse> changeKafkaClusterCompartment(ChangeKafkaClusterCompartmentRequest request,
                                                                                   AsyncHandler<ChangeKafkaClusterCompartmentRequest,ChangeKafkaClusterCompartmentResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Moves a KafkaCluster into a different compartment within the same tenancy.
    For information about moving resources between compartments, see Moving Resources to a Different Compartment.
    
    Specified by:
    
    changeKafkaClusterCompartment in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - changeKafkaClusterConfigCompartment
```
public Future<ChangeKafkaClusterConfigCompartmentResponse> changeKafkaClusterConfigCompartment(ChangeKafkaClusterConfigCompartmentRequest request,
                                                                                               AsyncHandler<ChangeKafkaClusterConfigCompartmentRequest,ChangeKafkaClusterConfigCompartmentResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Moves a KafkaClusterConfig into a different compartment within the same tenancy.
    For information about moving resources between compartments, see Moving Resources to a Different Compartment.
    
    Specified by:
    
    changeKafkaClusterConfigCompartment in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createKafkaCluster
```
public Future<CreateKafkaClusterResponse> createKafkaCluster(CreateKafkaClusterRequest request,
                                                             AsyncHandler<CreateKafkaClusterRequest,CreateKafkaClusterResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Creates a KafkaCluster.
    
    Specified by:
    
    createKafkaCluster in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createKafkaClusterConfig
```
public Future<CreateKafkaClusterConfigResponse> createKafkaClusterConfig(CreateKafkaClusterConfigRequest request,
                                                                         AsyncHandler<CreateKafkaClusterConfigRequest,CreateKafkaClusterConfigResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Creates a KafkaClusterConfig.
    
    Specified by:
    
    createKafkaClusterConfig in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteKafkaCluster
```
public Future<DeleteKafkaClusterResponse> deleteKafkaCluster(DeleteKafkaClusterRequest request,
                                                             AsyncHandler<DeleteKafkaClusterRequest,DeleteKafkaClusterResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Deletes a KafkaCluster.
    
    Specified by:
    
    deleteKafkaCluster in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteKafkaClusterConfig
```
public Future<DeleteKafkaClusterConfigResponse> deleteKafkaClusterConfig(DeleteKafkaClusterConfigRequest request,
                                                                         AsyncHandler<DeleteKafkaClusterConfigRequest,DeleteKafkaClusterConfigResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Deletes a KafkaClusterConfig.
    
    Specified by:
    
    deleteKafkaClusterConfig in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteKafkaClusterConfigVersion
```
public Future<DeleteKafkaClusterConfigVersionResponse> deleteKafkaClusterConfigVersion(DeleteKafkaClusterConfigVersionRequest request,
                                                                                       AsyncHandler<DeleteKafkaClusterConfigVersionRequest,DeleteKafkaClusterConfigVersionResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Deletes a KafkaClusterConfig version.
    
    Specified by:
    
    deleteKafkaClusterConfigVersion in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - disableSuperuser
```
public Future<DisableSuperuserResponse> disableSuperuser(DisableSuperuserRequest request,
                                                         AsyncHandler<DisableSuperuserRequest,DisableSuperuserResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Removes the SASL superuser to the Kafka cluster.
    
    Specified by:
    
    disableSuperuser in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - enableSuperuser
```
public Future<EnableSuperuserResponse> enableSuperuser(EnableSuperuserRequest request,
                                                       AsyncHandler<EnableSuperuserRequest,EnableSuperuserResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Adds a SASL superuser to the Kafka cluster.
    A generated password will be updated to the specified vault.
    
    Specified by:
    
    enableSuperuser in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getKafkaCluster
```
public Future<GetKafkaClusterResponse> getKafkaCluster(GetKafkaClusterRequest request,
                                                       AsyncHandler<GetKafkaClusterRequest,GetKafkaClusterResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Gets information about a KafkaCluster.
    
    Specified by:
    
    getKafkaCluster in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getKafkaClusterConfig
```
public Future<GetKafkaClusterConfigResponse> getKafkaClusterConfig(GetKafkaClusterConfigRequest request,
                                                                   AsyncHandler<GetKafkaClusterConfigRequest,GetKafkaClusterConfigResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Gets information about a KafkaClusterConfig.
    
    Specified by:
    
    getKafkaClusterConfig in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getKafkaClusterConfigVersion
```
public Future<GetKafkaClusterConfigVersionResponse> getKafkaClusterConfigVersion(GetKafkaClusterConfigVersionRequest request,
                                                                                 AsyncHandler<GetKafkaClusterConfigVersionRequest,GetKafkaClusterConfigVersionResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Gets information about a KafkaClusterConfig version.
    
    Specified by:
    
    getKafkaClusterConfigVersion in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getWorkRequest
```
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Gets the details of a work request.
    
    Specified by:
    
    getWorkRequest in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listKafkaClusterConfigVersions
```
public Future<ListKafkaClusterConfigVersionsResponse> listKafkaClusterConfigVersions(ListKafkaClusterConfigVersionsRequest request,
                                                                                     AsyncHandler<ListKafkaClusterConfigVersionsRequest,ListKafkaClusterConfigVersionsResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Gets a list of KafkaClusterConfig Versions.
    
    Specified by:
    
    listKafkaClusterConfigVersions in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listKafkaClusterConfigs
```
public Future<ListKafkaClusterConfigsResponse> listKafkaClusterConfigs(ListKafkaClusterConfigsRequest request,
                                                                       AsyncHandler<ListKafkaClusterConfigsRequest,ListKafkaClusterConfigsResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Gets a list of KafkaClusterConfigs.
    
    Specified by:
    
    listKafkaClusterConfigs in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listKafkaClusters
```
public Future<ListKafkaClustersResponse> listKafkaClusters(ListKafkaClustersRequest request,
                                                           AsyncHandler<ListKafkaClustersRequest,ListKafkaClustersResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Gets a list of KafkaClusters.
    
    Specified by:
    
    listKafkaClusters in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listWorkRequestErrors
```
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Lists the errors for a work request.
    
    Specified by:
    
    listWorkRequestErrors in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listWorkRequestLogs
```
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Lists the logs for a work request.
    
    Specified by:
    
    listWorkRequestLogs in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listWorkRequests
```
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Lists the work requests in a compartment.
    
    Specified by:
    
    listWorkRequests in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateKafkaCluster
```
public Future<UpdateKafkaClusterResponse> updateKafkaCluster(UpdateKafkaClusterRequest request,
                                                             AsyncHandler<UpdateKafkaClusterRequest,UpdateKafkaClusterResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Updates a KafkaCluster.
    
    Specified by:
    
    updateKafkaCluster in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateKafkaClusterConfig
```
public Future<UpdateKafkaClusterConfigResponse> updateKafkaClusterConfig(UpdateKafkaClusterConfigRequest request,
                                                                         AsyncHandler<UpdateKafkaClusterConfigRequest,UpdateKafkaClusterConfigResponse> handler)
```
    Description copied from interface: KafkaClusterAsync
    
    Updates a KafkaClusterConfig.
    
    Specified by:
    
    updateKafkaClusterConfig in interface KafkaClusterAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - useRealmSpecificEndpointTemplate
```
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
```
    This method should be used to enable or disable the use of realm-specific endpoint template.
    The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
    
    Parameters:
    
    useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
  - populateServiceParametersInEndpoint
```
public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)
```
    Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
    The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
    
    Parameters:
    
    endpoint - The endpoint template in use
    
    requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value
  - updateBaseEndpoint
```
public final void updateBaseEndpoint(String endpoint)
```
    This method should be used for parameterized endpoint templates only.
    This does not include {region} and {secondLevelDomain} parameters.
    
    Parameters:
    
    endpoint - The updated endpoint to use
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
  - refreshClient
```
public final void refreshClient()
```
    Rebuild the backing HttpClient.
    This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```
  - clientCall
```
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)
```

Class KafkaClusterAsyncClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.managedkafka.KafkaClusterAsync

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

KafkaClusterAsyncClient

KafkaClusterAsyncClient

KafkaClusterAsyncClient

KafkaClusterAsyncClient

KafkaClusterAsyncClient

KafkaClusterAsyncClient

KafkaClusterAsyncClient

Method Detail

builder

setRegion

setRegion

cancelWorkRequest

changeKafkaClusterCompartment

changeKafkaClusterConfigCompartment

createKafkaCluster

createKafkaClusterConfig

deleteKafkaCluster

deleteKafkaClusterConfig

deleteKafkaClusterConfigVersion

disableSuperuser

enableSuperuser

getKafkaCluster

getKafkaClusterConfig

getKafkaClusterConfigVersion

getWorkRequest

listKafkaClusterConfigVersions

listKafkaClusterConfigs

listKafkaClusters

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateKafkaCluster

updateKafkaClusterConfig

getDefaultConfigurator

useRealmSpecificEndpointTemplate

populateServiceParametersInEndpoint

updateBaseEndpoint

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient

clientCall