public sealed class ManagedKafkaClientImpl : ManagedKafkaClientReference documentation and code samples for the Managed Service for Apache Kafka API v1 API class ManagedKafkaClientImpl.
ManagedKafka client wrapper implementation, for convenient use.
Namespace
Google.Cloud.ManagedKafka.V1Assembly
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 |
ManagedKafkaManagedKafkaClientThe underlying gRPC client. |
settings |
ManagedKafkaSettingsThe base ManagedKafkaSettings used within this client. |
logger |
ILoggerOptional 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 |
|
DeleteClusterOperationsClient
public override OperationsClient DeleteClusterOperationsClient { get; }The long-running operations client for DeleteCluster.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
GrpcClient
public override ManagedKafka.ManagedKafkaClient GrpcClient { get; }The underlying gRPC ManagedKafka client
| Property Value | |
|---|---|
| Type | Description |
ManagedKafkaManagedKafkaClient |
|
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient |
|
UpdateClusterOperationsClient
public override OperationsClient UpdateClusterOperationsClient { get; }The long-running operations client for UpdateCluster.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
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 |
AddAclEntryRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AddAclEntryResponse |
The RPC response. |
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 |
AddAclEntryRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAddAclEntryResponse |
A Task containing the RPC response. |
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 |
CreateAclRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Acl |
The RPC response. |
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 |
CreateAclRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAcl |
A Task containing the RPC response. |
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 |
CreateClusterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationClusterOperationMetadata |
The RPC response. |
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 |
CreateClusterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationClusterOperationMetadata |
A Task containing the RPC response. |
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 |
CreateTopicRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Topic |
The RPC response. |
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 |
CreateTopicRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTopic |
A Task containing the RPC response. |
DeleteAcl(DeleteAclRequest, CallSettings)
public override void DeleteAcl(DeleteAclRequest request, CallSettings callSettings = null)Deletes an acl.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAclRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
DeleteAclAsync(DeleteAclRequest, CallSettings)
public override Task DeleteAclAsync(DeleteAclRequest request, CallSettings callSettings = null)Deletes an acl.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAclRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task |
A Task containing the RPC response. |
DeleteCluster(DeleteClusterRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteCluster(DeleteClusterRequest request, CallSettings callSettings = null)Deletes a single cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteClusterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata |
The RPC response. |
DeleteClusterAsync(DeleteClusterRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteClusterAsync(DeleteClusterRequest request, CallSettings callSettings = null)Deletes a single cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteClusterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata |
A Task containing the RPC response. |
DeleteConsumerGroup(DeleteConsumerGroupRequest, CallSettings)
public override void DeleteConsumerGroup(DeleteConsumerGroupRequest request, CallSettings callSettings = null)Deletes a single consumer group.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteConsumerGroupRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
DeleteConsumerGroupAsync(DeleteConsumerGroupRequest, CallSettings)
public override Task DeleteConsumerGroupAsync(DeleteConsumerGroupRequest request, CallSettings callSettings = null)Deletes a single consumer group.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteConsumerGroupRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task |
A Task containing the RPC response. |
DeleteTopic(DeleteTopicRequest, CallSettings)
public override void DeleteTopic(DeleteTopicRequest request, CallSettings callSettings = null)Deletes a single topic.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTopicRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
DeleteTopicAsync(DeleteTopicRequest, CallSettings)
public override Task DeleteTopicAsync(DeleteTopicRequest request, CallSettings callSettings = null)Deletes a single topic.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTopicRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task |
A Task containing the RPC response. |
GetAcl(GetAclRequest, CallSettings)
public override Acl GetAcl(GetAclRequest request, CallSettings callSettings = null)Returns the properties of a single acl.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAclRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Acl |
The RPC response. |
GetAclAsync(GetAclRequest, CallSettings)
public override Task<Acl> GetAclAsync(GetAclRequest request, CallSettings callSettings = null)Returns the properties of a single acl.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAclRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAcl |
A Task containing the RPC response. |
GetCluster(GetClusterRequest, CallSettings)
public override Cluster GetCluster(GetClusterRequest request, CallSettings callSettings = null)Returns the properties of a single cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Cluster |
The RPC response. |
GetClusterAsync(GetClusterRequest, CallSettings)
public override Task<Cluster> GetClusterAsync(GetClusterRequest request, CallSettings callSettings = null)Returns the properties of a single cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCluster |
A Task containing the RPC response. |
GetConsumerGroup(GetConsumerGroupRequest, CallSettings)
public override ConsumerGroup GetConsumerGroup(GetConsumerGroupRequest request, CallSettings callSettings = null)Returns the properties of a single consumer group.
| Parameters | |
|---|---|
| Name | Description |
request |
GetConsumerGroupRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ConsumerGroup |
The RPC response. |
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 |
GetConsumerGroupRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskConsumerGroup |
A Task containing the RPC response. |
GetTopic(GetTopicRequest, CallSettings)
public override Topic GetTopic(GetTopicRequest request, CallSettings callSettings = null)Returns the properties of a single topic.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTopicRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Topic |
The RPC response. |
GetTopicAsync(GetTopicRequest, CallSettings)
public override Task<Topic> GetTopicAsync(GetTopicRequest request, CallSettings callSettings = null)Returns the properties of a single topic.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTopicRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTopic |
A Task containing the RPC response. |
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 |
ListAclsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListAclsResponseAcl |
A pageable sequence of Acl resources. |
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 |
ListAclsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListAclsResponseAcl |
A pageable asynchronous sequence of Acl resources. |
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 |
ListClustersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListClustersResponseCluster |
A pageable sequence of Cluster resources. |
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 |
ListClustersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListClustersResponseCluster |
A pageable asynchronous sequence of Cluster resources. |
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 |
ListConsumerGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListConsumerGroupsResponseConsumerGroup |
A pageable sequence of ConsumerGroup resources. |
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 |
ListConsumerGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListConsumerGroupsResponseConsumerGroup |
A pageable asynchronous sequence of ConsumerGroup resources. |
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 |
ListTopicsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListTopicsResponseTopic |
A pageable sequence of Topic resources. |
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 |
ListTopicsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListTopicsResponseTopic |
A pageable asynchronous sequence of Topic resources. |
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 |
RemoveAclEntryRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
RemoveAclEntryResponse |
The RPC response. |
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 |
RemoveAclEntryRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskRemoveAclEntryResponse |
A Task containing the RPC response. |
UpdateAcl(UpdateAclRequest, CallSettings)
public override Acl UpdateAcl(UpdateAclRequest request, CallSettings callSettings = null)Updates the properties of a single acl.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAclRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Acl |
The RPC response. |
UpdateAclAsync(UpdateAclRequest, CallSettings)
public override Task<Acl> UpdateAclAsync(UpdateAclRequest request, CallSettings callSettings = null)Updates the properties of a single acl.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAclRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAcl |
A Task containing the RPC response. |
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 |
UpdateClusterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationClusterOperationMetadata |
The RPC response. |
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 |
UpdateClusterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationClusterOperationMetadata |
A Task containing the RPC response. |
UpdateConsumerGroup(UpdateConsumerGroupRequest, CallSettings)
public override ConsumerGroup UpdateConsumerGroup(UpdateConsumerGroupRequest request, CallSettings callSettings = null)Updates the properties of a single consumer group.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateConsumerGroupRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ConsumerGroup |
The RPC response. |
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 |
UpdateConsumerGroupRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskConsumerGroup |
A Task containing the RPC response. |
UpdateTopic(UpdateTopicRequest, CallSettings)
public override Topic UpdateTopic(UpdateTopicRequest request, CallSettings callSettings = null)Updates the properties of a single topic.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateTopicRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Topic |
The RPC response. |
UpdateTopicAsync(UpdateTopicRequest, CallSettings)
public override Task<Topic> UpdateTopicAsync(UpdateTopicRequest request, CallSettings callSettings = null)Updates the properties of a single topic.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateTopicRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTopic |
A Task containing the RPC response. |