# Cloud Optimization 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 This directory contains an idiomatic C++ client library for the [Cloud Optimization API](https://cloud.google.com/optimization), a service that provides a portfolio of solvers to address common optimization use cases.

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/optimization/quickstart/` directory, which should give you a taste of the Cloud Optimization API C++ client library API.

    #include "google/cloud/optimization/v1/fleet_routing_client.h"
    #include "google/cloud/common_options.h"
    #include "google/cloud/project.h"
    #include <iostream>

    int main(int argc, char* argv[]) try {
      if (argc != 3) {
        std::cerr << "Usage: " << argv[0] << " project-id destination\n"
                  << "  destination is a GCS bucket\n";
        return 1;
      }
      // This quickstart loads an example model from a known GCS bucket. The service
      // solves the model, and writes the solution to the destination GCS bucket.
      std::string const source =
          "gs://cloud-samples-data/optimization-ai/async_request_model.json";
      auto const destination =
          std::string{"gs://"} + argv[2] + "/optimization_quickstart_solution.json";

      namespace gc = ::google::cloud;
      namespace optimization = ::google::cloud::optimization_v1;

      auto options = gc::Options{}.set<gc::UserProjectOption>(argv[1]);
      auto client = optimization::FleetRoutingClient(
          optimization::MakeFleetRoutingConnection(options));

      google::cloud::optimization::v1::BatchOptimizeToursRequest req;
      req.set_parent(gc::Project(argv[1]).FullName());
      auto& config = *req.add_model_configs();
      auto& input = *config.mutable_input_config();
      input.mutable_gcs_source()->set_uri(source);
      input.set_data_format(google::cloud::optimization::v1::JSON);
      auto& output = *config.mutable_output_config();
      output.mutable_gcs_destination()->set_uri(destination);
      output.set_data_format(google::cloud::optimization::v1::JSON);

      auto fut = client.BatchOptimizeTours(req);
      std::cout << "Request sent to the service...\n";
      auto resp = fut.get();
      if (!resp) throw std::move(resp).status();
      std::cout << "Solution written to: " << destination << "\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 [`optimization_v1::FleetRoutingClient`](https://docs.cloud.google.com/cpp/docs/reference/optimization/latest/classgoogle_1_1cloud_1_1optimization__v1_1_1FleetRoutingClient). All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mock [`optimization_v1::FleetRoutingClient`](https://docs.cloud.google.com/cpp/docs/reference/optimization/latest/classgoogle_1_1cloud_1_1optimization__v1_1_1FleetRoutingClient) 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/optimization/latest/optimization-override-endpoint) - describes how to override the default endpoint.
- [How to Override the Authentication Credentials](https://docs.cloud.google.com/cpp/docs/reference/optimization/latest/optimization-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/optimization/latest/optimization-override-retry) - describes how to change the default retry policies.
- [Environment Variables](https://docs.cloud.google.com/cpp/docs/reference/optimization/latest/optimization-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/optimization/latest/optimization-override-universe-domain) - describes how to override the default universe domain.