Package com.oracle.bmc.managedkafka

Class KafkaClusterClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.managedkafka.KafkaClusterClient

All Implemented Interfaces:

KafkaCluster, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240901")
public class KafkaClusterClient
extends BaseSyncClient
implements KafkaCluster

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KafkaClusterClient.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
KafkaClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
KafkaClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
KafkaClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
KafkaClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
KafkaClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
KafkaClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
KafkaClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
KafkaClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static KafkaClusterClient.Builder	builder()	Create a builder for this client.
CancelWorkRequestResponse	cancelWorkRequest(CancelWorkRequestRequest request)	Cancels a work request.
ChangeKafkaClusterCompartmentResponse	changeKafkaClusterCompartment(ChangeKafkaClusterCompartmentRequest request)	Moves a KafkaCluster into a different compartment within the same tenancy.
ChangeKafkaClusterConfigCompartmentResponse	changeKafkaClusterConfigCompartment(ChangeKafkaClusterConfigCompartmentRequest request)	Moves a KafkaClusterConfig into a different compartment within the same tenancy.
void	close()
CreateKafkaClusterResponse	createKafkaCluster(CreateKafkaClusterRequest request)	Creates a KafkaCluster.
CreateKafkaClusterConfigResponse	createKafkaClusterConfig(CreateKafkaClusterConfigRequest request)	Creates a KafkaClusterConfig.
DeleteKafkaClusterResponse	deleteKafkaCluster(DeleteKafkaClusterRequest request)	Deletes a KafkaCluster.
DeleteKafkaClusterConfigResponse	deleteKafkaClusterConfig(DeleteKafkaClusterConfigRequest request)	Deletes a KafkaClusterConfig.
DeleteKafkaClusterConfigVersionResponse	deleteKafkaClusterConfigVersion(DeleteKafkaClusterConfigVersionRequest request)	Deletes a KafkaClusterConfig version.
DisableSuperuserResponse	disableSuperuser(DisableSuperuserRequest request)	Removes the SASL superuser to the Kafka cluster.
EnableSuperuserResponse	enableSuperuser(EnableSuperuserRequest request)	Adds a SASL superuser to the Kafka cluster.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetKafkaClusterResponse	getKafkaCluster(GetKafkaClusterRequest request)	Gets information about a KafkaCluster.
GetKafkaClusterConfigResponse	getKafkaClusterConfig(GetKafkaClusterConfigRequest request)	Gets information about a KafkaClusterConfig.
GetKafkaClusterConfigVersionResponse	getKafkaClusterConfigVersion(GetKafkaClusterConfigVersionRequest request)	Gets information about a KafkaClusterConfig version.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
KafkaClusterPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
KafkaClusterWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Gets the details of a work request.
ListKafkaClusterConfigsResponse	listKafkaClusterConfigs(ListKafkaClusterConfigsRequest request)	Gets a list of KafkaClusterConfigs.
ListKafkaClusterConfigVersionsResponse	listKafkaClusterConfigVersions(ListKafkaClusterConfigVersionsRequest request)	Gets a list of KafkaClusterConfig Versions.
ListKafkaClustersResponse	listKafkaClusters(ListKafkaClustersRequest request)	Gets a list of KafkaClusters.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	Lists the errors for a work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Lists the logs for a work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request)	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.
UpdateKafkaClusterResponse	updateKafkaCluster(UpdateKafkaClusterRequest request)	Updates a KafkaCluster.
UpdateKafkaClusterConfigResponse	updateKafkaClusterConfig(UpdateKafkaClusterConfigRequest request)	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 com.oracle.bmc.http.internal.BaseSyncClient

clientCall

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.KafkaCluster

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

KafkaClusterClient

@Deprecated
public KafkaClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KafkaClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

KafkaClusterClient

@Deprecated
public KafkaClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KafkaClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

KafkaClusterClient

@Deprecated
public KafkaClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KafkaClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

KafkaClusterClient

@Deprecated
public KafkaClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KafkaClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

KafkaClusterClient

@Deprecated
public KafkaClusterClient(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 KafkaClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

KafkaClusterClient

@Deprecated
public KafkaClusterClient(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 KafkaClusterClient.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)

KafkaClusterClient

@Deprecated
public KafkaClusterClient(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 KafkaClusterClient.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

KafkaClusterClient

@Deprecated
public KafkaClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint,
                          ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see KafkaClusterClient.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

executorService - KafkaClusterClient.Builder.executorService

Method Detail

builder

public static KafkaClusterClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: KafkaCluster

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 KafkaCluster

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: KafkaCluster

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 KafkaCluster

Parameters:

regionId - The public region ID.

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: KafkaCluster

Cancels a work request.

Specified by:

cancelWorkRequest in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeKafkaClusterCompartment

public ChangeKafkaClusterCompartmentResponse changeKafkaClusterCompartment(ChangeKafkaClusterCompartmentRequest request)

Description copied from interface: KafkaCluster

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 KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeKafkaClusterConfigCompartment

public ChangeKafkaClusterConfigCompartmentResponse changeKafkaClusterConfigCompartment(ChangeKafkaClusterConfigCompartmentRequest request)

Description copied from interface: KafkaCluster

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 KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createKafkaCluster

public CreateKafkaClusterResponse createKafkaCluster(CreateKafkaClusterRequest request)

Description copied from interface: KafkaCluster

Creates a KafkaCluster.

Specified by:

createKafkaCluster in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createKafkaClusterConfig

public CreateKafkaClusterConfigResponse createKafkaClusterConfig(CreateKafkaClusterConfigRequest request)

Description copied from interface: KafkaCluster

Creates a KafkaClusterConfig.

Specified by:

createKafkaClusterConfig in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteKafkaCluster

public DeleteKafkaClusterResponse deleteKafkaCluster(DeleteKafkaClusterRequest request)

Description copied from interface: KafkaCluster

Deletes a KafkaCluster.

Specified by:

deleteKafkaCluster in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteKafkaClusterConfig

public DeleteKafkaClusterConfigResponse deleteKafkaClusterConfig(DeleteKafkaClusterConfigRequest request)

Description copied from interface: KafkaCluster

Deletes a KafkaClusterConfig.

Specified by:

deleteKafkaClusterConfig in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteKafkaClusterConfigVersion

public DeleteKafkaClusterConfigVersionResponse deleteKafkaClusterConfigVersion(DeleteKafkaClusterConfigVersionRequest request)

Description copied from interface: KafkaCluster

Deletes a KafkaClusterConfig version.

Specified by:

deleteKafkaClusterConfigVersion in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

disableSuperuser

public DisableSuperuserResponse disableSuperuser(DisableSuperuserRequest request)

Description copied from interface: KafkaCluster

Removes the SASL superuser to the Kafka cluster.

Specified by:

disableSuperuser in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

enableSuperuser

public EnableSuperuserResponse enableSuperuser(EnableSuperuserRequest request)

Description copied from interface: KafkaCluster

Adds a SASL superuser to the Kafka cluster.

A generated password will be updated to the specified vault.

Specified by:

enableSuperuser in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getKafkaCluster

public GetKafkaClusterResponse getKafkaCluster(GetKafkaClusterRequest request)

Description copied from interface: KafkaCluster

Gets information about a KafkaCluster.

Specified by:

getKafkaCluster in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getKafkaClusterConfig

public GetKafkaClusterConfigResponse getKafkaClusterConfig(GetKafkaClusterConfigRequest request)

Description copied from interface: KafkaCluster

Gets information about a KafkaClusterConfig.

Specified by:

getKafkaClusterConfig in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getKafkaClusterConfigVersion

public GetKafkaClusterConfigVersionResponse getKafkaClusterConfigVersion(GetKafkaClusterConfigVersionRequest request)

Description copied from interface: KafkaCluster

Gets information about a KafkaClusterConfig version.

Specified by:

getKafkaClusterConfigVersion in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: KafkaCluster

Gets the details of a work request.

Specified by:

getWorkRequest in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listKafkaClusterConfigVersions

public ListKafkaClusterConfigVersionsResponse listKafkaClusterConfigVersions(ListKafkaClusterConfigVersionsRequest request)

Description copied from interface: KafkaCluster

Gets a list of KafkaClusterConfig Versions.

Specified by:

listKafkaClusterConfigVersions in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listKafkaClusterConfigs

public ListKafkaClusterConfigsResponse listKafkaClusterConfigs(ListKafkaClusterConfigsRequest request)

Description copied from interface: KafkaCluster

Gets a list of KafkaClusterConfigs.

Specified by:

listKafkaClusterConfigs in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listKafkaClusters

public ListKafkaClustersResponse listKafkaClusters(ListKafkaClustersRequest request)

Description copied from interface: KafkaCluster

Gets a list of KafkaClusters.

Specified by:

listKafkaClusters in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: KafkaCluster

Lists the errors for a work request.

Specified by:

listWorkRequestErrors in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: KafkaCluster

Lists the logs for a work request.

Specified by:

listWorkRequestLogs in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: KafkaCluster

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateKafkaCluster

public UpdateKafkaClusterResponse updateKafkaCluster(UpdateKafkaClusterRequest request)

Description copied from interface: KafkaCluster

Updates a KafkaCluster.

Specified by:

updateKafkaCluster in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateKafkaClusterConfig

public UpdateKafkaClusterConfigResponse updateKafkaClusterConfig(UpdateKafkaClusterConfigRequest request)

Description copied from interface: KafkaCluster

Updates a KafkaClusterConfig.

Specified by:

updateKafkaClusterConfig in interface KafkaCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public KafkaClusterWaiters getWaiters()

Description copied from interface: KafkaCluster

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface KafkaCluster

Returns:

The service waiters.

getPaginators

public KafkaClusterPaginators getPaginators()

Description copied from interface: KafkaCluster

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface KafkaCluster

Returns:

The service paginators.

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()