# Cloud Shell API C++ Client Library

3.7.0-rc 3.6.0 (latest) 3.5.0 3.4.0 3.3.0 3.2.0 2.48.0-rc 2.47.1 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.29.0 2.28.0 2.27.0 2.26.0 2.25.1 2.24.0 2.23.0 2.22.1 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.1 2.14.0 2.13.0 2.12.0 2.11.0 An idiomatic C++ client library for the [Cloud Shell API](https://cloud.google.com/shell), 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](https://semver.org/).

### 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`](https://docs.cloud.google.com/cpp/docs/reference/shell/latest/classgoogle_1_1cloud_1_1shell__v1_1_1CloudShellServiceClient). All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mock [`shell_v1::CloudShellServiceClient`](https://docs.cloud.google.com/cpp/docs/reference/shell/latest/classgoogle_1_1cloud_1_1shell__v1_1_1CloudShellServiceClient) when testing your application.

### More Information

- [Error Handling](https://docs.cloud.google.com/cpp/docs/reference/common/latest/common-error-handling.html) - describes how the library reports errors.
- [How to Override the Default Endpoint](https://docs.cloud.google.com/cpp/docs/reference/shell/latest/shell-override-endpoint) - describes how to override the default endpoint.
- [How to Override the Authentication Credentials](https://docs.cloud.google.com/cpp/docs/reference/shell/latest/shell-override-authentication) - describes how to change the authentication credentials used by the library.
- [Override Retry, Backoff, and Idempotency Policies](https://docs.cloud.google.com/cpp/docs/reference/shell/latest/shell-override-retry) - describes how to change the default retry policies.
- [Environment Variables](https://docs.cloud.google.com/cpp/docs/reference/shell/latest/shell-env) - describes environment variables that can configure the behavior of the library.
- [How to Override the Default Universe Domain](https://docs.cloud.google.com/cpp/docs/reference/shell/latest/shell-override-universe-domain) - describes how to override the default universe domain.