Google.Cloud.Orchestration.Airflow.Service.V1is a.NET client library for theCloud Composer API.
Note:
This documentation is for version2.2.0of the library.
Some samples may not work with other versions.
Installation
Install theGoogle.Cloud.Orchestration.Airflow.Service.V1package 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 theGOOGLE_APPLICATION_CREDENTIALSenvironment variable to refer to it.
The credentials will automatically be used to authenticate. See theGetting Started With
Authenticationguide for more details.
Getting started
All operations are performed through the following client classes:
Create a client instance by calling the staticCreateorCreateAsyncmethods. Alternatively,
use the builder class associated with each client class (e.g. EnvironmentsClientBuilder for EnvironmentsClient)
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 usinggRPCusing the binaryProtocol Bufferwire 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 aRestGrpcAdapterreference for theGrpcAdapterproperty in the client builder.
Sample code:
var client = new EnvironmentsClientBuilder
{
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-09-04 UTC."],[[["\u003cp\u003e\u003ccode\u003eGoogle.Cloud.Orchestration.Airflow.Service.V1\u003c/code\u003e is a .NET client library for the Cloud Composer API, with version 2.2.0 being the current documentation version.\u003c/p\u003e\n"],["\u003cp\u003eThe library offers multiple versions, ranging from 1.0.0 to 2.9.0 (the latest), with links provided for each in the documentation.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication on Google Cloud Platform is automatic, while other environments require setting the \u003ccode\u003eGOOGLE_APPLICATION_CREDENTIALS\u003c/code\u003e environment variable with a service account JSON file.\u003c/p\u003e\n"],["\u003cp\u003eClient operations are performed through \u003ccode\u003eEnvironmentsClient\u003c/code\u003e and \u003ccode\u003eImageVersionsClient\u003c/code\u003e classes, which can be instantiated using \u003ccode\u003eCreate\u003c/code\u003e, \u003ccode\u003eCreateAsync\u003c/code\u003e or by utilizing builder classes.\u003c/p\u003e\n"],["\u003cp\u003eThe library supports both gRPC and HTTP/1.1 with JSON, allowing for flexibility in network environments, and HTTP/1.1 can be used by specifying \u003ccode\u003eRestGrpcAdapter.Default\u003c/code\u003e in the client builder.\u003c/p\u003e\n"]]],[],null,[]]
