Google Cloud Platform C++ Client Libraries
This repository contains idiomatic C++ client libraries for the following Google Cloud Platform services.
Please check the CHANGELOG for important announcements and upcoming changes.
Quickstart
Each library (see below) contains a directory named quickstart/
that's
intended to help you get up and running in a matter of minutes. This
quickstart/
directory contains a minimal "Hello World" program demonstrating
how to use the library, along with minimal build files for common build
systems, such as CMake and Bazel.
As an example, the following code snippet, taken from Google Cloud Storage, should give you a sense of what it's like to use one of these C++ libraries.
#include "google/cloud/storage/client.h"
#include <iostream>
int main(int argc, char* argv[]) {
if (argc != 2) {
std::cerr << "Missing bucket name.\n";
std::cerr << "Usage: quickstart <bucket-name>\n";
return 1;
}
std::string const bucket_name = argv[1];
// Create aliases to make the code easier to read.
namespace gcs = ::google::cloud::storage;
// Create a client to communicate with Google Cloud Storage. This client
// uses the default configuration for authentication and project id.
auto client = gcs::Client();
auto writer = client.WriteObject(bucket_name, "quickstart.txt");
writer << "Hello World!";
writer.Close();
if (!writer.metadata()) {
std::cerr << "Error creating object: " << writer.metadata().status()
<< "\n";
return 1;
}
std::cout << "Successfully created object: " << *writer.metadata() << "\n";
auto reader = client.ReadObject(bucket_name, "quickstart.txt");
if (!reader) {
std::cerr << "Error reading object: " << reader.status() << "\n";
return 1;
}
std::string contents{std::istreambuf_iterator<char>{reader}, {}};
std::cout << contents << "\n";
return 0;
}
GA Libraries
See each library's README.md
file for more information about:
- Where to find the documentation for the library and the service.
- How to get started using the library.
- How to incorporate the library into your build system.
- The library's support status if not Generally Available (GA); unless noted in
a library's
README.md
, these libraries are all GA and supported by Google.
Expand to see the full list of GA libraries
- Access Approval API [quickstart] [reference]
- Access Context Manager API [quickstart] [reference]
- Advisory Notifications API [quickstart] [reference]
- Vertex AI API [quickstart] [reference]
- AlloyDB API [quickstart] [reference]
- API Gateway API [quickstart] [reference]
- Apigee Connect API [quickstart] [reference]
- API Keys API [quickstart] [reference]
- App Engine Admin API [quickstart] [reference]
- Artifact Registry API [quickstart] [reference]
- Cloud Asset API [quickstart] [reference]
- Assured Workloads API [quickstart] [reference]
- Cloud AutoML API [quickstart] [reference]
- Bare Metal Solution API [quickstart] [reference]
- Batch API [quickstart] [reference]
- BeyondCorp API [quickstart] [reference]
- Google Cloud BigQuery [quickstart] [reference]
- Google Cloud Bigtable [quickstart] [reference]
- Cloud Billing Budget API [quickstart] [reference]
- Binary Authorization API [quickstart] [reference]
- Certificate Manager API [quickstart] [reference]
- Cloud Channel API [quickstart] [reference]
- Cloud Build API [quickstart] [reference]
- Cloud Composer [quickstart] [reference]
- Confidential Computing API [quickstart] [reference]
- Connectors API [quickstart] [reference]
- Contact Center AI Insights API [quickstart] [reference]
- Kubernetes Engine API [quickstart] [reference]
- Container Analysis API [quickstart] [reference]
- Document AI Warehouse API [quickstart] [reference]
- Google Cloud Data Catalog API [quickstart] [reference]
- Cloud Data Fusion API [quickstart] [reference]
- Database Migration API [quickstart] [reference]
- Cloud Dataplex API [quickstart] [reference]
- Cloud Dataproc API [quickstart] [reference]
- Datastream API [quickstart] [reference]
- Google Cloud Deploy API [quickstart] [reference]
- Dialogflow CX API [quickstart] [reference]
- Dialogflow ES API [quickstart] [reference]
- Cloud Data Loss Prevention (DLP) API [quickstart] [reference]
- Cloud Document AI API [quickstart] [reference]
- Cloud Domains API [quickstart] [reference]
- Distributed Cloud Edge Container API [quickstart] [reference]
- Essential Contacts API [quickstart] [reference]
- Eventarc API [quickstart] [reference]
- Cloud Filestore API [quickstart] [reference]
- Cloud Functions API [quickstart] [reference]
- Backup for GKE API [quickstart] [reference]
- GKE Hub [quickstart] [reference]
- Anthos Multi-Cloud API [quickstart] [reference]
- Google Cloud IAM [quickstart] [reference]
- Cloud Identity-Aware Proxy API [quickstart] [reference]
- Cloud IDS API [quickstart] [reference]
- Cloud IoT API [quickstart] [reference]
- Cloud Key Management Service (KMS) API [quickstart] [reference]
- Cloud Natural Language API [quickstart] [reference]
- Google Cloud Logging [quickstart] [reference]
- Managed Service for Microsoft Active Directory API [quickstart] [reference]
- Cloud Memorystore for Memcached API [quickstart] [reference]
- Dataproc Metastore API [quickstart] [reference]
- Migration Center API [quickstart] [reference]
- Cloud Monitoring API [quickstart] [reference]
- Network Connectivity API [quickstart] [reference]
- Network Management API [quickstart] [reference]
- Network Security API [quickstart] [reference]
- Network Services API [quickstart] [reference]
- Notebooks API [quickstart] [reference]
- Cloud Optimization API [quickstart] [reference]
- Organization Policy API [quickstart] [reference]
- OS Config API [quickstart] [reference]
- Cloud OS Login API [quickstart] [reference]
- Policy Troubleshooter API [quickstart] [reference]
- Certificate Authority API [quickstart] [reference]
- Cloud Profiler API [quickstart] [reference]
- Google Cloud Pub/Sub [quickstart] [reference]
- Rapid Migration Assessment API [quickstart] [reference]
- reCAPTCHA Enterprise API [quickstart] [reference]
- Recommender [quickstart] [reference]
- Google Cloud Memorystore for Redis API [quickstart] [reference]
- Cloud Resource Manager API [quickstart] [reference]
- Resource Settings API [quickstart] [reference]
- Retail API [quickstart] [reference]
- Cloud Run Admin API [quickstart] [reference]
- Cloud Scheduler API [quickstart] [reference]
- Secret Manager API [quickstart] [reference]
- Security Command Center API [quickstart] [reference]
- Service Control API [quickstart] [reference]
- Service Directory API [quickstart] [reference]
- Service Management API [quickstart] [reference]
- Service Usage API [quickstart] [reference]
- Cloud Shell API [quickstart] [reference]
- Google Cloud Spanner [quickstart] [reference]
- Cloud Speech-to-Text API [quickstart] [reference]
- Google Cloud Storage [quickstart] [reference]
- Storage Insights API [quickstart] [reference]
- Storage Transfer API [quickstart] [reference]
- Google Cloud Support API [quickstart] [reference]
- Cloud Talent Solution API [quickstart] [reference]
- Cloud Tasks API [quickstart] [reference]
- Cloud Text-to-Speech API [quickstart] [reference]
- Timeseries Insights API [quickstart] [reference]
- Cloud TPU API [quickstart] [reference]
- Cloud Trace API [quickstart] [reference]
- Cloud Translation API [quickstart] [reference]
- Video Services [quickstart] [reference]
- Cloud Video Intelligence API [quickstart] [reference]
- Cloud Vision API [quickstart] [reference]
- VM Migration API [quickstart] [reference]
- VMware Engine API [quickstart] [reference]
- Serverless VPC Access API [quickstart] [reference]
- Web Risk API [quickstart] [reference]
- Web Security Scanner API [quickstart] [reference]
- Workflow Executions API [quickstart] [reference]
- Cloud Workstations API [quickstart] [reference]
Building and Installing
This is a quickstart guide for developers wanting to compile the libraries and run the examples included with the libraries.
- Packaging maintainers or developers who prefer to install the library in a
fixed directory (such as
/usr/local
or/opt
) should consult the packaging guide. - Developers who prefer using a package manager such as vcpkg, or Conda, should follow the instructions for their package manager.
- Developers wanting to use the libraries as part of a larger CMake or Bazel project should consult the quickstart guides for the library or libraries they want to use.
- Developers wanting to compile the library just to run some examples or tests should read the current document.
- Contributors and developers to
google-cloud-cpp
should consult the guide to set up a development workstation.
Building with Bazel
This library requires Bazel >= 5.4. From the top-level directory, run the usual commands.
bazel build //...
Building with CMake
This library requires CMake >= 3.10. If you are planning to install the libraries
please consult the packaging guide, these instructions will
NOT produce artifacts that you can put in /usr/local
, or share with your
colleagues.
From the top-level directory of google-cloud-cpp
run these commands:
git -C $HOME clone https://github.com/microsoft/vcpkg.git
env VCPKG_ROOT=$HOME/vcpkg $HOME/vcpkg/bootstrap-vcpkg.sh
cmake -S . -B cmake-out/ -DCMAKE_TOOLCHAIN_FILE=$HOME/vcpkg/scripts/buildsystems/vcpkg.cmake
cmake --build cmake-out -- -j $(nproc)
The binary artifacts, such as examples, will be placed in cmake-out/
.
Support
- This project follows Google's Foundational C++ Support Policy,
which is summarized in the Foundational C++ Support Matrix.
- Language Version (>= C++14).
- Operating Systems: Windows, macOS, and Linux.
- Build Systems: Bazel (>= 5.4), CMake (>= 3.10).
- Compilers: GCC (>= 7.3), Clang (>= 6.0), MSVC (>= 2019), Apple Clang (>= 12).
- This project uses dependencies described in doc/packaging.md.
- This project works with or without exceptions enabled.
- This project cuts monthly releases with detailed release notes.
Public API and API Breaking Changes
This project follows Google's OSS Library Breaking Change Policy.
In general, we avoid making backwards incompatible changes to our C++ APIs (see
below for the definition of "API"). Sometimes such changes yield benefits to
our customers, in the form of better performance, easier-to-understand APIs,
and/or more consistent APIs across services. When these benefits warrant it, we
will announce these changes prominently in our CHANGELOG.md
file and in the
affected release's notes. Nevertheless, though we take commercially reasonable
efforts to prevent this, it is possible that backwards incompatible changes go
undetected and, therefore, undocumented. We apologize if this is the case and
welcome feedback or bug reports to rectify the problem.
By "API" we mean the C++ API exposed by public header files in this repo. We are not talking about the gRPC or REST APIs exposed by Google Cloud servers. We are also talking only about API stability -- the ABI is subject to change without notice. You should not assume that binary artifacts (e.g. static libraries, shared objects, dynamically loaded libraries, object files) created with one version of the library are usable with newer/older versions of the library. The ABI may, and does, change on "minor revisions", and even patch releases.
We request that our customers adhere to the following guidelines to avoid accidentally depending on parts of the library we do not consider to be part of the public API and therefore may change (including removal) without notice:
Previous versions of the library will remain available on the GitHub Releases page. In many cases, you will be able to use an older version even if a newer version has changes that you are unable (or do not have time) to adopt.
Note that this document has no bearing on the Google Cloud Platform deprecation policy described at https://cloud.google.com/terms.
C++ Symbols and Files
- You should only include headers matching the
google/cloud/${library}/*.h
,google/cloud/${library}/mock/*.h
orgoogle/cloud/*.h
patterns. - You should NOT directly include headers in any subdirectories, such as
google/cloud/${library}/internal
. - The files included from our public headers are not part of our public
API. Depending on indirect includes may break your build in the future, as
we may change a header
"foo.h"
to stop including"bar.h"
if"foo.h"
no longer needs the symbols in"bar.h"
. To avoid having your code broken, you should directly include the public headers that define all the symbols you use (this is sometimes known as include-what-you-use). - Any file or symbol that lives within a directory or namespace containing
internal
,impl
,test
,detail
,benchmark
,sample
, orexample
, is explicitly not part of our public API. - Any file or symbol with
Impl
orimpl
in its name is not part of our public API. - Any symbol with
experimental
in its name is not part of the public API. - You should avoid naming our inline namespaces (even avoid spelling the
preprocessor names like
GOOGLE_CLOUD_CPP_NS
) and instead rely on them being a transparent versioning mechanism that you almost certainly don't care about. If you do spell out specific inline namespace names, your code will be tightly coupled with that specific version and will likely break when upgrading to a new version of our library.
Beyond the C++ API
Applications developers interact with a C++ library through more than just the C++ symbols and headers. They also need to reference the name of the library in their build scripts. Depending on the build system they use this may be a CMake target, a Bazel rule, a pkg-config module, or just the name of some object in the file system.
As with the C++ API, we try to avoid breaking changes to these interface
points. Sometimes such changes yield benefits to our customers, in the form of
bug fixes, increased consistency across services, or easier to understand names.
When these benefits warrant it, we will announce these changes prominently in
our CHANGELOG.md
file and in the affected release's notes. Nevertheless,
though we take commercially reasonable efforts to prevent this, it is possible
that backwards incompatible changes go undetected and, therefore, undocumented.
We apologize if this is the case and welcome feedback or bug reports to rectify
the problem.
Experimental Libraries
From time to time we add libraries to google-cloud-cpp
to validate new
designs, expose experimental (or otherwise not generally available) GCP
features, or simply because a library is not yet complete. Such libraries
will have experimental
in their CMake target and Bazel rule names. The
README file for these libraries will also document that they are experimental.
Such libraries are subject to change, including removal, without notice.
This includes, but it is not limited to, all their symbols, pre-processor
macros, files, targets, rules, and installed artifacts.
Bazel rules
Only the rules exported at the top-level directory are intended for customer
use, e.g.,//:spanner
. Experimental rules have experimental
in their name,
e.g. //:experimental-logging
. As previously stated, experimental rules are
subject to change or removal without notice.
CMake targets and packages
Only CMake packages starting with the google_cloud_cpp_
prefix are intended
for customer use. Only targets starting with google-cloud-cpp::
, are intended
for customer use. Experimental targets have experimental
in their name (e.g.
google-cloud-cpp::experimental-logging
). As previously stated, experimental
targets are subject to change or removal without notice.
pkg-config modules
Only modules starting with google_cloud_cpp_
are intended for customer use.
Unsupported use cases
We try to provide stable names for the previously described mechanisms:
- Bazel rules,
- CMake targets loaded via
find_package()
, - pkg-config modules
It is certainly possible to use the library using other approaches. While these may work, we may accidentally break these from time to time. Examples of such, and the recommended alternatives, include:
-
CMake's
FetchContent
and/or git submodules: in these approaches thegoogle-cloud-cpp
library becomes a subdirectory of a larger CMake build We do not testgoogle-cloud-cpp
in these configurations, and we find them brittle as all CMake targets become visible to the larger project. This is both prone to conflicts, and makes it impossible to enforce that some targets are only for testing or are implementation details. Applications may want to consider source package managers, such asvcpkg
, or CMake super builds viaExternalProject_Add()
as alternatives. -
Using library names directly: applications should not use the library names, e.g., by using
-lgoogle_cloud_cpp_bigtable
in build scripts. We may need to split or merge libraries over time, making such names unstable. Applications should use CMake targets, e.g.,google-cloud-cpp::bigtable
, or pkg-config modules, e.g.,$(pkg-config google_cloud_cpp_bigtable --libs)
instead.
Environment Variables
Environment variables referenced in our documentation come with the same guarantees as our public APIs. That is, we are committed to supporting their behavior unless the behavior affects experimental components, or the environment variable itself is experimental.
Telemetry Data
The library can be configured to produce telemetry data, such as logs or traces. We make no guarantees around the contents of such data. For example, we may change the format of our logs, or the names of our spans without notice.
The APIs to programmatically enable logging and tracing have the same guarantees as any other public APIs in our libraries.
Documentation and Comments
The documentation (and its links) is intended for human consumption and not third party websites, or automation (such as scripts scraping the contents). The contents and links of our documentation may change without notice.
Other Interface Points
We think this covers all interface points, if we missed something please file a GitHub issue.
Contact us
- GitHub Discussions -- For questions and general comments
- GitHub Issues -- For reporting bugs and feature requests
Contributing changes
See CONTRIBUTING.md
for details on how to contribute to
this project, including how to build and test your changes as well as how to
properly format your code.
Licensing
Apache 2.0; see LICENSE
for details.