An idiomatic C++ client library for theVM Migration API, a service to programmatically migrate workloads to Google Compute Engine.
While this library isGA, please note Google Cloud C++ client libraries donotfollowSemantic Versioning.
Quickstart
The following shows the code that you'll run in thegoogle/cloud/vmmigration/quickstart/directory, which should give you a taste of the VM Migration API C++ client library API.
The main class in this library isvmmigration_v1::VmMigrationClient. All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mockvmmigration_v1::VmMigrationClientwhen testing your application.
Retry, Backoff, and Idempotency Policies.
The library automatically retries requests that fail with transient errors, and usesexponential backoffto backoff between retries. Application developers can override the default policies.
More Information
Error Handling- describes how the library reports errors.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the VM Migration API C++ Client Library, which is used to programmatically migrate workloads to Google Compute Engine.\u003c/p\u003e\n"],["\u003cp\u003eThe library is generally available (GA) but does not adhere to Semantic Versioning, and version 2.37.0-rc is the latest release candidate, while 2.12.0 is the current version being detailed on this specific page.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003evmmigration_v1::VmMigrationClient\u003c/code\u003e class is the main class in the library, and all Remote Procedure Calls (RPCs) are exposed as member functions of this class.\u003c/p\u003e\n"],["\u003cp\u003eThe library automatically handles retries for requests that encounter transient errors and uses exponential backoff for retries.\u003c/p\u003e\n"],["\u003cp\u003eThe page provides links to further information, including how to handle errors, override default endpoints and authentication credentials, and configure library behavior with environment variables.\u003c/p\u003e\n"]]],[],null,["Version 2.12.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/vmmigration/latest)\n- [2.41.0](/cpp/docs/reference/vmmigration/2.41.0)\n- [2.40.0](/cpp/docs/reference/vmmigration/2.40.0)\n- [2.39.0](/cpp/docs/reference/vmmigration/2.39.0)\n- [2.38.0](/cpp/docs/reference/vmmigration/2.38.0)\n- [2.37.0](/cpp/docs/reference/vmmigration/2.37.0)\n- [2.36.0](/cpp/docs/reference/vmmigration/2.36.0)\n- [2.35.0](/cpp/docs/reference/vmmigration/2.35.0)\n- [2.34.0](/cpp/docs/reference/vmmigration/2.34.0)\n- [2.33.0](/cpp/docs/reference/vmmigration/2.33.0)\n- [2.32.0](/cpp/docs/reference/vmmigration/2.32.0)\n- [2.31.0](/cpp/docs/reference/vmmigration/2.31.0)\n- [2.30.0](/cpp/docs/reference/vmmigration/2.30.0)\n- [2.29.0](/cpp/docs/reference/vmmigration/2.29.0)\n- [2.28.0](/cpp/docs/reference/vmmigration/2.28.0)\n- [2.27.0](/cpp/docs/reference/vmmigration/2.27.0)\n- [2.26.0](/cpp/docs/reference/vmmigration/2.26.0)\n- [2.25.1](/cpp/docs/reference/vmmigration/2.25.1)\n- [2.24.0](/cpp/docs/reference/vmmigration/2.24.0)\n- [2.23.0](/cpp/docs/reference/vmmigration/2.23.0)\n- [2.22.1](/cpp/docs/reference/vmmigration/2.22.1)\n- [2.21.0](/cpp/docs/reference/vmmigration/2.21.0)\n- [2.20.0](/cpp/docs/reference/vmmigration/2.20.0)\n- [2.19.0](/cpp/docs/reference/vmmigration/2.19.0)\n- [2.18.0](/cpp/docs/reference/vmmigration/2.18.0)\n- [2.17.0](/cpp/docs/reference/vmmigration/2.17.0)\n- [2.16.0](/cpp/docs/reference/vmmigration/2.16.0)\n- [2.15.1](/cpp/docs/reference/vmmigration/2.15.1)\n- [2.14.0](/cpp/docs/reference/vmmigration/2.14.0)\n- [2.13.0](/cpp/docs/reference/vmmigration/2.13.0)\n- [2.12.0](/cpp/docs/reference/vmmigration/2.12.0)\n- [2.11.0](/cpp/docs/reference/vmmigration/2.11.0) \n\nVM Migration API C++ Client Library\n===================================\n\nAn idiomatic C++ client library for the [VM Migration API](https://cloud.google.com/migrate/compute-engine), a service to programmatically migrate workloads to Google Compute Engine.\n\nWhile this library is **GA** , please note Google Cloud C++ client libraries do **not** follow [Semantic Versioning](https://semver.org/).\n\n### Quickstart\n\nThe following shows the code that you'll run in the `google/cloud/vmmigration/quickstart/` directory, which should give you a taste of the VM Migration API C++ client library API. \n\n #include \"google/cloud/vmmigration/v1/vm_migration_client.h\"\n #include \u003ciostream\u003e\n\n int main(int argc, char* argv[]) try {\n if (argc != 2) {\n std::cerr \u003c\u003c \"Usage: \" \u003c\u003c argv[0] \u003c\u003c \" project-id\\n\";\n return 1;\n }\n\n namespace vmmigration = ::google::cloud::vmmigration_v1;\n auto client =\n vmmigration::VmMigrationClient(vmmigration::MakeVmMigrationConnection());\n\n auto const parent = std::string{\"projects/\"} + argv[1] + \"/locations/-\";\n for (auto s : client.ListSources(parent)) {\n if (!s) throw std::move(s).status();\n std::cout \u003c\u003c s-\u003eDebugString() \u003c\u003c \"\\n\";\n }\n\n return 0;\n } catch (google::cloud::Status const& status) {\n std::cerr \u003c\u003c \"google::cloud::Status thrown: \" \u003c\u003c status \u003c\u003c \"\\n\";\n return 1;\n }\n\n### Main classes\n\nThe main class in this library is [`vmmigration_v1::VmMigrationClient`](/cpp/docs/reference/vmmigration/2.12.0/classgoogle_1_1cloud_1_1vmmigration__v1_1_1VmMigrationClient). All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mock [`vmmigration_v1::VmMigrationClient`](/cpp/docs/reference/vmmigration/2.12.0/classgoogle_1_1cloud_1_1vmmigration__v1_1_1VmMigrationClient) when testing your application.\n\n### Retry, Backoff, and Idempotency Policies.\n\nThe library automatically retries requests that fail with transient errors, and uses [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) to backoff between retries. Application developers can override the default policies.\n\n### More Information\n\n- [Error Handling](https://cloud.google.com/cpp/docs/reference/common/latest/common-error-handling.html) - describes how the library reports errors.\n- [How to Override the Default Endpoint](/cpp/docs/reference/vmmigration/2.12.0/vmmigration-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/vmmigration/2.12.0/vmmigration-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Environment Variables](/cpp/docs/reference/vmmigration/2.12.0/vmmigration-env) - describes environment variables that can configure the behavior of the library."]]