Google.Cloud.Batch.V1 is a.NET client library for the Batch API.
Note:
This documentation is for version 2.5.0 of the library.
Some samples may not work with other versions.
Installation
Install the Google.Cloud.Batch.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, 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. BatchServiceClientBuilder for BatchServiceClient)
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 BatchServiceClientBuilder
{
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."],[[["\u003cp\u003eThe \u003ccode\u003eGoogle.Cloud.Batch.V1\u003c/code\u003e library is a .NET client library for interacting with the Google Cloud Batch API, with the latest version available being 2.13.0.\u003c/p\u003e\n"],["\u003cp\u003eThis webpage's documentation is specifically for version 2.5.0 of the \u003ccode\u003eGoogle.Cloud.Batch.V1\u003c/code\u003e library, and some samples provided may not work correctly with other versions.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication for the API when running on Google Cloud is automatic, and for other environments, you can use a service account JSON file and the \u003ccode\u003eGOOGLE_APPLICATION_CREDENTIALS\u003c/code\u003e environment variable.\u003c/p\u003e\n"],["\u003cp\u003eThe primary way to interact with the Batch API is through the \u003ccode\u003eBatchServiceClient\u003c/code\u003e, which you can create via the static \u003ccode\u003eCreate\u003c/code\u003e or \u003ccode\u003eCreateAsync\u003c/code\u003e methods, and it is thread-safe, as well as recommended to use one for the whole application.\u003c/p\u003e\n"],["\u003cp\u003eWhile the library uses gRPC and Protocol Buffers by default, it also supports using HTTP/1.1 and JSON by setting the \u003ccode\u003eGrpcAdapter\u003c/code\u003e property in the client builder to \u003ccode\u003eRestGrpcAdapter.Default\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]
