Note:
This documentation is for version 2.4.0 of the library.
Some samples may not work with other versions.
Installation
Install the Google.Cloud.Deploy.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...").
Authentication
When running on Google Cloud Platform, no action needs to be taken to authenticate.
Otherwise, the simplest way of authenticating your API calls is to
download a service account JSON file then set the GOOGLE_APPLICATION_CREDENTIALS environment variable to refer to it.
The credentials will automatically be used to authenticate. See the Getting Started With
Authentication guide for more details.
Create a client instance by calling the static Create or CreateAsync methods. Alternatively,
use the builder class associated with each client class (e.g. CloudDeployClientBuilder for CloudDeployClient)
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 CloudDeployClientBuilder
{
GrpcAdapter = RestGrpcAdapter.Default
}.Build();
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["This documentation pertains to version 2.4.0 of the `Google.Cloud.Deploy.V1` .NET client library for the Google Cloud Deploy API, which is available for installation via NuGet."],["The library automatically authenticates when running on Google Cloud Platform, but otherwise, requires setting the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to a service account JSON file."],["All operations are executed through the `CloudDeployClient`, which can be created using static `Create` or `CreateAsync` methods or using its builder for customized configurations, with the recommendation to use a single instance across the entire application for thread safety."],["The library supports both gRPC and HTTP/1.1 with JSON transport, with the latter being accessible by specifying a `RestGrpcAdapter` in the client builder for situations where gRPC is incompatible."],["The page contains the documentation for the version `2.4.0`, while also containing the documentation for the rest of the versions starting from `1.0.0` until `3.4.0 (latest)`."]]],[]]
