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>
#include <string>
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 a client to communicate with Google Cloud Storage. This client
// uses the default configuration for authentication and project id.
auto client = google::cloud::storage::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](/google-cloud-cpp/google/cloud/accessapproval/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/accessapproval/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/accessapproval/latest)
- [Access Context Manager API](/google-cloud-cpp/google/cloud/accesscontextmanager/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/accesscontextmanager/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/accesscontextmanager/latest)
- [Advisory Notifications API](/google-cloud-cpp/google/cloud/advisorynotifications/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/advisorynotifications/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/advisorynotifications/latest)
- [Vertex AI API](/google-cloud-cpp/google/cloud/aiplatform/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/aiplatform/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/aiplatform/latest)
- [AlloyDB API](/google-cloud-cpp/google/cloud/alloydb/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/alloydb/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/alloydb/latest)
- [API Gateway API](/google-cloud-cpp/google/cloud/apigateway/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/apigateway/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/apigateway/latest)
- [Apigee Connect API](/google-cloud-cpp/google/cloud/apigeeconnect/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/apigeeconnect/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/apigeeconnect/latest)
- [API Keys API](/google-cloud-cpp/google/cloud/apikeys/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/apikeys/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/apikeys/latest)
- [App Engine Admin API](/google-cloud-cpp/google/cloud/appengine/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/appengine/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/appengine/latest)
- [App Hub API](/google-cloud-cpp/google/cloud/apphub/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/apphub/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/apphub/latest)
- [Artifact Registry API](/google-cloud-cpp/google/cloud/artifactregistry/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/artifactregistry/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/artifactregistry/latest)
- [Cloud Asset API](/google-cloud-cpp/google/cloud/asset/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/asset/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/asset/latest)
- [Assured Workloads API](/google-cloud-cpp/google/cloud/assuredworkloads/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/assuredworkloads/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/assuredworkloads/latest)
- [Cloud AutoML API](/google-cloud-cpp/google/cloud/automl/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/automl/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/automl/latest)
- [Backup and DR Service API](/google-cloud-cpp/google/cloud/backupdr/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/backupdr/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/backupdr/latest)
- [Bare Metal Solution API](/google-cloud-cpp/google/cloud/baremetalsolution/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/baremetalsolution/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/baremetalsolution/latest)
- [Batch API](/google-cloud-cpp/google/cloud/batch/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/batch/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/batch/latest)
- [BeyondCorp API](/google-cloud-cpp/google/cloud/beyondcorp/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/beyondcorp/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/beyondcorp/latest)
- [Google Cloud BigQuery](/google-cloud-cpp/google/cloud/bigquery/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/bigquery/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/bigquery/latest)
- [Google Cloud Bigtable](/google-cloud-cpp/google/cloud/bigtable/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/bigtable/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/bigtable/latest)
- [Cloud Billing Budget API](/google-cloud-cpp/google/cloud/billing/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/billing/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/billing/latest)
- [Binary Authorization API](/google-cloud-cpp/google/cloud/binaryauthorization/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/binaryauthorization/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/binaryauthorization/latest)
- [Certificate Manager API](/google-cloud-cpp/google/cloud/certificatemanager/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/certificatemanager/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/certificatemanager/latest)
- [Cloud Channel API](/google-cloud-cpp/google/cloud/channel/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/channel/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/channel/latest)
- [Cloud Build API](/google-cloud-cpp/google/cloud/cloudbuild/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/cloudbuild/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/cloudbuild/latest)
- [Cloud Controls Partner API](/google-cloud-cpp/google/cloud/cloudcontrolspartner/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/cloudcontrolspartner/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/cloudcontrolspartner/latest)
- [Cloud Quotas API](/google-cloud-cpp/google/cloud/cloudquotas/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/cloudquotas/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/cloudquotas/latest)
- [Cloud Commerce Consumer Procurement API](/google-cloud-cpp/google/cloud/commerce/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/commerce/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/commerce/latest)
- [Cloud Composer](/google-cloud-cpp/google/cloud/composer/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/composer/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/composer/latest)
- [Compute Engine API](/google-cloud-cpp/google/cloud/compute/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/compute/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/compute/latest)
- [Confidential Computing API](/google-cloud-cpp/google/cloud/confidentialcomputing/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/confidentialcomputing/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/confidentialcomputing/latest)
- [Infrastructure Manager API](/google-cloud-cpp/google/cloud/config/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/config/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/config/latest)
- [Connectors API](/google-cloud-cpp/google/cloud/connectors/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/connectors/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/connectors/latest)
- [Contact Center AI Insights API](/google-cloud-cpp/google/cloud/contactcenterinsights/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/contactcenterinsights/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/contactcenterinsights/latest)
- [Kubernetes Engine API](/google-cloud-cpp/google/cloud/container/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/container/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/container/latest)
- [Container Analysis API](/google-cloud-cpp/google/cloud/containeranalysis/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/containeranalysis/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/containeranalysis/latest)
- [Document AI Warehouse API](/google-cloud-cpp/google/cloud/contentwarehouse/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/contentwarehouse/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/contentwarehouse/latest)
- [Google Cloud Data Catalog API](/google-cloud-cpp/google/cloud/datacatalog/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/datacatalog/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/datacatalog/latest)
- [Cloud Data Fusion API](/google-cloud-cpp/google/cloud/datafusion/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/datafusion/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/datafusion/latest)
- [Database Migration API](/google-cloud-cpp/google/cloud/datamigration/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/datamigration/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/datamigration/latest)
- [Cloud Dataplex API](/google-cloud-cpp/google/cloud/dataplex/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/dataplex/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/dataplex/latest)
- [Cloud Dataproc API](/google-cloud-cpp/google/cloud/dataproc/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/dataproc/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/dataproc/latest)
- [Cloud Datastore API](/google-cloud-cpp/google/cloud/datastore/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/datastore/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/datastore/latest)
- [Datastream API](/google-cloud-cpp/google/cloud/datastream/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/datastream/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/datastream/latest)
- [Google Cloud Deploy API](/google-cloud-cpp/google/cloud/deploy/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/deploy/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/deploy/latest)
- [Developer Connect API](/google-cloud-cpp/google/cloud/developerconnect/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/developerconnect/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/developerconnect/latest)
- [Dialogflow CX API](/google-cloud-cpp/google/cloud/dialogflow_cx/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/dialogflow_cx/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/dialogflow_cx/latest)
- [Dialogflow ES API](/google-cloud-cpp/google/cloud/dialogflow_es/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/dialogflow_es/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/dialogflow_es/latest)
- [Discovery Engine API](/google-cloud-cpp/google/cloud/discoveryengine/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/discoveryengine/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/discoveryengine/latest)
- [Cloud Data Loss Prevention (DLP) API](/google-cloud-cpp/google/cloud/dlp/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/dlp/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/dlp/latest)
- [Cloud Document AI API](/google-cloud-cpp/google/cloud/documentai/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/documentai/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/documentai/latest)
- [Cloud Domains API](/google-cloud-cpp/google/cloud/domains/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/domains/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/domains/latest)
- [Distributed Cloud Edge Container API](/google-cloud-cpp/google/cloud/edgecontainer/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/edgecontainer/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/edgecontainer/latest)
- [Distributed Cloud Edge Network API](/google-cloud-cpp/google/cloud/edgenetwork/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/edgenetwork/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/edgenetwork/latest)
- [Essential Contacts API](/google-cloud-cpp/google/cloud/essentialcontacts/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/essentialcontacts/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/essentialcontacts/latest)
- [Eventarc API](/google-cloud-cpp/google/cloud/eventarc/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/eventarc/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/eventarc/latest)
- [Cloud Filestore API](/google-cloud-cpp/google/cloud/filestore/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/filestore/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/filestore/latest)
- [Cloud Functions API](/google-cloud-cpp/google/cloud/functions/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/functions/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/functions/latest)
- [Backup for GKE API](/google-cloud-cpp/google/cloud/gkebackup/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/gkebackup/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/gkebackup/latest)
- [Connect Gateway API](/google-cloud-cpp/google/cloud/gkeconnect/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/gkeconnect/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/gkeconnect/latest)
- [GKE Hub](/google-cloud-cpp/google/cloud/gkehub/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/gkehub/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/gkehub/latest)
- [Anthos Multi-Cloud API](/google-cloud-cpp/google/cloud/gkemulticloud/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/gkemulticloud/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/gkemulticloud/latest)
- [Google Cloud IAM](/google-cloud-cpp/google/cloud/iam/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/iam/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/iam/latest)
- [Cloud Identity-Aware Proxy API](/google-cloud-cpp/google/cloud/iap/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/iap/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/iap/latest)
- [Cloud IDS API](/google-cloud-cpp/google/cloud/ids/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/ids/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/ids/latest)
- [Cloud Key Management Service (KMS) API](/google-cloud-cpp/google/cloud/kms/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/kms/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/kms/latest)
- [Cloud Natural Language API](/google-cloud-cpp/google/cloud/language/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/language/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/language/latest)
- [Google Cloud Logging](/google-cloud-cpp/google/cloud/logging/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/logging/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/logging/latest)
- [Managed Service for Microsoft Active Directory API](/google-cloud-cpp/google/cloud/managedidentities/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/managedidentities/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/managedidentities/latest)
- [Managed Service for Apache Kafka API](/google-cloud-cpp/google/cloud/managedkafka/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/managedkafka/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/managedkafka/latest)
- [Cloud Memorystore for Memcached API](/google-cloud-cpp/google/cloud/memcache/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/memcache/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/memcache/latest)
- [Dataproc Metastore API](/google-cloud-cpp/google/cloud/metastore/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/metastore/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/metastore/latest)
- [Migration Center API](/google-cloud-cpp/google/cloud/migrationcenter/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/migrationcenter/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/migrationcenter/latest)
- [Cloud Monitoring API](/google-cloud-cpp/google/cloud/monitoring/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/monitoring/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/monitoring/latest)
- [NetApp API](/google-cloud-cpp/google/cloud/netapp/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/netapp/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/netapp/latest)
- [Network Connectivity API](/google-cloud-cpp/google/cloud/networkconnectivity/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/networkconnectivity/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/networkconnectivity/latest)
- [Network Management API](/google-cloud-cpp/google/cloud/networkmanagement/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/networkmanagement/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/networkmanagement/latest)
- [Network Security API](/google-cloud-cpp/google/cloud/networksecurity/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/networksecurity/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/networksecurity/latest)
- [Network Services API](/google-cloud-cpp/google/cloud/networkservices/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/networkservices/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/networkservices/latest)
- [Notebooks API](/google-cloud-cpp/google/cloud/notebooks/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/notebooks/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/notebooks/latest)
- [OAuth2 Access Token Generation](/google-cloud-cpp/google/cloud/oauth2/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/oauth2/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/oauth2/latest)
- [Cloud Optimization API](/google-cloud-cpp/google/cloud/optimization/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/optimization/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/optimization/latest)
- [Organization Policy API](/google-cloud-cpp/google/cloud/orgpolicy/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/orgpolicy/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/orgpolicy/latest)
- [OS Config API](/google-cloud-cpp/google/cloud/osconfig/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/osconfig/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/osconfig/latest)
- [Cloud OS Login API](/google-cloud-cpp/google/cloud/oslogin/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/oslogin/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/oslogin/latest)
- [Parallelstore API](/google-cloud-cpp/google/cloud/parallelstore/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/parallelstore/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/parallelstore/latest)
- [Policy Simulator API](/google-cloud-cpp/google/cloud/policysimulator/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/policysimulator/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/policysimulator/latest)
- [Policy Troubleshooter API](/google-cloud-cpp/google/cloud/policytroubleshooter/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/policytroubleshooter/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/policytroubleshooter/latest)
- [Certificate Authority API](/google-cloud-cpp/google/cloud/privateca/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/privateca/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/privateca/latest)
- [Privileged Access Manager API](/google-cloud-cpp/google/cloud/privilegedaccessmanager/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/privilegedaccessmanager/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/privilegedaccessmanager/latest)
- [Cloud Profiler API](/google-cloud-cpp/google/cloud/profiler/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/profiler/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/profiler/latest)
- [Public Certificate Authority API](/google-cloud-cpp/google/cloud/publicca/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/publicca/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/publicca/latest)
- [Google Cloud Pub/Sub](/google-cloud-cpp/google/cloud/pubsub/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/pubsub/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/pubsub/latest)
- [Rapid Migration Assessment API](/google-cloud-cpp/google/cloud/rapidmigrationassessment/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/rapidmigrationassessment/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/rapidmigrationassessment/latest)
- [reCAPTCHA Enterprise API](/google-cloud-cpp/google/cloud/recaptchaenterprise/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/recaptchaenterprise/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/recaptchaenterprise/latest)
- [Recommender](/google-cloud-cpp/google/cloud/recommender/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/recommender/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/recommender/latest)
- [Google Cloud Memorystore for Redis API](/google-cloud-cpp/google/cloud/redis/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/redis/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/redis/latest)
- [Cloud Resource Manager API](/google-cloud-cpp/google/cloud/resourcemanager/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/resourcemanager/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/resourcemanager/latest)
- [Resource Settings API](/google-cloud-cpp/google/cloud/resourcesettings/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/resourcesettings/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/resourcesettings/latest)
- [Retail API](/google-cloud-cpp/google/cloud/retail/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/retail/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/retail/latest)
- [Cloud Run Admin API](/google-cloud-cpp/google/cloud/run/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/run/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/run/latest)
- [Cloud Scheduler API](/google-cloud-cpp/google/cloud/scheduler/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/scheduler/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/scheduler/latest)
- [Secret Manager API](/google-cloud-cpp/google/cloud/secretmanager/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/secretmanager/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/secretmanager/latest)
- [Secure Source Manager API](/google-cloud-cpp/google/cloud/securesourcemanager/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/securesourcemanager/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/securesourcemanager/latest)
- [Security Command Center API](/google-cloud-cpp/google/cloud/securitycenter/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/securitycenter/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/securitycenter/latest)
- [Security Center Management API](/google-cloud-cpp/google/cloud/securitycentermanagement/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/securitycentermanagement/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/securitycentermanagement/latest)
- [Service Control API](/google-cloud-cpp/google/cloud/servicecontrol/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/servicecontrol/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/servicecontrol/latest)
- [Service Directory API](/google-cloud-cpp/google/cloud/servicedirectory/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/servicedirectory/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/servicedirectory/latest)
- [Service Health API](/google-cloud-cpp/google/cloud/servicehealth/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/servicehealth/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/servicehealth/latest)
- [Service Management API](/google-cloud-cpp/google/cloud/servicemanagement/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/servicemanagement/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/servicemanagement/latest)
- [Service Usage API](/google-cloud-cpp/google/cloud/serviceusage/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/serviceusage/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/serviceusage/latest)
- [Cloud Shell API](/google-cloud-cpp/google/cloud/shell/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/shell/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/shell/latest)
- [Google Cloud Spanner](/google-cloud-cpp/google/cloud/spanner/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/spanner/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/spanner/latest)
- [Cloud Speech-to-Text API](/google-cloud-cpp/google/cloud/speech/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/speech/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/speech/latest)
- [Cloud SQL Admin API](/google-cloud-cpp/google/cloud/sql/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/sql/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/sql/latest)
- [Google Cloud Storage](/google-cloud-cpp/google/cloud/storage/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/storage/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/storage/latest)
- [Storage Control API](/google-cloud-cpp/google/cloud/storagecontrol/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/storagecontrol/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/storagecontrol/latest)
- [Storage Insights API](/google-cloud-cpp/google/cloud/storageinsights/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/storageinsights/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/storageinsights/latest)
- [Storage Transfer API](/google-cloud-cpp/google/cloud/storagetransfer/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/storagetransfer/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/storagetransfer/latest)
- [Google Cloud Support API](/google-cloud-cpp/google/cloud/support/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/support/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/support/latest)
- [Cloud Talent Solution API](/google-cloud-cpp/google/cloud/talent/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/talent/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/talent/latest)
- [Cloud Tasks API](/google-cloud-cpp/google/cloud/tasks/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/tasks/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/tasks/latest)
- [Telco Automation API](/google-cloud-cpp/google/cloud/telcoautomation/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/telcoautomation/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/telcoautomation/latest)
- [Cloud Text-to-Speech API](/google-cloud-cpp/google/cloud/texttospeech/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/texttospeech/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/texttospeech/latest)
- [Timeseries Insights API](/google-cloud-cpp/google/cloud/timeseriesinsights/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/timeseriesinsights/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/timeseriesinsights/latest)
- [Cloud TPU API](/google-cloud-cpp/google/cloud/tpu/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/tpu/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/tpu/latest)
- [Cloud Trace API](/google-cloud-cpp/google/cloud/trace/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/trace/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/trace/latest)
- [Cloud Translation API](/google-cloud-cpp/google/cloud/translate/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/translate/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/translate/latest)
- [Video Services](/google-cloud-cpp/google/cloud/video/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/video/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/video/latest)
- [Cloud Video Intelligence API](/google-cloud-cpp/google/cloud/videointelligence/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/videointelligence/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/videointelligence/latest)
- [Cloud Vision API](/google-cloud-cpp/google/cloud/vision/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/vision/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/vision/latest)
- [VM Migration API](/google-cloud-cpp/google/cloud/vmmigration/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/vmmigration/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/vmmigration/latest)
- [VMware Engine API](/google-cloud-cpp/google/cloud/vmwareengine/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/vmwareengine/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/vmwareengine/latest)
- [Serverless VPC Access API](/google-cloud-cpp/google/cloud/vpcaccess/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/vpcaccess/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/vpcaccess/latest)
- [Web Risk API](/google-cloud-cpp/google/cloud/webrisk/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/webrisk/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/webrisk/latest)
- [Web Security Scanner API](/google-cloud-cpp/google/cloud/websecurityscanner/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/websecurityscanner/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/websecurityscanner/latest)
- [Workflow Executions API](/google-cloud-cpp/google/cloud/workflows/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/workflows/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/workflows/latest)
- [Cloud Workstations API](/google-cloud-cpp/google/cloud/workstations/)
[\[quickstart\]](/google-cloud-cpp/google/cloud/workstations/quickstart/)
[\[reference\]](https://cloud.google.com/cpp/docs/reference/workstations/latest)
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 >= 6.0. From the top-level directory, run the usual
commands.
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 (>= 6.0), CMake (>= 3.10).
- Compilers: GCC (>= 7.5), Clang (>= 6.0), MSVC (>= 2022), 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
public 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.
- Increase the major version for
google-cloud-cpp
.
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.
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.