Skip to content

Latest commit

 

History

History
157 lines (126 loc) · 12.6 KB

README.md

File metadata and controls

157 lines (126 loc) · 12.6 KB
Raw

Google Cloud Libraries for .NET

.NET idiomatic client libraries for Google Cloud Platform services.

Travis build Status Appveyor build status Coverage Status

The following libraries are available at a GA quality level:

The following libraries are available at a beta quality level:

The following libraries are available at an alpha quality level:

  • Google Cloud Metadata - API docs (alpha)

See the API documentation for details of the status of each library.

Note: This client is a work-in-progress, and may occasionally make backwards-incompatible changes.

If you need support for other Google APIs, check out the Google .NET API Client library

Example Applications

Specifying a Project ID

Most Google Cloud Libraries for .NET require a project ID. If you don't remember yours (or haven't created a project yet), navigate to the Google Developers Console to view your project ID (or create a new project and then get the ID). Once done, record the value and make sure to pass it as a parameter to the methods that require it.

Authentication

Every API call needs to be authenticated. In order to successfully make a call, first ensure that the necessary Google Cloud APIs are enabled for your project and that you've downloaded the right set of keys (if it applies to you) as explained in the authentication document.

Next, choose a method for authenticating API requests from within your project:

  1. When using google-cloud-dotnet libraries from within Compute/App Engine, no additional authentication steps are necessary.
  2. When using google-cloud-dotnet libraries elsewhere, you can do one of the following:

    • Define the environment variable GOOGLE_APPLICATION_CREDENTIALS to be the location of the key. For example:

      set GOOGLE_APPLICATION_CREDENTIALS=/path/to/my/key.json

    • If running locally for development/testing, you can authenticate using the Google Cloud SDK. Download the SDK if you haven't already, then login by running the following in the command line:

      gcloud auth application-default login

Supported platforms

See the Supported Platforms documentation for details on where the Google Cloud Libraries for .NET are supported.

Versioning

The Google Cloud Client Libraries for .NET follow Semantic Versioning.

The version number in the package name (and .NET namespace) represents the version of the underlying API; the version number for the package itself indicates the status of the client library, according to the following quality levels:

GA: Libraries defined at a GA (General Availability) quality level are expected to be stable: breaking API changes will not be made without a new major release.

Beta: Libraries defined at a Beta quality level are expected to be stable and working, but the API surface is still under active development. We encourage you to experiment with these libraries, but expect breaking changes in future versions. There may still be issues, but we have a fairly high degree of confidence.

Alpha: Libraries defined at an Alpha quality level are still experimental. They may have significant issues, and the API surface will almost certainly change before a final release. We encourage experimentation with these libraries on test projects, but strongly discourage you from using them in a production environment.

License

Apache 2.0 - See LICENSE for more information.