Managed Service for Apache Kafka API v1 API - Class ManagedKafkaClientImpl (1.0.0-beta06) 

public sealed class ManagedKafkaClientImpl : ManagedKafkaClient

Reference documentation and code samples for the Managed Service for Apache Kafka API v1 API class ManagedKafkaClientImpl.

ManagedKafka client wrapper implementation, for convenient use.

Inheritance

object > ManagedKafkaClient > ManagedKafkaClientImpl

Namespace

Google.Cloud.ManagedKafka.V1

Assembly

Google.Cloud.ManagedKafka.V1.dll

Remarks

The service that a client application uses to manage Apache Kafka clusters, topics and consumer groups.

Constructors

ManagedKafkaClientImpl(ManagedKafkaClient, ManagedKafkaSettings, ILogger)

public ManagedKafkaClientImpl(ManagedKafka.ManagedKafkaClient grpcClient, ManagedKafkaSettings settings, ILogger logger)

Constructs a client wrapper for the ManagedKafka service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient ManagedKafkaManagedKafkaClient

The underlying gRPC client.
settings ManagedKafkaSettings

The base ManagedKafkaSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateClusterOperationsClient

public override OperationsClient CreateClusterOperationsClient { get; }

The long-running operations client for CreateCluster.

Property Value
Type Description
OperationsClient
Overrides

DeleteClusterOperationsClient

public override OperationsClient DeleteClusterOperationsClient { get; }

The long-running operations client for DeleteCluster.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override ManagedKafka.ManagedKafkaClient GrpcClient { get; }

The underlying gRPC ManagedKafka client

Property Value
Type Description
ManagedKafkaManagedKafkaClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateClusterOperationsClient

public override OperationsClient UpdateClusterOperationsClient { get; }

The long-running operations client for UpdateCluster.

Property Value
Type Description
OperationsClient
Overrides

Methods

AddAclEntry(AddAclEntryRequest, CallSettings)

public override AddAclEntryResponse AddAclEntry(AddAclEntryRequest request, CallSettings callSettings = null)

Incremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet.

Parameters
Name Description
request AddAclEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AddAclEntryResponse

The RPC response.
Overrides

AddAclEntryAsync(AddAclEntryRequest, CallSettings)

public override Task<AddAclEntryResponse> AddAclEntryAsync(AddAclEntryRequest request, CallSettings callSettings = null)

Incremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet.

Parameters
Name Description
request AddAclEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAddAclEntryResponse

A Task containing the RPC response.
Overrides

CreateAcl(CreateAclRequest, CallSettings)

public override Acl CreateAcl(CreateAclRequest request, CallSettings callSettings = null)

Creates a new acl in the given project, location, and cluster.

Parameters
Name Description
request CreateAclRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Acl

The RPC response.
Overrides

CreateAclAsync(CreateAclRequest, CallSettings)

public override Task<Acl> CreateAclAsync(CreateAclRequest request, CallSettings callSettings = null)

Creates a new acl in the given project, location, and cluster.

Parameters
Name Description
request CreateAclRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAcl

A Task containing the RPC response.
Overrides

CreateCluster(CreateClusterRequest, CallSettings)

public override Operation<Cluster, OperationMetadata> CreateCluster(CreateClusterRequest request, CallSettings callSettings = null)

Creates a new cluster in a given project and location.

Parameters
Name Description
request CreateClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationClusterOperationMetadata

The RPC response.
Overrides

CreateClusterAsync(CreateClusterRequest, CallSettings)

public override Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(CreateClusterRequest request, CallSettings callSettings = null)

Creates a new cluster in a given project and location.

Parameters
Name Description
request CreateClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.
Overrides

CreateTopic(CreateTopicRequest, CallSettings)

public override Topic CreateTopic(CreateTopicRequest request, CallSettings callSettings = null)

Creates a new topic in a given project and location.

Parameters
Name Description
request CreateTopicRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Topic

The RPC response.
Overrides

CreateTopicAsync(CreateTopicRequest, CallSettings)

public override Task<Topic> CreateTopicAsync(CreateTopicRequest request, CallSettings callSettings = null)

Creates a new topic in a given project and location.

Parameters
Name Description
request CreateTopicRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTopic

A Task containing the RPC response.
Overrides

DeleteAcl(DeleteAclRequest, CallSettings)

public override void DeleteAcl(DeleteAclRequest request, CallSettings callSettings = null)

Deletes an acl.

Parameters
Name Description
request DeleteAclRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteAclAsync(DeleteAclRequest, CallSettings)

public override Task DeleteAclAsync(DeleteAclRequest request, CallSettings callSettings = null)

Deletes an acl.

Parameters
Name Description
request DeleteAclRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteCluster(DeleteClusterRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteCluster(DeleteClusterRequest request, CallSettings callSettings = null)

Deletes a single cluster.

Parameters
Name Description
request DeleteClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteClusterAsync(DeleteClusterRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteClusterAsync(DeleteClusterRequest request, CallSettings callSettings = null)

Deletes a single cluster.

Parameters
Name Description
request DeleteClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteConsumerGroup(DeleteConsumerGroupRequest, CallSettings)

public override void DeleteConsumerGroup(DeleteConsumerGroupRequest request, CallSettings callSettings = null)

Deletes a single consumer group.

Parameters
Name Description
request DeleteConsumerGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteConsumerGroupAsync(DeleteConsumerGroupRequest, CallSettings)

public override Task DeleteConsumerGroupAsync(DeleteConsumerGroupRequest request, CallSettings callSettings = null)

Deletes a single consumer group.

Parameters
Name Description
request DeleteConsumerGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteTopic(DeleteTopicRequest, CallSettings)

public override void DeleteTopic(DeleteTopicRequest request, CallSettings callSettings = null)

Deletes a single topic.

Parameters
Name Description
request DeleteTopicRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteTopicAsync(DeleteTopicRequest, CallSettings)

public override Task DeleteTopicAsync(DeleteTopicRequest request, CallSettings callSettings = null)

Deletes a single topic.

Parameters
Name Description
request DeleteTopicRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

GetAcl(GetAclRequest, CallSettings)

public override Acl GetAcl(GetAclRequest request, CallSettings callSettings = null)

Returns the properties of a single acl.

Parameters
Name Description
request GetAclRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Acl

The RPC response.
Overrides

GetAclAsync(GetAclRequest, CallSettings)

public override Task<Acl> GetAclAsync(GetAclRequest request, CallSettings callSettings = null)

Returns the properties of a single acl.

Parameters
Name Description
request GetAclRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAcl

A Task containing the RPC response.
Overrides

GetCluster(GetClusterRequest, CallSettings)

public override Cluster GetCluster(GetClusterRequest request, CallSettings callSettings = null)

Returns the properties of a single cluster.

Parameters
Name Description
request GetClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Cluster

The RPC response.
Overrides

GetClusterAsync(GetClusterRequest, CallSettings)

public override Task<Cluster> GetClusterAsync(GetClusterRequest request, CallSettings callSettings = null)

Returns the properties of a single cluster.

Parameters
Name Description
request GetClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCluster

A Task containing the RPC response.
Overrides

GetConsumerGroup(GetConsumerGroupRequest, CallSettings)

public override ConsumerGroup GetConsumerGroup(GetConsumerGroupRequest request, CallSettings callSettings = null)

Returns the properties of a single consumer group.

Parameters
Name Description
request GetConsumerGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ConsumerGroup

The RPC response.
Overrides

GetConsumerGroupAsync(GetConsumerGroupRequest, CallSettings)

public override Task<ConsumerGroup> GetConsumerGroupAsync(GetConsumerGroupRequest request, CallSettings callSettings = null)

Returns the properties of a single consumer group.

Parameters
Name Description
request GetConsumerGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskConsumerGroup

A Task containing the RPC response.
Overrides

GetTopic(GetTopicRequest, CallSettings)

public override Topic GetTopic(GetTopicRequest request, CallSettings callSettings = null)

Returns the properties of a single topic.

Parameters
Name Description
request GetTopicRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Topic

The RPC response.
Overrides

GetTopicAsync(GetTopicRequest, CallSettings)

public override Task<Topic> GetTopicAsync(GetTopicRequest request, CallSettings callSettings = null)

Returns the properties of a single topic.

Parameters
Name Description
request GetTopicRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTopic

A Task containing the RPC response.
Overrides

ListAcls(ListAclsRequest, CallSettings)

public override PagedEnumerable<ListAclsResponse, Acl> ListAcls(ListAclsRequest request, CallSettings callSettings = null)

Lists the acls in a given cluster.

Parameters
Name Description
request ListAclsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListAclsResponseAcl

A pageable sequence of Acl resources.
Overrides

ListAclsAsync(ListAclsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAclsResponse, Acl> ListAclsAsync(ListAclsRequest request, CallSettings callSettings = null)

Lists the acls in a given cluster.

Parameters
Name Description
request ListAclsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListAclsResponseAcl

A pageable asynchronous sequence of Acl resources.
Overrides

ListClusters(ListClustersRequest, CallSettings)

public override PagedEnumerable<ListClustersResponse, Cluster> ListClusters(ListClustersRequest request, CallSettings callSettings = null)

Lists the clusters in a given project and location.

Parameters
Name Description
request ListClustersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListClustersResponseCluster

A pageable sequence of Cluster resources.
Overrides

ListClustersAsync(ListClustersRequest, CallSettings)

public override PagedAsyncEnumerable<ListClustersResponse, Cluster> ListClustersAsync(ListClustersRequest request, CallSettings callSettings = null)

Lists the clusters in a given project and location.

Parameters
Name Description
request ListClustersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListClustersResponseCluster

A pageable asynchronous sequence of Cluster resources.
Overrides

ListConsumerGroups(ListConsumerGroupsRequest, CallSettings)

public override PagedEnumerable<ListConsumerGroupsResponse, ConsumerGroup> ListConsumerGroups(ListConsumerGroupsRequest request, CallSettings callSettings = null)

Lists the consumer groups in a given cluster.

Parameters
Name Description
request ListConsumerGroupsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListConsumerGroupsResponseConsumerGroup

A pageable sequence of ConsumerGroup resources.
Overrides

ListConsumerGroupsAsync(ListConsumerGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<ListConsumerGroupsResponse, ConsumerGroup> ListConsumerGroupsAsync(ListConsumerGroupsRequest request, CallSettings callSettings = null)

Lists the consumer groups in a given cluster.

Parameters
Name Description
request ListConsumerGroupsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListConsumerGroupsResponseConsumerGroup

A pageable asynchronous sequence of ConsumerGroup resources.
Overrides

ListTopics(ListTopicsRequest, CallSettings)

public override PagedEnumerable<ListTopicsResponse, Topic> ListTopics(ListTopicsRequest request, CallSettings callSettings = null)

Lists the topics in a given cluster.

Parameters
Name Description
request ListTopicsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTopicsResponseTopic

A pageable sequence of Topic resources.
Overrides

ListTopicsAsync(ListTopicsRequest, CallSettings)

public override PagedAsyncEnumerable<ListTopicsResponse, Topic> ListTopicsAsync(ListTopicsRequest request, CallSettings callSettings = null)

Lists the topics in a given cluster.

Parameters
Name Description
request ListTopicsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTopicsResponseTopic

A pageable asynchronous sequence of Topic resources.
Overrides

RemoveAclEntry(RemoveAclEntryRequest, CallSettings)

public override RemoveAclEntryResponse RemoveAclEntry(RemoveAclEntryRequest request, CallSettings callSettings = null)

Incremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl).

Parameters
Name Description
request RemoveAclEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RemoveAclEntryResponse

The RPC response.
Overrides

RemoveAclEntryAsync(RemoveAclEntryRequest, CallSettings)

public override Task<RemoveAclEntryResponse> RemoveAclEntryAsync(RemoveAclEntryRequest request, CallSettings callSettings = null)

Incremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl).

Parameters
Name Description
request RemoveAclEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRemoveAclEntryResponse

A Task containing the RPC response.
Overrides

UpdateAcl(UpdateAclRequest, CallSettings)

public override Acl UpdateAcl(UpdateAclRequest request, CallSettings callSettings = null)

Updates the properties of a single acl.

Parameters
Name Description
request UpdateAclRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Acl

The RPC response.
Overrides

UpdateAclAsync(UpdateAclRequest, CallSettings)

public override Task<Acl> UpdateAclAsync(UpdateAclRequest request, CallSettings callSettings = null)

Updates the properties of a single acl.

Parameters
Name Description
request UpdateAclRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAcl

A Task containing the RPC response.
Overrides

UpdateCluster(UpdateClusterRequest, CallSettings)

public override Operation<Cluster, OperationMetadata> UpdateCluster(UpdateClusterRequest request, CallSettings callSettings = null)

Updates the properties of a single cluster.

Parameters
Name Description
request UpdateClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationClusterOperationMetadata

The RPC response.
Overrides

UpdateClusterAsync(UpdateClusterRequest, CallSettings)

public override Task<Operation<Cluster, OperationMetadata>> UpdateClusterAsync(UpdateClusterRequest request, CallSettings callSettings = null)

Updates the properties of a single cluster.

Parameters
Name Description
request UpdateClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.
Overrides

UpdateConsumerGroup(UpdateConsumerGroupRequest, CallSettings)

public override ConsumerGroup UpdateConsumerGroup(UpdateConsumerGroupRequest request, CallSettings callSettings = null)

Updates the properties of a single consumer group.

Parameters
Name Description
request UpdateConsumerGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ConsumerGroup

The RPC response.
Overrides

UpdateConsumerGroupAsync(UpdateConsumerGroupRequest, CallSettings)

public override Task<ConsumerGroup> UpdateConsumerGroupAsync(UpdateConsumerGroupRequest request, CallSettings callSettings = null)

Updates the properties of a single consumer group.

Parameters
Name Description
request UpdateConsumerGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskConsumerGroup

A Task containing the RPC response.
Overrides

UpdateTopic(UpdateTopicRequest, CallSettings)

public override Topic UpdateTopic(UpdateTopicRequest request, CallSettings callSettings = null)

Updates the properties of a single topic.

Parameters
Name Description
request UpdateTopicRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Topic

The RPC response.
Overrides

UpdateTopicAsync(UpdateTopicRequest, CallSettings)

public override Task<Topic> UpdateTopicAsync(UpdateTopicRequest request, CallSettings callSettings = null)

Updates the properties of a single topic.

Parameters
Name Description
request UpdateTopicRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTopic

A Task containing the RPC response.
Overrides