An idiomatic C++ client library for the Cloud Shell API, a service to allow users to start, configure, and connect to interactive shell sessions running in the cloud.

While this library is GA, please note Google Cloud C++ client libraries do not follow Semantic Versioning.

Quickstart

The following shows the code that you'll run in the google/cloud/shell/quickstart/ directory, which should give you a taste of the Cloud Shell API C++ client library API.

#include "google/cloud/shell/v1/cloud_shell_client.h"
#include <iostream>
#include <string>

int main(int argc, char* argv[]) try {
  if (argc != 2) {
    std::cerr << "Usage: " << argv[0] << " user\n";
    return 1;
  }

  namespace shell = ::google::cloud::shell_v1;
  auto client =
      shell::CloudShellServiceClient(shell::MakeCloudShellServiceConnection());

  auto const name = "users/" + std::string{argv[1]} + "/environments/default";
  auto env = client.GetEnvironment(name);
  if (!env) throw std::move(env).status();
  std::cout << env->DebugString() << "\n";

  return 0;
} catch (google::cloud::Status const& status) {
  std::cerr << "google::cloud::Status thrown: " << status << "\n";
  return 1;
}

Main classes

The main class in this library is shell_v1::CloudShellServiceClient. All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mock shell_v1::CloudShellServiceClient when testing your application.

More Information

• Error Handling - describes how the library reports errors.
• How to Override the Default Endpoint - describes how to override the default endpoint.
• How to Override the Authentication Credentials - describes how to change the authentication credentials used by the library.
• Override Retry, Backoff, and Idempotency Policies - describes how to change the default retry policies.
• Environment Variables - describes environment variables that can configure the behavior of the library.
• How to Override the Default Universe Domain - describes how to override the default universe domain.