public class ManagedKafka.ManagedKafkaClient : ClientBase<ManagedKafka.ManagedKafkaClient>
Reference documentation and code samples for the Managed Service for Apache Kafka API v1 API class ManagedKafka.ManagedKafkaClient.
Client for ManagedKafka
Inheritance
object > ClientBase > ClientBaseManagedKafkaManagedKafkaClient > ManagedKafka.ManagedKafkaClientNamespace
Google.Cloud.ManagedKafka.V1Assembly
Google.Cloud.ManagedKafka.V1.dll
Constructors
ManagedKafkaClient()
protected ManagedKafkaClient()
Protected parameterless constructor to allow creation of test doubles.
ManagedKafkaClient(CallInvoker)
public ManagedKafkaClient(CallInvoker callInvoker)
Creates a new client for ManagedKafka that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker |
CallInvoker The callInvoker to use to make remote calls. |
ManagedKafkaClient(ChannelBase)
public ManagedKafkaClient(ChannelBase channel)
Creates a new client for ManagedKafka
Parameter | |
---|---|
Name | Description |
channel |
ChannelBase The channel to use to make remote calls. |
ManagedKafkaClient(ClientBaseConfiguration)
protected ManagedKafkaClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration The client configuration. |
Methods
AddAclEntry(AddAclEntryRequest, CallOptions)
public virtual AddAclEntryResponse AddAclEntry(AddAclEntryRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AddAclEntryResponse |
The response received from the server. |
AddAclEntry(AddAclEntryRequest, Metadata, DateTime?, CancellationToken)
public virtual AddAclEntryResponse AddAclEntry(AddAclEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AddAclEntryResponse |
The response received from the server. |
AddAclEntryAsync(AddAclEntryRequest, CallOptions)
public virtual AsyncUnaryCall<AddAclEntryResponse> AddAclEntryAsync(AddAclEntryRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAddAclEntryResponse |
The call object. |
AddAclEntryAsync(AddAclEntryRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<AddAclEntryResponse> AddAclEntryAsync(AddAclEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAddAclEntryResponse |
The call object. |
CreateAcl(CreateAclRequest, CallOptions)
public virtual Acl CreateAcl(CreateAclRequest request, CallOptions options)
Creates a new acl in the given project, location, and cluster.
Parameters | |
---|---|
Name | Description |
request |
CreateAclRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Acl |
The response received from the server. |
CreateAcl(CreateAclRequest, Metadata, DateTime?, CancellationToken)
public virtual Acl CreateAcl(CreateAclRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a new acl in the given project, location, and cluster.
Parameters | |
---|---|
Name | Description |
request |
CreateAclRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Acl |
The response received from the server. |
CreateAclAsync(CreateAclRequest, CallOptions)
public virtual AsyncUnaryCall<Acl> CreateAclAsync(CreateAclRequest request, CallOptions options)
Creates a new acl in the given project, location, and cluster.
Parameters | |
---|---|
Name | Description |
request |
CreateAclRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAcl |
The call object. |
CreateAclAsync(CreateAclRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Acl> CreateAclAsync(CreateAclRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a new acl in the given project, location, and cluster.
Parameters | |
---|---|
Name | Description |
request |
CreateAclRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAcl |
The call object. |
CreateCluster(CreateClusterRequest, CallOptions)
public virtual Operation CreateCluster(CreateClusterRequest request, CallOptions options)
Creates a new cluster in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
CreateClusterRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
CreateCluster(CreateClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateCluster(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a new cluster in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
CreateClusterRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
CreateClusterAsync(CreateClusterRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, CallOptions options)
Creates a new cluster in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
CreateClusterRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateClusterAsync(CreateClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a new cluster in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
CreateClusterRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateLocationsClient()
public virtual Locations.LocationsClient CreateLocationsClient()
Creates a new instance of Locations.LocationsClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
LocationsLocationsClient |
A new Locations.LocationsClient for the same target as this client. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()
Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
OperationsOperationsClient |
A new Operations client for the same target as this client. |
CreateTopic(CreateTopicRequest, CallOptions)
public virtual Topic CreateTopic(CreateTopicRequest request, CallOptions options)
Creates a new topic in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
CreateTopicRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Topic |
The response received from the server. |
CreateTopic(CreateTopicRequest, Metadata, DateTime?, CancellationToken)
public virtual Topic CreateTopic(CreateTopicRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a new topic in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
CreateTopicRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Topic |
The response received from the server. |
CreateTopicAsync(CreateTopicRequest, CallOptions)
public virtual AsyncUnaryCall<Topic> CreateTopicAsync(CreateTopicRequest request, CallOptions options)
Creates a new topic in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
CreateTopicRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallTopic |
The call object. |
CreateTopicAsync(CreateTopicRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Topic> CreateTopicAsync(CreateTopicRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a new topic in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
CreateTopicRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallTopic |
The call object. |
DeleteAcl(DeleteAclRequest, CallOptions)
public virtual Empty DeleteAcl(DeleteAclRequest request, CallOptions options)
Deletes an acl.
Parameters | |
---|---|
Name | Description |
request |
DeleteAclRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteAcl(DeleteAclRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteAcl(DeleteAclRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes an acl.
Parameters | |
---|---|
Name | Description |
request |
DeleteAclRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteAclAsync(DeleteAclRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteAclAsync(DeleteAclRequest request, CallOptions options)
Deletes an acl.
Parameters | |
---|---|
Name | Description |
request |
DeleteAclRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteAclAsync(DeleteAclRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteAclAsync(DeleteAclRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes an acl.
Parameters | |
---|---|
Name | Description |
request |
DeleteAclRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteCluster(DeleteClusterRequest, CallOptions)
public virtual Operation DeleteCluster(DeleteClusterRequest request, CallOptions options)
Deletes a single cluster.
Parameters | |
---|---|
Name | Description |
request |
DeleteClusterRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
DeleteCluster(DeleteClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteCluster(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes a single cluster.
Parameters | |
---|---|
Name | Description |
request |
DeleteClusterRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
DeleteClusterAsync(DeleteClusterRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteClusterAsync(DeleteClusterRequest request, CallOptions options)
Deletes a single cluster.
Parameters | |
---|---|
Name | Description |
request |
DeleteClusterRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteClusterAsync(DeleteClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteClusterAsync(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes a single cluster.
Parameters | |
---|---|
Name | Description |
request |
DeleteClusterRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteConsumerGroup(DeleteConsumerGroupRequest, CallOptions)
public virtual Empty DeleteConsumerGroup(DeleteConsumerGroupRequest request, CallOptions options)
Deletes a single consumer group.
Parameters | |
---|---|
Name | Description |
request |
DeleteConsumerGroupRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteConsumerGroup(DeleteConsumerGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteConsumerGroup(DeleteConsumerGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes a single consumer group.
Parameters | |
---|---|
Name | Description |
request |
DeleteConsumerGroupRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteConsumerGroupAsync(DeleteConsumerGroupRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteConsumerGroupAsync(DeleteConsumerGroupRequest request, CallOptions options)
Deletes a single consumer group.
Parameters | |
---|---|
Name | Description |
request |
DeleteConsumerGroupRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteConsumerGroupAsync(DeleteConsumerGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteConsumerGroupAsync(DeleteConsumerGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes a single consumer group.
Parameters | |
---|---|
Name | Description |
request |
DeleteConsumerGroupRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteTopic(DeleteTopicRequest, CallOptions)
public virtual Empty DeleteTopic(DeleteTopicRequest request, CallOptions options)
Deletes a single topic.
Parameters | |
---|---|
Name | Description |
request |
DeleteTopicRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteTopic(DeleteTopicRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteTopic(DeleteTopicRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes a single topic.
Parameters | |
---|---|
Name | Description |
request |
DeleteTopicRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty |
The response received from the server. |
DeleteTopicAsync(DeleteTopicRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteTopicAsync(DeleteTopicRequest request, CallOptions options)
Deletes a single topic.
Parameters | |
---|---|
Name | Description |
request |
DeleteTopicRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
DeleteTopicAsync(DeleteTopicRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteTopicAsync(DeleteTopicRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Deletes a single topic.
Parameters | |
---|---|
Name | Description |
request |
DeleteTopicRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty |
The call object. |
GetAcl(GetAclRequest, CallOptions)
public virtual Acl GetAcl(GetAclRequest request, CallOptions options)
Returns the properties of a single acl.
Parameters | |
---|---|
Name | Description |
request |
GetAclRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Acl |
The response received from the server. |
GetAcl(GetAclRequest, Metadata, DateTime?, CancellationToken)
public virtual Acl GetAcl(GetAclRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the properties of a single acl.
Parameters | |
---|---|
Name | Description |
request |
GetAclRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Acl |
The response received from the server. |
GetAclAsync(GetAclRequest, CallOptions)
public virtual AsyncUnaryCall<Acl> GetAclAsync(GetAclRequest request, CallOptions options)
Returns the properties of a single acl.
Parameters | |
---|---|
Name | Description |
request |
GetAclRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAcl |
The call object. |
GetAclAsync(GetAclRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Acl> GetAclAsync(GetAclRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the properties of a single acl.
Parameters | |
---|---|
Name | Description |
request |
GetAclRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAcl |
The call object. |
GetCluster(GetClusterRequest, CallOptions)
public virtual Cluster GetCluster(GetClusterRequest request, CallOptions options)
Returns the properties of a single cluster.
Parameters | |
---|---|
Name | Description |
request |
GetClusterRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Cluster |
The response received from the server. |
GetCluster(GetClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual Cluster GetCluster(GetClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the properties of a single cluster.
Parameters | |
---|---|
Name | Description |
request |
GetClusterRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Cluster |
The response received from the server. |
GetClusterAsync(GetClusterRequest, CallOptions)
public virtual AsyncUnaryCall<Cluster> GetClusterAsync(GetClusterRequest request, CallOptions options)
Returns the properties of a single cluster.
Parameters | |
---|---|
Name | Description |
request |
GetClusterRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallCluster |
The call object. |
GetClusterAsync(GetClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Cluster> GetClusterAsync(GetClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the properties of a single cluster.
Parameters | |
---|---|
Name | Description |
request |
GetClusterRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallCluster |
The call object. |
GetConsumerGroup(GetConsumerGroupRequest, CallOptions)
public virtual ConsumerGroup GetConsumerGroup(GetConsumerGroupRequest request, CallOptions options)
Returns the properties of a single consumer group.
Parameters | |
---|---|
Name | Description |
request |
GetConsumerGroupRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ConsumerGroup |
The response received from the server. |
GetConsumerGroup(GetConsumerGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual ConsumerGroup GetConsumerGroup(GetConsumerGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the properties of a single consumer group.
Parameters | |
---|---|
Name | Description |
request |
GetConsumerGroupRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ConsumerGroup |
The response received from the server. |
GetConsumerGroupAsync(GetConsumerGroupRequest, CallOptions)
public virtual AsyncUnaryCall<ConsumerGroup> GetConsumerGroupAsync(GetConsumerGroupRequest request, CallOptions options)
Returns the properties of a single consumer group.
Parameters | |
---|---|
Name | Description |
request |
GetConsumerGroupRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallConsumerGroup |
The call object. |
GetConsumerGroupAsync(GetConsumerGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ConsumerGroup> GetConsumerGroupAsync(GetConsumerGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the properties of a single consumer group.
Parameters | |
---|---|
Name | Description |
request |
GetConsumerGroupRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallConsumerGroup |
The call object. |
GetTopic(GetTopicRequest, CallOptions)
public virtual Topic GetTopic(GetTopicRequest request, CallOptions options)
Returns the properties of a single topic.
Parameters | |
---|---|
Name | Description |
request |
GetTopicRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Topic |
The response received from the server. |
GetTopic(GetTopicRequest, Metadata, DateTime?, CancellationToken)
public virtual Topic GetTopic(GetTopicRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the properties of a single topic.
Parameters | |
---|---|
Name | Description |
request |
GetTopicRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Topic |
The response received from the server. |
GetTopicAsync(GetTopicRequest, CallOptions)
public virtual AsyncUnaryCall<Topic> GetTopicAsync(GetTopicRequest request, CallOptions options)
Returns the properties of a single topic.
Parameters | |
---|---|
Name | Description |
request |
GetTopicRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallTopic |
The call object. |
GetTopicAsync(GetTopicRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Topic> GetTopicAsync(GetTopicRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Returns the properties of a single topic.
Parameters | |
---|---|
Name | Description |
request |
GetTopicRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallTopic |
The call object. |
ListAcls(ListAclsRequest, CallOptions)
public virtual ListAclsResponse ListAcls(ListAclsRequest request, CallOptions options)
Lists the acls in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
ListAclsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListAclsResponse |
The response received from the server. |
ListAcls(ListAclsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListAclsResponse ListAcls(ListAclsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists the acls in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
ListAclsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListAclsResponse |
The response received from the server. |
ListAclsAsync(ListAclsRequest, CallOptions)
public virtual AsyncUnaryCall<ListAclsResponse> ListAclsAsync(ListAclsRequest request, CallOptions options)
Lists the acls in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
ListAclsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListAclsResponse |
The call object. |
ListAclsAsync(ListAclsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListAclsResponse> ListAclsAsync(ListAclsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists the acls in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
ListAclsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListAclsResponse |
The call object. |
ListClusters(ListClustersRequest, CallOptions)
public virtual ListClustersResponse ListClusters(ListClustersRequest request, CallOptions options)
Lists the clusters in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
ListClustersRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListClustersResponse |
The response received from the server. |
ListClusters(ListClustersRequest, Metadata, DateTime?, CancellationToken)
public virtual ListClustersResponse ListClusters(ListClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists the clusters in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
ListClustersRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListClustersResponse |
The response received from the server. |
ListClustersAsync(ListClustersRequest, CallOptions)
public virtual AsyncUnaryCall<ListClustersResponse> ListClustersAsync(ListClustersRequest request, CallOptions options)
Lists the clusters in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
ListClustersRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListClustersResponse |
The call object. |
ListClustersAsync(ListClustersRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListClustersResponse> ListClustersAsync(ListClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists the clusters in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
ListClustersRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListClustersResponse |
The call object. |
ListConsumerGroups(ListConsumerGroupsRequest, CallOptions)
public virtual ListConsumerGroupsResponse ListConsumerGroups(ListConsumerGroupsRequest request, CallOptions options)
Lists the consumer groups in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
ListConsumerGroupsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListConsumerGroupsResponse |
The response received from the server. |
ListConsumerGroups(ListConsumerGroupsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListConsumerGroupsResponse ListConsumerGroups(ListConsumerGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists the consumer groups in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
ListConsumerGroupsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListConsumerGroupsResponse |
The response received from the server. |
ListConsumerGroupsAsync(ListConsumerGroupsRequest, CallOptions)
public virtual AsyncUnaryCall<ListConsumerGroupsResponse> ListConsumerGroupsAsync(ListConsumerGroupsRequest request, CallOptions options)
Lists the consumer groups in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
ListConsumerGroupsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListConsumerGroupsResponse |
The call object. |
ListConsumerGroupsAsync(ListConsumerGroupsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListConsumerGroupsResponse> ListConsumerGroupsAsync(ListConsumerGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists the consumer groups in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
ListConsumerGroupsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListConsumerGroupsResponse |
The call object. |
ListTopics(ListTopicsRequest, CallOptions)
public virtual ListTopicsResponse ListTopics(ListTopicsRequest request, CallOptions options)
Lists the topics in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
ListTopicsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListTopicsResponse |
The response received from the server. |
ListTopics(ListTopicsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListTopicsResponse ListTopics(ListTopicsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists the topics in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
ListTopicsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListTopicsResponse |
The response received from the server. |
ListTopicsAsync(ListTopicsRequest, CallOptions)
public virtual AsyncUnaryCall<ListTopicsResponse> ListTopicsAsync(ListTopicsRequest request, CallOptions options)
Lists the topics in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
ListTopicsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListTopicsResponse |
The call object. |
ListTopicsAsync(ListTopicsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListTopicsResponse> ListTopicsAsync(ListTopicsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Lists the topics in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
ListTopicsRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListTopicsResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override ManagedKafka.ManagedKafkaClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
ManagedKafkaManagedKafkaClient |
RemoveAclEntry(RemoveAclEntryRequest, CallOptions)
public virtual RemoveAclEntryResponse RemoveAclEntry(RemoveAclEntryRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
RemoveAclEntryResponse |
The response received from the server. |
RemoveAclEntry(RemoveAclEntryRequest, Metadata, DateTime?, CancellationToken)
public virtual RemoveAclEntryResponse RemoveAclEntry(RemoveAclEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
RemoveAclEntryResponse |
The response received from the server. |
RemoveAclEntryAsync(RemoveAclEntryRequest, CallOptions)
public virtual AsyncUnaryCall<RemoveAclEntryResponse> RemoveAclEntryAsync(RemoveAclEntryRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallRemoveAclEntryResponse |
The call object. |
RemoveAclEntryAsync(RemoveAclEntryRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<RemoveAclEntryResponse> RemoveAclEntryAsync(RemoveAclEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallRemoveAclEntryResponse |
The call object. |
UpdateAcl(UpdateAclRequest, CallOptions)
public virtual Acl UpdateAcl(UpdateAclRequest request, CallOptions options)
Updates the properties of a single acl.
Parameters | |
---|---|
Name | Description |
request |
UpdateAclRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Acl |
The response received from the server. |
UpdateAcl(UpdateAclRequest, Metadata, DateTime?, CancellationToken)
public virtual Acl UpdateAcl(UpdateAclRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the properties of a single acl.
Parameters | |
---|---|
Name | Description |
request |
UpdateAclRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Acl |
The response received from the server. |
UpdateAclAsync(UpdateAclRequest, CallOptions)
public virtual AsyncUnaryCall<Acl> UpdateAclAsync(UpdateAclRequest request, CallOptions options)
Updates the properties of a single acl.
Parameters | |
---|---|
Name | Description |
request |
UpdateAclRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAcl |
The call object. |
UpdateAclAsync(UpdateAclRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Acl> UpdateAclAsync(UpdateAclRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the properties of a single acl.
Parameters | |
---|---|
Name | Description |
request |
UpdateAclRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallAcl |
The call object. |
UpdateCluster(UpdateClusterRequest, CallOptions)
public virtual Operation UpdateCluster(UpdateClusterRequest request, CallOptions options)
Updates the properties of a single cluster.
Parameters | |
---|---|
Name | Description |
request |
UpdateClusterRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
UpdateCluster(UpdateClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpdateCluster(UpdateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the properties of a single cluster.
Parameters | |
---|---|
Name | Description |
request |
UpdateClusterRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation |
The response received from the server. |
UpdateClusterAsync(UpdateClusterRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateClusterAsync(UpdateClusterRequest request, CallOptions options)
Updates the properties of a single cluster.
Parameters | |
---|---|
Name | Description |
request |
UpdateClusterRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateClusterAsync(UpdateClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateClusterAsync(UpdateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the properties of a single cluster.
Parameters | |
---|---|
Name | Description |
request |
UpdateClusterRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateConsumerGroup(UpdateConsumerGroupRequest, CallOptions)
public virtual ConsumerGroup UpdateConsumerGroup(UpdateConsumerGroupRequest request, CallOptions options)
Updates the properties of a single consumer group.
Parameters | |
---|---|
Name | Description |
request |
UpdateConsumerGroupRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ConsumerGroup |
The response received from the server. |
UpdateConsumerGroup(UpdateConsumerGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual ConsumerGroup UpdateConsumerGroup(UpdateConsumerGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the properties of a single consumer group.
Parameters | |
---|---|
Name | Description |
request |
UpdateConsumerGroupRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ConsumerGroup |
The response received from the server. |
UpdateConsumerGroupAsync(UpdateConsumerGroupRequest, CallOptions)
public virtual AsyncUnaryCall<ConsumerGroup> UpdateConsumerGroupAsync(UpdateConsumerGroupRequest request, CallOptions options)
Updates the properties of a single consumer group.
Parameters | |
---|---|
Name | Description |
request |
UpdateConsumerGroupRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallConsumerGroup |
The call object. |
UpdateConsumerGroupAsync(UpdateConsumerGroupRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ConsumerGroup> UpdateConsumerGroupAsync(UpdateConsumerGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the properties of a single consumer group.
Parameters | |
---|---|
Name | Description |
request |
UpdateConsumerGroupRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallConsumerGroup |
The call object. |
UpdateTopic(UpdateTopicRequest, CallOptions)
public virtual Topic UpdateTopic(UpdateTopicRequest request, CallOptions options)
Updates the properties of a single topic.
Parameters | |
---|---|
Name | Description |
request |
UpdateTopicRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Topic |
The response received from the server. |
UpdateTopic(UpdateTopicRequest, Metadata, DateTime?, CancellationToken)
public virtual Topic UpdateTopic(UpdateTopicRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the properties of a single topic.
Parameters | |
---|---|
Name | Description |
request |
UpdateTopicRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Topic |
The response received from the server. |
UpdateTopicAsync(UpdateTopicRequest, CallOptions)
public virtual AsyncUnaryCall<Topic> UpdateTopicAsync(UpdateTopicRequest request, CallOptions options)
Updates the properties of a single topic.
Parameters | |
---|---|
Name | Description |
request |
UpdateTopicRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallTopic |
The call object. |
UpdateTopicAsync(UpdateTopicRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Topic> UpdateTopicAsync(UpdateTopicRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Updates the properties of a single topic.
Parameters | |
---|---|
Name | Description |
request |
UpdateTopicRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallTopic |
The call object. |