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