Note:
This documentation is for version 1.0.0-beta07 of the library.
Some samples may not work with other versions.
Installation
Install the Google.Cloud.ManagedKafka.V1 package from NuGet. Add it to
your project in the normal way (for example by right-clicking on the
project in Visual Studio and choosing "Manage NuGet Packages...").
Please ensure you enable pre-release packages (for example, in the
Visual Studio NuGet user interface, check the "Include prerelease"
box). Some of the following samples might only work with the latest
pre-release version (1.0.0-beta07) of Google.Cloud.ManagedKafka.V1.
Authentication
When running on Google Cloud, no action needs to be taken to authenticate.
Otherwise, the simplest way of authenticating your API calls is to
set up Application Default Credentials.
The credentials will automatically be used to authenticate. See
Set up Application Default Credentials for more details.
Getting started
All operations are performed through the following client classes:
Create a client instance by calling the static Create or CreateAsync methods. Alternatively,
use the builder class associated with each client class (e.g. ManagedKafkaClientBuilder for ManagedKafkaClient)
as an easy way of specifying custom credentials, settings, or a custom endpoint. Clients are thread-safe,
and we recommend using a single instance across your entire application unless you have a particular need
to configure multiple client objects separately.
Using the REST (HTTP/1.1) transport
This library defaults to performing RPCs using gRPC using the binary Protocol Buffer wire format.
However, it also supports HTTP/1.1 and JSON, for situations where gRPC doesn't work as desired. (This is typically due to an incompatible proxy
or other network issue.) To create a client using HTTP/1.1, specify a RestGrpcAdapter reference for the GrpcAdapter property in the client builder.
Sample code:
var client = new ManagedKafkaClientBuilder
{
GrpcAdapter = RestGrpcAdapter.Default
}.Build();
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003e\u003ccode\u003eGoogle.Cloud.ManagedKafka.V1\u003c/code\u003e is a .NET client library for the Managed Service for Apache Kafka API, with the latest version being 1.0.0-beta04.\u003c/p\u003e\n"],["\u003cp\u003eInstallation of the library is done via NuGet, and users should enable pre-release packages to access the latest beta versions, such as the 1.0.0-beta04.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication on Google Cloud requires no specific action, and outside of Google Cloud, Application Default Credentials are the recommended method.\u003c/p\u003e\n"],["\u003cp\u003eAll operations use \u003ccode\u003eManagedKafkaClient\u003c/code\u003e, which can be created via static \u003ccode\u003eCreate\u003c/code\u003e or \u003ccode\u003eCreateAsync\u003c/code\u003e methods, or by using its builder class, and clients are thread safe.\u003c/p\u003e\n"],["\u003cp\u003eThe library defaults to gRPC, but also supports HTTP/1.1 and JSON via the \u003ccode\u003eRestGrpcAdapter\u003c/code\u003e in the client builder for environments where gRPC is not compatible.\u003c/p\u003e\n"]]],[],null,["Version latestkeyboard_arrow_down\n\n- [1.0.0-beta07 (latest)](/dotnet/docs/reference/Google.Cloud.ManagedKafka.V1/latest)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.ManagedKafka.V1/1.0.0-beta06) \n\nGoogle.Cloud.ManagedKafka.V1\n============================\n\n`Google.Cloud.ManagedKafka.V1` is a.NET client library for the [Managed Service for Apache Kafka API API](https://cloud.google.com/managed-kafka).\n\nNote:\nThis documentation is for version `1.0.0-beta07` of the library.\nSome samples may not work with other versions.\n\nInstallation\n------------\n\nInstall the `Google.Cloud.ManagedKafka.V1` package from NuGet. Add it to\nyour project in the normal way (for example by right-clicking on the\nproject in Visual Studio and choosing \"Manage NuGet Packages...\").\nPlease ensure you enable pre-release packages (for example, in the\nVisual Studio NuGet user interface, check the \"Include prerelease\"\nbox). Some of the following samples might only work with the latest\npre-release version (`1.0.0-beta07`) of `Google.Cloud.ManagedKafka.V1`.\n\nAuthentication\n--------------\n\nWhen running on Google Cloud, no action needs to be taken to authenticate.\n\nOtherwise, the simplest way of authenticating your API calls is to\nset up Application Default Credentials.\nThe credentials will automatically be used to authenticate. See\n[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc) for more details.\n\nGetting started\n---------------\n\nAll operations are performed through the following client classes:\n\n- [ManagedKafkaClient](/dotnet/docs/reference/Google.Cloud.ManagedKafka.V1/latest/Google.Cloud.ManagedKafka.V1.ManagedKafkaClient)\n- [ManagedKafkaConnectClient](/dotnet/docs/reference/Google.Cloud.ManagedKafka.V1/latest/Google.Cloud.ManagedKafka.V1.ManagedKafkaConnectClient)\n\nCreate a client instance by calling the static `Create` or `CreateAsync` methods. Alternatively,\nuse the builder class associated with each client class (e.g. ManagedKafkaClientBuilder for ManagedKafkaClient)\nas an easy way of specifying custom credentials, settings, or a custom endpoint. Clients are thread-safe,\nand we recommend using a single instance across your entire application unless you have a particular need\nto configure multiple client objects separately.\n\n### Using the REST (HTTP/1.1) transport\n\nThis library defaults to performing RPCs using [gRPC](https://grpc.io/) using the binary [Protocol Buffer](https://protobuf.dev) wire format.\nHowever, it also supports HTTP/1.1 and JSON, for situations where gRPC doesn't work as desired. (This is typically due to an incompatible proxy\nor other network issue.) To create a client using HTTP/1.1, specify a `RestGrpcAdapter` reference for the `GrpcAdapter` property in the client builder.\nSample code: \n\n var client = new ManagedKafkaClientBuilder\n {\n GrpcAdapter = RestGrpcAdapter.Default\n }.Build();\n\nFor more details, see the [transport selection](https://cloud.google.com/dotnet/docs/reference/help/transports) page."]]
