Skip to content

README.md

Latest commit

 

History

History
94 lines (72 loc) · 3.4 KB

README.md

File metadata and controls

94 lines (72 loc) · 3.4 KB

BeyondCorp API C++ Client Library

🚧

This directory contains an idiomatic C++ client library for the BeyondCorp API which provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the BeyondCorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity using the App Connector hybrid connectivity solution.

This library is experimental. Its APIs are subject to change without notice.

Please note that the Google Cloud C++ client libraries do not follow Semantic Versioning.

Supported Platforms

  • Windows, macOS, Linux
  • C++14 (and higher) compilers (we test with GCC >= 7.3, Clang >= 6.0, and MSVC >= 2017)
  • Environments with or without exceptions
  • Bazel (>= 4.0) and CMake (>= 3.5) builds

Documentation

Quickstart

The quickstart/ directory contains a minimal environment to get started using this client library in a larger project. The following "Hello World" program is used in this quickstart, and should give you a taste of this library.

#include "google/cloud/beyondcorp/app_connectors_client.h"
#include <iostream>
#include <stdexcept>

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

  namespace beyondcorp = ::google::cloud::beyondcorp;
  auto client = beyondcorp::AppConnectorsServiceClient(
      beyondcorp::MakeAppConnectorsServiceConnection());

  auto const parent =
      std::string{"projects/"} + argv[1] + "/locations/" + argv[2];
  for (auto r : client.ListAppConnectors(parent)) {
    if (!r) throw std::runtime_error(r.status().message());
    std::cout << r->DebugString() << "\n";
  }

  return 0;
} catch (std::exception const& ex) {
  std::cerr << "Standard exception raised: " << ex.what() << "\n";
  return 1;
}
  • 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 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 of the examples or tests should read the current document.
  • Contributors and developers to google-cloud-cpp should consult the guide to setup a development workstation.

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.