Class KafkaClusterClient

Service client instance for KafkaCluster.

Inheritance

object

ClientBase

RegionalClientBase

KafkaClusterClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ManagedkafkaService

Assembly: OCI.DotNetSDK.Managedkafka.dll

Syntax

public class KafkaClusterClient : RegionalClientBase, IDisposable

Constructors

KafkaClusterClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public KafkaClusterClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public KafkaClusterPaginators Paginators { get; }

Property Value

Type	Description
KafkaClusterPaginators

Waiters

Declaration

public KafkaClusterWaiters Waiters { get; }

Property Value

Type	Description
KafkaClusterWaiters

Methods

CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels a work request.

Declaration

public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CancelWorkRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelWorkRequest API.

ChangeKafkaClusterCompartment(ChangeKafkaClusterCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<ChangeKafkaClusterCompartmentResponse> ChangeKafkaClusterCompartment(ChangeKafkaClusterCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeKafkaClusterCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeKafkaClusterCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeKafkaClusterCompartment API.

ChangeKafkaClusterConfigCompartment(ChangeKafkaClusterConfigCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<ChangeKafkaClusterConfigCompartmentResponse> ChangeKafkaClusterConfigCompartment(ChangeKafkaClusterConfigCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeKafkaClusterConfigCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeKafkaClusterConfigCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeKafkaClusterConfigCompartment API.

CreateKafkaCluster(CreateKafkaClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a KafkaCluster.

Declaration

public Task<CreateKafkaClusterResponse> CreateKafkaCluster(CreateKafkaClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateKafkaClusterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateKafkaClusterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateKafkaCluster API.

CreateKafkaClusterConfig(CreateKafkaClusterConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a KafkaClusterConfig.

Declaration

public Task<CreateKafkaClusterConfigResponse> CreateKafkaClusterConfig(CreateKafkaClusterConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateKafkaClusterConfigRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateKafkaClusterConfigResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateKafkaClusterConfig API.

DeleteKafkaCluster(DeleteKafkaClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a KafkaCluster.

Declaration

public Task<DeleteKafkaClusterResponse> DeleteKafkaCluster(DeleteKafkaClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteKafkaClusterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteKafkaClusterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteKafkaCluster API.

DeleteKafkaClusterConfig(DeleteKafkaClusterConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a KafkaClusterConfig.

Declaration

public Task<DeleteKafkaClusterConfigResponse> DeleteKafkaClusterConfig(DeleteKafkaClusterConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteKafkaClusterConfigRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteKafkaClusterConfigResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteKafkaClusterConfig API.

DeleteKafkaClusterConfigVersion(DeleteKafkaClusterConfigVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a KafkaClusterConfig version.

Declaration

public Task<DeleteKafkaClusterConfigVersionResponse> DeleteKafkaClusterConfigVersion(DeleteKafkaClusterConfigVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteKafkaClusterConfigVersionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteKafkaClusterConfigVersionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteKafkaClusterConfigVersion API.

DisableSuperuser(DisableSuperuserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes the SASL superuser to the Kafka cluster.

Declaration

public Task<DisableSuperuserResponse> DisableSuperuser(DisableSuperuserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DisableSuperuserRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DisableSuperuserResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DisableSuperuser API.

EnableSuperuser(EnableSuperuserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a SASL superuser to the Kafka cluster. A generated password will be updated to the specified vault.

Declaration

public Task<EnableSuperuserResponse> EnableSuperuser(EnableSuperuserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
EnableSuperuserRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<EnableSuperuserResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use EnableSuperuser API.

GetKafkaCluster(GetKafkaClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a KafkaCluster.

Declaration

public Task<GetKafkaClusterResponse> GetKafkaCluster(GetKafkaClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetKafkaClusterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetKafkaClusterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetKafkaCluster API.

GetKafkaClusterConfig(GetKafkaClusterConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a KafkaClusterConfig.

Declaration

public Task<GetKafkaClusterConfigResponse> GetKafkaClusterConfig(GetKafkaClusterConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetKafkaClusterConfigRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetKafkaClusterConfigResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetKafkaClusterConfig API.

GetKafkaClusterConfigVersion(GetKafkaClusterConfigVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a KafkaClusterConfig version.

Declaration

public Task<GetKafkaClusterConfigVersionResponse> GetKafkaClusterConfigVersion(GetKafkaClusterConfigVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetKafkaClusterConfigVersionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetKafkaClusterConfigVersionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetKafkaClusterConfigVersion API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of a work request.

Declaration

public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetWorkRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorkRequest API.

ListKafkaClusterConfigVersions(ListKafkaClusterConfigVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of KafkaClusterConfig Versions.

Declaration

public Task<ListKafkaClusterConfigVersionsResponse> ListKafkaClusterConfigVersions(ListKafkaClusterConfigVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListKafkaClusterConfigVersionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListKafkaClusterConfigVersionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListKafkaClusterConfigVersions API.

ListKafkaClusterConfigs(ListKafkaClusterConfigsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of KafkaClusterConfigs.

Declaration

public Task<ListKafkaClusterConfigsResponse> ListKafkaClusterConfigs(ListKafkaClusterConfigsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListKafkaClusterConfigsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListKafkaClusterConfigsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListKafkaClusterConfigs API.

ListKafkaClusters(ListKafkaClustersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of KafkaClusters.

Declaration

public Task<ListKafkaClustersResponse> ListKafkaClusters(ListKafkaClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListKafkaClustersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListKafkaClustersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListKafkaClusters API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the errors for a work request.

Declaration

public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestErrors API.

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the logs for a work request.

Declaration

public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestLogs API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in a compartment.

Declaration

public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequests API.

UpdateKafkaCluster(UpdateKafkaClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a KafkaCluster.

Declaration

public Task<UpdateKafkaClusterResponse> UpdateKafkaCluster(UpdateKafkaClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateKafkaClusterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateKafkaClusterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateKafkaCluster API.

UpdateKafkaClusterConfig(UpdateKafkaClusterConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a KafkaClusterConfig.

Declaration

public Task<UpdateKafkaClusterConfigResponse> UpdateKafkaClusterConfig(UpdateKafkaClusterConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateKafkaClusterConfigRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateKafkaClusterConfigResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateKafkaClusterConfig API.

Implements

IDisposable