Managed Service for Apache Kafka API v1 API - Class ManagedKafkaClient (1.0.0-beta01)

public abstract class ManagedKafkaClient

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

ManagedKafka client wrapper, for convenient use.

Inheritance

object > ManagedKafkaClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

ManagedKafkaClientImpl

Namespace

Google.Cloud.ManagedKafka.V1

Assembly

Google.Cloud.ManagedKafka.V1.dll

Remarks

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

Properties

CreateClusterOperationsClient

public virtual OperationsClient CreateClusterOperationsClient { get; }

The long-running operations client for CreateCluster.

Property Value
Type	Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ManagedKafka service, which is a host of "managedkafka.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ManagedKafka scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default ManagedKafka scopes are:

• https://www.googleapis.com/auth/cloud-platform

DeleteClusterOperationsClient

public virtual OperationsClient DeleteClusterOperationsClient { get; }

The long-running operations client for DeleteCluster.

Property Value
Type	Description
OperationsClient

GrpcClient

public virtual ManagedKafka.ManagedKafkaClient GrpcClient { get; }

The underlying gRPC ManagedKafka client

Property Value
Type	Description
ManagedKafkaManagedKafkaClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

UpdateClusterOperationsClient

public virtual OperationsClient UpdateClusterOperationsClient { get; }

The long-running operations client for UpdateCluster.

Property Value
Type	Description
OperationsClient

Methods

Create()

public static ManagedKafkaClient Create()

Synchronously creates a ManagedKafkaClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ManagedKafkaClientBuilder.

Returns
Type	Description
ManagedKafkaClient	The created ManagedKafkaClient.

CreateAsync(CancellationToken)

public static Task<ManagedKafkaClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a ManagedKafkaClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ManagedKafkaClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskManagedKafkaClient	The task representing the created ManagedKafkaClient.

CreateCluster(LocationName, Cluster, string, CallSettings)

public virtual Operation<Cluster, OperationMetadata> CreateCluster(LocationName parent, Cluster cluster, string clusterId, CallSettings callSettings = null)

Creates a new cluster in a given project and location.

Parameters
Name	Description
parent	LocationName Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.
cluster	Cluster Required. Configuration of the cluster to create. Its name field is ignored.
clusterId	string Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035. This value is structured like: my-cluster-id.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationClusterOperationMetadata	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, OperationMetadata> response = managedKafkaClient.CreateCluster(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = managedKafkaClient.PollOnceCreateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateCluster(CreateClusterRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ClusterId = "",
    Cluster = new Cluster(),
    RequestId = "",
};
// Make the request
Operation<Cluster, OperationMetadata> response = managedKafkaClient.CreateCluster(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = managedKafkaClient.PollOnceCreateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateCluster(string, Cluster, string, CallSettings)

public virtual Operation<Cluster, OperationMetadata> CreateCluster(string parent, Cluster cluster, string clusterId, CallSettings callSettings = null)

Creates a new cluster in a given project and location.

Parameters
Name	Description
parent	string Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.
cluster	Cluster Required. Configuration of the cluster to create. Its name field is ignored.
clusterId	string Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035. This value is structured like: my-cluster-id.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationClusterOperationMetadata	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, OperationMetadata> response = managedKafkaClient.CreateCluster(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = managedKafkaClient.PollOnceCreateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(LocationName, Cluster, string, CallSettings)

public virtual Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(LocationName parent, Cluster cluster, string clusterId, CallSettings callSettings = null)

Creates a new cluster in a given project and location.

Parameters
Name	Description
parent	LocationName Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.
cluster	Cluster Required. Configuration of the cluster to create. Its name field is ignored.
clusterId	string Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035. This value is structured like: my-cluster-id.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, OperationMetadata> response = await managedKafkaClient.CreateClusterAsync(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(LocationName, Cluster, string, CancellationToken)

public virtual Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(LocationName parent, Cluster cluster, string clusterId, CancellationToken cancellationToken)

Creates a new cluster in a given project and location.

Parameters
Name	Description
parent	LocationName Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.
cluster	Cluster Required. Configuration of the cluster to create. Its name field is ignored.
clusterId	string Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035. This value is structured like: my-cluster-id.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, OperationMetadata> response = await managedKafkaClient.CreateClusterAsync(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(CreateClusterRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ClusterId = "",
    Cluster = new Cluster(),
    RequestId = "",
};
// Make the request
Operation<Cluster, OperationMetadata> response = await managedKafkaClient.CreateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(CreateClusterRequest, CancellationToken)

public virtual Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(CreateClusterRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
CreateClusterRequest request = new CreateClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ClusterId = "",
    Cluster = new Cluster(),
    RequestId = "",
};
// Make the request
Operation<Cluster, OperationMetadata> response = await managedKafkaClient.CreateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(string, Cluster, string, CallSettings)

public virtual Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(string parent, Cluster cluster, string clusterId, CallSettings callSettings = null)

Creates a new cluster in a given project and location.

Parameters
Name	Description
parent	string Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.
cluster	Cluster Required. Configuration of the cluster to create. Its name field is ignored.
clusterId	string Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035. This value is structured like: my-cluster-id.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, OperationMetadata> response = await managedKafkaClient.CreateClusterAsync(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateClusterAsync(string, Cluster, string, CancellationToken)

public virtual Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(string parent, Cluster cluster, string clusterId, CancellationToken cancellationToken)

Creates a new cluster in a given project and location.

Parameters
Name	Description
parent	string Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.
cluster	Cluster Required. Configuration of the cluster to create. Its name field is ignored.
clusterId	string Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035. This value is structured like: my-cluster-id.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Cluster cluster = new Cluster();
string clusterId = "";
// Make the request
Operation<Cluster, OperationMetadata> response = await managedKafkaClient.CreateClusterAsync(parent, cluster, clusterId);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceCreateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

CreateTopic(ClusterName, Topic, string, CallSettings)

public virtual Topic CreateTopic(ClusterName parent, Topic topic, string topicId, CallSettings callSettings = null)

Creates a new topic in a given project and location.

Parameters
Name	Description
parent	ClusterName Required. The parent cluster in which to create the topic. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
topic	Topic Required. Configuration of the topic to create. Its name field is ignored.
topicId	string Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: my-topic-name.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Topic	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
Topic topic = new Topic();
string topicId = "";
// Make the request
Topic response = managedKafkaClient.CreateTopic(parent, topic, topicId);

CreateTopic(CreateTopicRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
CreateTopicRequest request = new CreateTopicRequest
{
    ParentAsClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    TopicId = "",
    Topic = new Topic(),
};
// Make the request
Topic response = managedKafkaClient.CreateTopic(request);

CreateTopic(string, Topic, string, CallSettings)

public virtual Topic CreateTopic(string parent, Topic topic, string topicId, CallSettings callSettings = null)

Creates a new topic in a given project and location.

Parameters
Name	Description
parent	string Required. The parent cluster in which to create the topic. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
topic	Topic Required. Configuration of the topic to create. Its name field is ignored.
topicId	string Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: my-topic-name.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Topic	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
Topic topic = new Topic();
string topicId = "";
// Make the request
Topic response = managedKafkaClient.CreateTopic(parent, topic, topicId);

CreateTopicAsync(ClusterName, Topic, string, CallSettings)

public virtual Task<Topic> CreateTopicAsync(ClusterName parent, Topic topic, string topicId, CallSettings callSettings = null)

Creates a new topic in a given project and location.

Parameters
Name	Description
parent	ClusterName Required. The parent cluster in which to create the topic. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
topic	Topic Required. Configuration of the topic to create. Its name field is ignored.
topicId	string Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: my-topic-name.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
Topic topic = new Topic();
string topicId = "";
// Make the request
Topic response = await managedKafkaClient.CreateTopicAsync(parent, topic, topicId);

CreateTopicAsync(ClusterName, Topic, string, CancellationToken)

public virtual Task<Topic> CreateTopicAsync(ClusterName parent, Topic topic, string topicId, CancellationToken cancellationToken)

Creates a new topic in a given project and location.

Parameters
Name	Description
parent	ClusterName Required. The parent cluster in which to create the topic. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
topic	Topic Required. Configuration of the topic to create. Its name field is ignored.
topicId	string Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: my-topic-name.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
Topic topic = new Topic();
string topicId = "";
// Make the request
Topic response = await managedKafkaClient.CreateTopicAsync(parent, topic, topicId);

CreateTopicAsync(CreateTopicRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
CreateTopicRequest request = new CreateTopicRequest
{
    ParentAsClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    TopicId = "",
    Topic = new Topic(),
};
// Make the request
Topic response = await managedKafkaClient.CreateTopicAsync(request);

CreateTopicAsync(CreateTopicRequest, CancellationToken)

public virtual Task<Topic> CreateTopicAsync(CreateTopicRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
CreateTopicRequest request = new CreateTopicRequest
{
    ParentAsClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    TopicId = "",
    Topic = new Topic(),
};
// Make the request
Topic response = await managedKafkaClient.CreateTopicAsync(request);

CreateTopicAsync(string, Topic, string, CallSettings)

public virtual Task<Topic> CreateTopicAsync(string parent, Topic topic, string topicId, CallSettings callSettings = null)

Creates a new topic in a given project and location.

Parameters
Name	Description
parent	string Required. The parent cluster in which to create the topic. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
topic	Topic Required. Configuration of the topic to create. Its name field is ignored.
topicId	string Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: my-topic-name.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
Topic topic = new Topic();
string topicId = "";
// Make the request
Topic response = await managedKafkaClient.CreateTopicAsync(parent, topic, topicId);

CreateTopicAsync(string, Topic, string, CancellationToken)

public virtual Task<Topic> CreateTopicAsync(string parent, Topic topic, string topicId, CancellationToken cancellationToken)

Creates a new topic in a given project and location.

Parameters
Name	Description
parent	string Required. The parent cluster in which to create the topic. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
topic	Topic Required. Configuration of the topic to create. Its name field is ignored.
topicId	string Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: my-topic-name.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
Topic topic = new Topic();
string topicId = "";
// Make the request
Topic response = await managedKafkaClient.CreateTopicAsync(parent, topic, topicId);

DeleteCluster(ClusterName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteCluster(ClusterName name, CallSettings callSettings = null)

Deletes a single cluster.

Parameters
Name	Description
name	ClusterName Required. The name of the cluster to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Operation<Empty, OperationMetadata> response = managedKafkaClient.DeleteCluster(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = managedKafkaClient.PollOnceDeleteCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteCluster(DeleteClusterRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
DeleteClusterRequest request = new DeleteClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = managedKafkaClient.DeleteCluster(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = managedKafkaClient.PollOnceDeleteCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteCluster(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteCluster(string name, CallSettings callSettings = null)

Deletes a single cluster.

Parameters
Name	Description
name	string Required. The name of the cluster to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Operation<Empty, OperationMetadata> response = managedKafkaClient.DeleteCluster(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = managedKafkaClient.PollOnceDeleteCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteClusterAsync(ClusterName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteClusterAsync(ClusterName name, CallSettings callSettings = null)

Deletes a single cluster.

Parameters
Name	Description
name	ClusterName Required. The name of the cluster to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Operation<Empty, OperationMetadata> response = await managedKafkaClient.DeleteClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceDeleteClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteClusterAsync(ClusterName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteClusterAsync(ClusterName name, CancellationToken cancellationToken)

Deletes a single cluster.

Parameters
Name	Description
name	ClusterName Required. The name of the cluster to delete.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Operation<Empty, OperationMetadata> response = await managedKafkaClient.DeleteClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceDeleteClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteClusterAsync(DeleteClusterRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
DeleteClusterRequest request = new DeleteClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await managedKafkaClient.DeleteClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceDeleteClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteClusterAsync(DeleteClusterRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteClusterAsync(DeleteClusterRequest request, CancellationToken cancellationToken)

Deletes a single cluster.

Parameters
Name	Description
request	DeleteClusterRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
DeleteClusterRequest request = new DeleteClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
    RequestId = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await managedKafkaClient.DeleteClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceDeleteClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteClusterAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteClusterAsync(string name, CallSettings callSettings = null)

Deletes a single cluster.

Parameters
Name	Description
name	string Required. The name of the cluster to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Operation<Empty, OperationMetadata> response = await managedKafkaClient.DeleteClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceDeleteClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteClusterAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteClusterAsync(string name, CancellationToken cancellationToken)

Deletes a single cluster.

Parameters
Name	Description
name	string Required. The name of the cluster to delete.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Operation<Empty, OperationMetadata> response = await managedKafkaClient.DeleteClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceDeleteClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConsumerGroup(ConsumerGroupName, CallSettings)

public virtual void DeleteConsumerGroup(ConsumerGroupName name, CallSettings callSettings = null)

Deletes a single consumer group.

Parameters
Name	Description
name	ConsumerGroupName Required. The name of the consumer group to delete. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
ConsumerGroupName name = ConsumerGroupName.FromProjectLocationClusterConsumerGroup("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]");
// Make the request
managedKafkaClient.DeleteConsumerGroup(name);

DeleteConsumerGroup(DeleteConsumerGroupRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
DeleteConsumerGroupRequest request = new DeleteConsumerGroupRequest
{
    ConsumerGroupName = ConsumerGroupName.FromProjectLocationClusterConsumerGroup("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]"),
};
// Make the request
managedKafkaClient.DeleteConsumerGroup(request);

DeleteConsumerGroup(string, CallSettings)

public virtual void DeleteConsumerGroup(string name, CallSettings callSettings = null)

Deletes a single consumer group.

Parameters
Name	Description
name	string Required. The name of the consumer group to delete. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/consumerGroups/[CONSUMER_GROUP]";
// Make the request
managedKafkaClient.DeleteConsumerGroup(name);

DeleteConsumerGroupAsync(ConsumerGroupName, CallSettings)

public virtual Task DeleteConsumerGroupAsync(ConsumerGroupName name, CallSettings callSettings = null)

Deletes a single consumer group.

Parameters
Name	Description
name	ConsumerGroupName Required. The name of the consumer group to delete. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ConsumerGroupName name = ConsumerGroupName.FromProjectLocationClusterConsumerGroup("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]");
// Make the request
await managedKafkaClient.DeleteConsumerGroupAsync(name);

DeleteConsumerGroupAsync(ConsumerGroupName, CancellationToken)

public virtual Task DeleteConsumerGroupAsync(ConsumerGroupName name, CancellationToken cancellationToken)

Deletes a single consumer group.

Parameters
Name	Description
name	ConsumerGroupName Required. The name of the consumer group to delete. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ConsumerGroupName name = ConsumerGroupName.FromProjectLocationClusterConsumerGroup("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]");
// Make the request
await managedKafkaClient.DeleteConsumerGroupAsync(name);

DeleteConsumerGroupAsync(DeleteConsumerGroupRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
DeleteConsumerGroupRequest request = new DeleteConsumerGroupRequest
{
    ConsumerGroupName = ConsumerGroupName.FromProjectLocationClusterConsumerGroup("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]"),
};
// Make the request
await managedKafkaClient.DeleteConsumerGroupAsync(request);

DeleteConsumerGroupAsync(DeleteConsumerGroupRequest, CancellationToken)

public virtual Task DeleteConsumerGroupAsync(DeleteConsumerGroupRequest request, CancellationToken cancellationToken)

Deletes a single consumer group.

Parameters
Name	Description
request	DeleteConsumerGroupRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
DeleteConsumerGroupRequest request = new DeleteConsumerGroupRequest
{
    ConsumerGroupName = ConsumerGroupName.FromProjectLocationClusterConsumerGroup("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]"),
};
// Make the request
await managedKafkaClient.DeleteConsumerGroupAsync(request);

DeleteConsumerGroupAsync(string, CallSettings)

public virtual Task DeleteConsumerGroupAsync(string name, CallSettings callSettings = null)

Deletes a single consumer group.

Parameters
Name	Description
name	string Required. The name of the consumer group to delete. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/consumerGroups/[CONSUMER_GROUP]";
// Make the request
await managedKafkaClient.DeleteConsumerGroupAsync(name);

DeleteConsumerGroupAsync(string, CancellationToken)

public virtual Task DeleteConsumerGroupAsync(string name, CancellationToken cancellationToken)

Deletes a single consumer group.

Parameters
Name	Description
name	string Required. The name of the consumer group to delete. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/consumerGroups/[CONSUMER_GROUP]";
// Make the request
await managedKafkaClient.DeleteConsumerGroupAsync(name);

DeleteTopic(DeleteTopicRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
DeleteTopicRequest request = new DeleteTopicRequest
{
    TopicName = TopicName.FromProjectLocationClusterTopic("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]"),
};
// Make the request
managedKafkaClient.DeleteTopic(request);

DeleteTopic(TopicName, CallSettings)

public virtual void DeleteTopic(TopicName name, CallSettings callSettings = null)

Deletes a single topic.

Parameters
Name	Description
name	TopicName Required. The name of the topic to delete. projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
TopicName name = TopicName.FromProjectLocationClusterTopic("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]");
// Make the request
managedKafkaClient.DeleteTopic(name);

DeleteTopic(string, CallSettings)

public virtual void DeleteTopic(string name, CallSettings callSettings = null)

Deletes a single topic.

Parameters
Name	Description
name	string Required. The name of the topic to delete. projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/topics/[TOPIC]";
// Make the request
managedKafkaClient.DeleteTopic(name);

DeleteTopicAsync(DeleteTopicRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
DeleteTopicRequest request = new DeleteTopicRequest
{
    TopicName = TopicName.FromProjectLocationClusterTopic("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]"),
};
// Make the request
await managedKafkaClient.DeleteTopicAsync(request);

DeleteTopicAsync(DeleteTopicRequest, CancellationToken)

public virtual Task DeleteTopicAsync(DeleteTopicRequest request, CancellationToken cancellationToken)

Deletes a single topic.

Parameters
Name	Description
request	DeleteTopicRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
DeleteTopicRequest request = new DeleteTopicRequest
{
    TopicName = TopicName.FromProjectLocationClusterTopic("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]"),
};
// Make the request
await managedKafkaClient.DeleteTopicAsync(request);

DeleteTopicAsync(TopicName, CallSettings)

public virtual Task DeleteTopicAsync(TopicName name, CallSettings callSettings = null)

Deletes a single topic.

Parameters
Name	Description
name	TopicName Required. The name of the topic to delete. projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
TopicName name = TopicName.FromProjectLocationClusterTopic("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]");
// Make the request
await managedKafkaClient.DeleteTopicAsync(name);

DeleteTopicAsync(TopicName, CancellationToken)

public virtual Task DeleteTopicAsync(TopicName name, CancellationToken cancellationToken)

Deletes a single topic.

Parameters
Name	Description
name	TopicName Required. The name of the topic to delete. projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
TopicName name = TopicName.FromProjectLocationClusterTopic("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]");
// Make the request
await managedKafkaClient.DeleteTopicAsync(name);

DeleteTopicAsync(string, CallSettings)

public virtual Task DeleteTopicAsync(string name, CallSettings callSettings = null)

Deletes a single topic.

Parameters
Name	Description
name	string Required. The name of the topic to delete. projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/topics/[TOPIC]";
// Make the request
await managedKafkaClient.DeleteTopicAsync(name);

DeleteTopicAsync(string, CancellationToken)

public virtual Task DeleteTopicAsync(string name, CancellationToken cancellationToken)

Deletes a single topic.

Parameters
Name	Description
name	string Required. The name of the topic to delete. projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/topics/[TOPIC]";
// Make the request
await managedKafkaClient.DeleteTopicAsync(name);

GetCluster(ClusterName, CallSettings)

public virtual Cluster GetCluster(ClusterName name, CallSettings callSettings = null)

Returns the properties of a single cluster.

Parameters
Name	Description
name	ClusterName Required. The name of the cluster whose configuration to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Cluster	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Cluster response = managedKafkaClient.GetCluster(name);

GetCluster(GetClusterRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
GetClusterRequest request = new GetClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
Cluster response = managedKafkaClient.GetCluster(request);

GetCluster(string, CallSettings)

public virtual Cluster GetCluster(string name, CallSettings callSettings = null)

Returns the properties of a single cluster.

Parameters
Name	Description
name	string Required. The name of the cluster whose configuration to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Cluster	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Cluster response = managedKafkaClient.GetCluster(name);

GetClusterAsync(ClusterName, CallSettings)

public virtual Task<Cluster> GetClusterAsync(ClusterName name, CallSettings callSettings = null)

Returns the properties of a single cluster.

Parameters
Name	Description
name	ClusterName Required. The name of the cluster whose configuration to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskCluster	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Cluster response = await managedKafkaClient.GetClusterAsync(name);

GetClusterAsync(ClusterName, CancellationToken)

public virtual Task<Cluster> GetClusterAsync(ClusterName name, CancellationToken cancellationToken)

Returns the properties of a single cluster.

Parameters
Name	Description
name	ClusterName Required. The name of the cluster whose configuration to return.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskCluster	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ClusterName name = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
Cluster response = await managedKafkaClient.GetClusterAsync(name);

GetClusterAsync(GetClusterRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
GetClusterRequest request = new GetClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
Cluster response = await managedKafkaClient.GetClusterAsync(request);

GetClusterAsync(GetClusterRequest, CancellationToken)

public virtual Task<Cluster> GetClusterAsync(GetClusterRequest request, CancellationToken cancellationToken)

Returns the properties of a single cluster.

Parameters
Name	Description
request	GetClusterRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskCluster	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
GetClusterRequest request = new GetClusterRequest
{
    ClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
Cluster response = await managedKafkaClient.GetClusterAsync(request);

GetClusterAsync(string, CallSettings)

public virtual Task<Cluster> GetClusterAsync(string name, CallSettings callSettings = null)

Returns the properties of a single cluster.

Parameters
Name	Description
name	string Required. The name of the cluster whose configuration to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskCluster	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Cluster response = await managedKafkaClient.GetClusterAsync(name);

GetClusterAsync(string, CancellationToken)

public virtual Task<Cluster> GetClusterAsync(string name, CancellationToken cancellationToken)

Returns the properties of a single cluster.

Parameters
Name	Description
name	string Required. The name of the cluster whose configuration to return.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskCluster	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
Cluster response = await managedKafkaClient.GetClusterAsync(name);

GetConsumerGroup(ConsumerGroupName, CallSettings)

public virtual ConsumerGroup GetConsumerGroup(ConsumerGroupName name, CallSettings callSettings = null)

Returns the properties of a single consumer group.

Parameters
Name	Description
name	ConsumerGroupName Required. The name of the consumer group whose configuration to return. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ConsumerGroup	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
ConsumerGroupName name = ConsumerGroupName.FromProjectLocationClusterConsumerGroup("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]");
// Make the request
ConsumerGroup response = managedKafkaClient.GetConsumerGroup(name);

GetConsumerGroup(GetConsumerGroupRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
GetConsumerGroupRequest request = new GetConsumerGroupRequest
{
    ConsumerGroupName = ConsumerGroupName.FromProjectLocationClusterConsumerGroup("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]"),
};
// Make the request
ConsumerGroup response = managedKafkaClient.GetConsumerGroup(request);

GetConsumerGroup(string, CallSettings)

public virtual ConsumerGroup GetConsumerGroup(string name, CallSettings callSettings = null)

Returns the properties of a single consumer group.

Parameters
Name	Description
name	string Required. The name of the consumer group whose configuration to return. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ConsumerGroup	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/consumerGroups/[CONSUMER_GROUP]";
// Make the request
ConsumerGroup response = managedKafkaClient.GetConsumerGroup(name);

GetConsumerGroupAsync(ConsumerGroupName, CallSettings)

public virtual Task<ConsumerGroup> GetConsumerGroupAsync(ConsumerGroupName name, CallSettings callSettings = null)

Returns the properties of a single consumer group.

Parameters
Name	Description
name	ConsumerGroupName Required. The name of the consumer group whose configuration to return. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskConsumerGroup	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ConsumerGroupName name = ConsumerGroupName.FromProjectLocationClusterConsumerGroup("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]");
// Make the request
ConsumerGroup response = await managedKafkaClient.GetConsumerGroupAsync(name);

GetConsumerGroupAsync(ConsumerGroupName, CancellationToken)

public virtual Task<ConsumerGroup> GetConsumerGroupAsync(ConsumerGroupName name, CancellationToken cancellationToken)

Returns the properties of a single consumer group.

Parameters
Name	Description
name	ConsumerGroupName Required. The name of the consumer group whose configuration to return. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskConsumerGroup	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ConsumerGroupName name = ConsumerGroupName.FromProjectLocationClusterConsumerGroup("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]");
// Make the request
ConsumerGroup response = await managedKafkaClient.GetConsumerGroupAsync(name);

GetConsumerGroupAsync(GetConsumerGroupRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
GetConsumerGroupRequest request = new GetConsumerGroupRequest
{
    ConsumerGroupName = ConsumerGroupName.FromProjectLocationClusterConsumerGroup("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]"),
};
// Make the request
ConsumerGroup response = await managedKafkaClient.GetConsumerGroupAsync(request);

GetConsumerGroupAsync(GetConsumerGroupRequest, CancellationToken)

public virtual Task<ConsumerGroup> GetConsumerGroupAsync(GetConsumerGroupRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskConsumerGroup	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
GetConsumerGroupRequest request = new GetConsumerGroupRequest
{
    ConsumerGroupName = ConsumerGroupName.FromProjectLocationClusterConsumerGroup("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]"),
};
// Make the request
ConsumerGroup response = await managedKafkaClient.GetConsumerGroupAsync(request);

GetConsumerGroupAsync(string, CallSettings)

public virtual Task<ConsumerGroup> GetConsumerGroupAsync(string name, CallSettings callSettings = null)

Returns the properties of a single consumer group.

Parameters
Name	Description
name	string Required. The name of the consumer group whose configuration to return. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskConsumerGroup	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/consumerGroups/[CONSUMER_GROUP]";
// Make the request
ConsumerGroup response = await managedKafkaClient.GetConsumerGroupAsync(name);

GetConsumerGroupAsync(string, CancellationToken)

public virtual Task<ConsumerGroup> GetConsumerGroupAsync(string name, CancellationToken cancellationToken)

Returns the properties of a single consumer group.

Parameters
Name	Description
name	string Required. The name of the consumer group whose configuration to return. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskConsumerGroup	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/consumerGroups/[CONSUMER_GROUP]";
// Make the request
ConsumerGroup response = await managedKafkaClient.GetConsumerGroupAsync(name);

GetTopic(GetTopicRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
GetTopicRequest request = new GetTopicRequest
{
    TopicName = TopicName.FromProjectLocationClusterTopic("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]"),
};
// Make the request
Topic response = managedKafkaClient.GetTopic(request);

GetTopic(TopicName, CallSettings)

public virtual Topic GetTopic(TopicName name, CallSettings callSettings = null)

Returns the properties of a single topic.

Parameters
Name	Description
name	TopicName Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Topic	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
TopicName name = TopicName.FromProjectLocationClusterTopic("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]");
// Make the request
Topic response = managedKafkaClient.GetTopic(name);

GetTopic(string, CallSettings)

public virtual Topic GetTopic(string name, CallSettings callSettings = null)

Returns the properties of a single topic.

Parameters
Name	Description
name	string Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Topic	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/topics/[TOPIC]";
// Make the request
Topic response = managedKafkaClient.GetTopic(name);

GetTopicAsync(GetTopicRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
GetTopicRequest request = new GetTopicRequest
{
    TopicName = TopicName.FromProjectLocationClusterTopic("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]"),
};
// Make the request
Topic response = await managedKafkaClient.GetTopicAsync(request);

GetTopicAsync(GetTopicRequest, CancellationToken)

public virtual Task<Topic> GetTopicAsync(GetTopicRequest request, CancellationToken cancellationToken)

Returns the properties of a single topic.

Parameters
Name	Description
request	GetTopicRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
GetTopicRequest request = new GetTopicRequest
{
    TopicName = TopicName.FromProjectLocationClusterTopic("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]"),
};
// Make the request
Topic response = await managedKafkaClient.GetTopicAsync(request);

GetTopicAsync(TopicName, CallSettings)

public virtual Task<Topic> GetTopicAsync(TopicName name, CallSettings callSettings = null)

Returns the properties of a single topic.

Parameters
Name	Description
name	TopicName Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
TopicName name = TopicName.FromProjectLocationClusterTopic("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]");
// Make the request
Topic response = await managedKafkaClient.GetTopicAsync(name);

GetTopicAsync(TopicName, CancellationToken)

public virtual Task<Topic> GetTopicAsync(TopicName name, CancellationToken cancellationToken)

Returns the properties of a single topic.

Parameters
Name	Description
name	TopicName Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
TopicName name = TopicName.FromProjectLocationClusterTopic("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]");
// Make the request
Topic response = await managedKafkaClient.GetTopicAsync(name);

GetTopicAsync(string, CallSettings)

public virtual Task<Topic> GetTopicAsync(string name, CallSettings callSettings = null)

Returns the properties of a single topic.

Parameters
Name	Description
name	string Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/topics/[TOPIC]";
// Make the request
Topic response = await managedKafkaClient.GetTopicAsync(name);

GetTopicAsync(string, CancellationToken)

public virtual Task<Topic> GetTopicAsync(string name, CancellationToken cancellationToken)

Returns the properties of a single topic.

Parameters
Name	Description
name	string Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]/topics/[TOPIC]";
// Make the request
Topic response = await managedKafkaClient.GetTopicAsync(name);

ListClusters(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListClustersResponse, Cluster> ListClusters(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the clusters in a given project and location.

Parameters
Name	Description
parent	LocationName Required. The parent location whose clusters are to be listed. Structured like projects/{project}/locations/{location}.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListClustersResponseCluster	A pageable sequence of Cluster resources.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListClustersResponse, Cluster> response = managedKafkaClient.ListClusters(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Cluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Cluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Cluster> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Cluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListClusters(ListClustersRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
ListClustersRequest request = new ListClustersRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListClustersResponse, Cluster> response = managedKafkaClient.ListClusters(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Cluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Cluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Cluster> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Cluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListClusters(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListClustersResponse, Cluster> ListClusters(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the clusters in a given project and location.

Parameters
Name	Description
parent	string Required. The parent location whose clusters are to be listed. Structured like projects/{project}/locations/{location}.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListClustersResponseCluster	A pageable sequence of Cluster resources.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListClustersResponse, Cluster> response = managedKafkaClient.ListClusters(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Cluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Cluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Cluster> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Cluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListClustersAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListClustersResponse, Cluster> ListClustersAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the clusters in a given project and location.

Parameters
Name	Description
parent	LocationName Required. The parent location whose clusters are to be listed. Structured like projects/{project}/locations/{location}.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListClustersResponseCluster	A pageable asynchronous sequence of Cluster resources.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListClustersResponse, Cluster> response = managedKafkaClient.ListClustersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Cluster item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListClustersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Cluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Cluster> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Cluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListClustersAsync(ListClustersRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ListClustersRequest request = new ListClustersRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListClustersResponse, Cluster> response = managedKafkaClient.ListClustersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Cluster item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListClustersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Cluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Cluster> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Cluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListClustersAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListClustersResponse, Cluster> ListClustersAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the clusters in a given project and location.

Parameters
Name	Description
parent	string Required. The parent location whose clusters are to be listed. Structured like projects/{project}/locations/{location}.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListClustersResponseCluster	A pageable asynchronous sequence of Cluster resources.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListClustersResponse, Cluster> response = managedKafkaClient.ListClustersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Cluster item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListClustersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Cluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Cluster> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Cluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListConsumerGroups(ClusterName, string, int?, CallSettings)

public virtual PagedEnumerable<ListConsumerGroupsResponse, ConsumerGroup> ListConsumerGroups(ClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the consumer groups in a given cluster.

Parameters
Name	Description
parent	ClusterName Required. The parent cluster whose consumer groups are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListConsumerGroupsResponseConsumerGroup	A pageable sequence of ConsumerGroup resources.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
PagedEnumerable<ListConsumerGroupsResponse, ConsumerGroup> response = managedKafkaClient.ListConsumerGroups(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ConsumerGroup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListConsumerGroupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConsumerGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ConsumerGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ConsumerGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListConsumerGroups(ListConsumerGroupsRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
ListConsumerGroupsRequest request = new ListConsumerGroupsRequest
{
    ParentAsClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
PagedEnumerable<ListConsumerGroupsResponse, ConsumerGroup> response = managedKafkaClient.ListConsumerGroups(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ConsumerGroup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListConsumerGroupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConsumerGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ConsumerGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ConsumerGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListConsumerGroups(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListConsumerGroupsResponse, ConsumerGroup> ListConsumerGroups(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the consumer groups in a given cluster.

Parameters
Name	Description
parent	string Required. The parent cluster whose consumer groups are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListConsumerGroupsResponseConsumerGroup	A pageable sequence of ConsumerGroup resources.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
PagedEnumerable<ListConsumerGroupsResponse, ConsumerGroup> response = managedKafkaClient.ListConsumerGroups(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ConsumerGroup item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListConsumerGroupsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConsumerGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ConsumerGroup> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ConsumerGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListConsumerGroupsAsync(ClusterName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListConsumerGroupsResponse, ConsumerGroup> ListConsumerGroupsAsync(ClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the consumer groups in a given cluster.

Parameters
Name	Description
parent	ClusterName Required. The parent cluster whose consumer groups are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListConsumerGroupsResponseConsumerGroup	A pageable asynchronous sequence of ConsumerGroup resources.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
PagedAsyncEnumerable<ListConsumerGroupsResponse, ConsumerGroup> response = managedKafkaClient.ListConsumerGroupsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ConsumerGroup item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListConsumerGroupsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConsumerGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ConsumerGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ConsumerGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListConsumerGroupsAsync(ListConsumerGroupsRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ListConsumerGroupsRequest request = new ListConsumerGroupsRequest
{
    ParentAsClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
PagedAsyncEnumerable<ListConsumerGroupsResponse, ConsumerGroup> response = managedKafkaClient.ListConsumerGroupsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ConsumerGroup item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListConsumerGroupsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConsumerGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ConsumerGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ConsumerGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListConsumerGroupsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListConsumerGroupsResponse, ConsumerGroup> ListConsumerGroupsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the consumer groups in a given cluster.

Parameters
Name	Description
parent	string Required. The parent cluster whose consumer groups are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListConsumerGroupsResponseConsumerGroup	A pageable asynchronous sequence of ConsumerGroup resources.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
PagedAsyncEnumerable<ListConsumerGroupsResponse, ConsumerGroup> response = managedKafkaClient.ListConsumerGroupsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ConsumerGroup item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListConsumerGroupsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConsumerGroup item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ConsumerGroup> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ConsumerGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTopics(ClusterName, string, int?, CallSettings)

public virtual PagedEnumerable<ListTopicsResponse, Topic> ListTopics(ClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the topics in a given cluster.

Parameters
Name	Description
parent	ClusterName Required. The parent cluster whose topics are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListTopicsResponseTopic	A pageable sequence of Topic resources.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
PagedEnumerable<ListTopicsResponse, Topic> response = managedKafkaClient.ListTopics(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Topic item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTopicsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Topic item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Topic> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Topic item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTopics(ListTopicsRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
ListTopicsRequest request = new ListTopicsRequest
{
    ParentAsClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
PagedEnumerable<ListTopicsResponse, Topic> response = managedKafkaClient.ListTopics(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Topic item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTopicsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Topic item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Topic> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Topic item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTopics(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListTopicsResponse, Topic> ListTopics(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the topics in a given cluster.

Parameters
Name	Description
parent	string Required. The parent cluster whose topics are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListTopicsResponseTopic	A pageable sequence of Topic resources.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
PagedEnumerable<ListTopicsResponse, Topic> response = managedKafkaClient.ListTopics(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Topic item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTopicsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Topic item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Topic> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Topic item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTopicsAsync(ClusterName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTopicsResponse, Topic> ListTopicsAsync(ClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the topics in a given cluster.

Parameters
Name	Description
parent	ClusterName Required. The parent cluster whose topics are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListTopicsResponseTopic	A pageable asynchronous sequence of Topic resources.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ClusterName parent = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]");
// Make the request
PagedAsyncEnumerable<ListTopicsResponse, Topic> response = managedKafkaClient.ListTopicsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Topic item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTopicsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Topic item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Topic> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Topic item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTopicsAsync(ListTopicsRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ListTopicsRequest request = new ListTopicsRequest
{
    ParentAsClusterName = ClusterName.FromProjectLocationCluster("[PROJECT]", "[LOCATION]", "[CLUSTER]"),
};
// Make the request
PagedAsyncEnumerable<ListTopicsResponse, Topic> response = managedKafkaClient.ListTopicsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Topic item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTopicsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Topic item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Topic> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Topic item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTopicsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTopicsResponse, Topic> ListTopicsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the topics in a given cluster.

Parameters
Name	Description
parent	string Required. The parent cluster whose topics are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListTopicsResponseTopic	A pageable asynchronous sequence of Topic resources.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/clusters/[CLUSTER]";
// Make the request
PagedAsyncEnumerable<ListTopicsResponse, Topic> response = managedKafkaClient.ListTopicsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Topic item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTopicsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Topic item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Topic> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Topic item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateCluster(string, CallSettings)

public virtual Operation<Cluster, OperationMetadata> PollOnceCreateCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateCluster.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationClusterOperationMetadata	The result of polling the operation.

PollOnceCreateClusterAsync(string, CallSettings)

public virtual Task<Operation<Cluster, OperationMetadata>> PollOnceCreateClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateCluster.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationClusterOperationMetadata	A task representing the result of polling the operation.

PollOnceDeleteCluster(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteCluster.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The result of polling the operation.

PollOnceDeleteClusterAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteCluster.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A task representing the result of polling the operation.

PollOnceUpdateCluster(string, CallSettings)

public virtual Operation<Cluster, OperationMetadata> PollOnceUpdateCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateCluster.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationClusterOperationMetadata	The result of polling the operation.

PollOnceUpdateClusterAsync(string, CallSettings)

public virtual Task<Operation<Cluster, OperationMetadata>> PollOnceUpdateClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateCluster.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationClusterOperationMetadata	A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateCluster(Cluster, FieldMask, CallSettings)

public virtual Operation<Cluster, OperationMetadata> UpdateCluster(Cluster cluster, FieldMask updateMask, CallSettings callSettings = null)

Updates the properties of a single cluster.

Parameters
Name	Description
cluster	Cluster Required. The cluster to update. Its name field must be populated.
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationClusterOperationMetadata	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
Cluster cluster = new Cluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Cluster, OperationMetadata> response = managedKafkaClient.UpdateCluster(cluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = managedKafkaClient.PollOnceUpdateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateCluster(UpdateClusterRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
UpdateClusterRequest request = new UpdateClusterRequest
{
    UpdateMask = new FieldMask(),
    Cluster = new Cluster(),
    RequestId = "",
};
// Make the request
Operation<Cluster, OperationMetadata> response = managedKafkaClient.UpdateCluster(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = managedKafkaClient.PollOnceUpdateCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateClusterAsync(Cluster, FieldMask, CallSettings)

public virtual Task<Operation<Cluster, OperationMetadata>> UpdateClusterAsync(Cluster cluster, FieldMask updateMask, CallSettings callSettings = null)

Updates the properties of a single cluster.

Parameters
Name	Description
cluster	Cluster Required. The cluster to update. Its name field must be populated.
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
Cluster cluster = new Cluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Cluster, OperationMetadata> response = await managedKafkaClient.UpdateClusterAsync(cluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateClusterAsync(Cluster, FieldMask, CancellationToken)

public virtual Task<Operation<Cluster, OperationMetadata>> UpdateClusterAsync(Cluster cluster, FieldMask updateMask, CancellationToken cancellationToken)

Updates the properties of a single cluster.

Parameters
Name	Description
cluster	Cluster Required. The cluster to update. Its name field must be populated.
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
Cluster cluster = new Cluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Cluster, OperationMetadata> response = await managedKafkaClient.UpdateClusterAsync(cluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateClusterAsync(UpdateClusterRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
UpdateClusterRequest request = new UpdateClusterRequest
{
    UpdateMask = new FieldMask(),
    Cluster = new Cluster(),
    RequestId = "",
};
// Make the request
Operation<Cluster, OperationMetadata> response = await managedKafkaClient.UpdateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateClusterAsync(UpdateClusterRequest, CancellationToken)

public virtual Task<Operation<Cluster, OperationMetadata>> UpdateClusterAsync(UpdateClusterRequest request, CancellationToken cancellationToken)

Updates the properties of a single cluster.

Parameters
Name	Description
request	UpdateClusterRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
UpdateClusterRequest request = new UpdateClusterRequest
{
    UpdateMask = new FieldMask(),
    Cluster = new Cluster(),
    RequestId = "",
};
// Make the request
Operation<Cluster, OperationMetadata> response = await managedKafkaClient.UpdateClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Cluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Cluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Cluster, OperationMetadata> retrievedResponse = await managedKafkaClient.PollOnceUpdateClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Cluster retrievedResult = retrievedResponse.Result;
}

UpdateConsumerGroup(ConsumerGroup, FieldMask, CallSettings)

public virtual ConsumerGroup UpdateConsumerGroup(ConsumerGroup consumerGroup, FieldMask updateMask, CallSettings callSettings = null)

Updates the properties of a single consumer group.

Parameters
Name	Description
consumerGroup	ConsumerGroup Required. The consumer group to update. Its name field must be populated.
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ConsumerGroup	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
ConsumerGroup consumerGroup = new ConsumerGroup();
FieldMask updateMask = new FieldMask();
// Make the request
ConsumerGroup response = managedKafkaClient.UpdateConsumerGroup(consumerGroup, updateMask);

UpdateConsumerGroup(UpdateConsumerGroupRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
UpdateConsumerGroupRequest request = new UpdateConsumerGroupRequest
{
    UpdateMask = new FieldMask(),
    ConsumerGroup = new ConsumerGroup(),
};
// Make the request
ConsumerGroup response = managedKafkaClient.UpdateConsumerGroup(request);

UpdateConsumerGroupAsync(ConsumerGroup, FieldMask, CallSettings)

public virtual Task<ConsumerGroup> UpdateConsumerGroupAsync(ConsumerGroup consumerGroup, FieldMask updateMask, CallSettings callSettings = null)

Updates the properties of a single consumer group.

Parameters
Name	Description
consumerGroup	ConsumerGroup Required. The consumer group to update. Its name field must be populated.
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskConsumerGroup	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ConsumerGroup consumerGroup = new ConsumerGroup();
FieldMask updateMask = new FieldMask();
// Make the request
ConsumerGroup response = await managedKafkaClient.UpdateConsumerGroupAsync(consumerGroup, updateMask);

UpdateConsumerGroupAsync(ConsumerGroup, FieldMask, CancellationToken)

public virtual Task<ConsumerGroup> UpdateConsumerGroupAsync(ConsumerGroup consumerGroup, FieldMask updateMask, CancellationToken cancellationToken)

Updates the properties of a single consumer group.

Parameters
Name	Description
consumerGroup	ConsumerGroup Required. The consumer group to update. Its name field must be populated.
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskConsumerGroup	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
ConsumerGroup consumerGroup = new ConsumerGroup();
FieldMask updateMask = new FieldMask();
// Make the request
ConsumerGroup response = await managedKafkaClient.UpdateConsumerGroupAsync(consumerGroup, updateMask);

UpdateConsumerGroupAsync(UpdateConsumerGroupRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
UpdateConsumerGroupRequest request = new UpdateConsumerGroupRequest
{
    UpdateMask = new FieldMask(),
    ConsumerGroup = new ConsumerGroup(),
};
// Make the request
ConsumerGroup response = await managedKafkaClient.UpdateConsumerGroupAsync(request);

UpdateConsumerGroupAsync(UpdateConsumerGroupRequest, CancellationToken)

public virtual Task<ConsumerGroup> UpdateConsumerGroupAsync(UpdateConsumerGroupRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskConsumerGroup	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
UpdateConsumerGroupRequest request = new UpdateConsumerGroupRequest
{
    UpdateMask = new FieldMask(),
    ConsumerGroup = new ConsumerGroup(),
};
// Make the request
ConsumerGroup response = await managedKafkaClient.UpdateConsumerGroupAsync(request);

UpdateTopic(Topic, FieldMask, CallSettings)

public virtual Topic UpdateTopic(Topic topic, FieldMask updateMask, CallSettings callSettings = null)

Updates the properties of a single topic.

Parameters
Name	Description
topic	Topic Required. The topic to update. Its name field must be populated.
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the Topic resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Topic	The RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
Topic topic = new Topic();
FieldMask updateMask = new FieldMask();
// Make the request
Topic response = managedKafkaClient.UpdateTopic(topic, updateMask);

UpdateTopic(UpdateTopicRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.Create();
// Initialize request argument(s)
UpdateTopicRequest request = new UpdateTopicRequest
{
    UpdateMask = new FieldMask(),
    Topic = new Topic(),
};
// Make the request
Topic response = managedKafkaClient.UpdateTopic(request);

UpdateTopicAsync(Topic, FieldMask, CallSettings)

public virtual Task<Topic> UpdateTopicAsync(Topic topic, FieldMask updateMask, CallSettings callSettings = null)

Updates the properties of a single topic.

Parameters
Name	Description
topic	Topic Required. The topic to update. Its name field must be populated.
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the Topic resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
Topic topic = new Topic();
FieldMask updateMask = new FieldMask();
// Make the request
Topic response = await managedKafkaClient.UpdateTopicAsync(topic, updateMask);

UpdateTopicAsync(Topic, FieldMask, CancellationToken)

public virtual Task<Topic> UpdateTopicAsync(Topic topic, FieldMask updateMask, CancellationToken cancellationToken)

Updates the properties of a single topic.

Parameters
Name	Description
topic	Topic Required. The topic to update. Its name field must be populated.
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the Topic resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
Topic topic = new Topic();
FieldMask updateMask = new FieldMask();
// Make the request
Topic response = await managedKafkaClient.UpdateTopicAsync(topic, updateMask);

UpdateTopicAsync(UpdateTopicRequest, CallSettings)

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

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
UpdateTopicRequest request = new UpdateTopicRequest
{
    UpdateMask = new FieldMask(),
    Topic = new Topic(),
};
// Make the request
Topic response = await managedKafkaClient.UpdateTopicAsync(request);

UpdateTopicAsync(UpdateTopicRequest, CancellationToken)

public virtual Task<Topic> UpdateTopicAsync(UpdateTopicRequest request, CancellationToken cancellationToken)

Updates the properties of a single topic.

Parameters
Name	Description
request	UpdateTopicRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskTopic	A Task containing the RPC response.

Example

// Create client
ManagedKafkaClient managedKafkaClient = await ManagedKafkaClient.CreateAsync();
// Initialize request argument(s)
UpdateTopicRequest request = new UpdateTopicRequest
{
    UpdateMask = new FieldMask(),
    Topic = new Topic(),
};
// Make the request
Topic response = await managedKafkaClient.UpdateTopicAsync(request);