Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Lists ManagementServers in a given project and location.
Parameters
Name
Description
parent
std::string const &
Required. The project and location for which to retrieve management servers information, in the format projects/{project_id}/locations/{location}. In Cloud BackupDR, locations map to GCP regions, for example us-central1. To retrieve management servers for all locations, use "-" for the {location} value.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.backupdr.v1.ManagementServer, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.backupdr.v1.ListManagementServersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.backupdr.v1.ManagementServer, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.
GetManagementServer(std::string const &, Options)
Gets details of a single ManagementServer.
Parameters
Name
Description
name
std::string const &
Required. Name of the management server resource name, in the format projects/{project_id}/locations/{location}/managementServers/{resource_name}
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.backupdr.v1.GetManagementServerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Creates a new ManagementServer in a given project and location.
Parameters
Name
Description
parent
std::string const &
Required. The management server project and location in the format projects/{project_id}/locations/{location}. In Cloud Backup and DR locations map to GCP regions, for example us-central1.
A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.backupdr.v1.ManagementServer proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
Creates a new ManagementServer in a given project and location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.backupdr.v1.CreateManagementServerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.backupdr.v1.ManagementServer proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
Creates a new ManagementServer in a given project and location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Creates a new ManagementServer in a given project and location.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.backupdr.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.backupdr.v1.DeleteManagementServerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.backupdr.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThis documentation outlines the \u003ccode\u003eBackupDRClient\u003c/code\u003e class, which interfaces with the BackupDR Service, managing various versions from 2.23.0 up to the latest release candidate 2.37.0-rc.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eBackupDRClient\u003c/code\u003e instances can be efficiently copied and moved, sharing underlying resources, while creating a new instance is more resource-intensive because it establishes new connections to the service.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListManagementServers\u003c/code\u003e function enables retrieval of management server information for a specific project and location, or all locations, with results delivered as a \u003ccode\u003eStreamRange\u003c/code\u003e of \u003ccode\u003eManagementServer\u003c/code\u003e objects.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCreateManagementServer\u003c/code\u003e and \u003ccode\u003eDeleteManagementServer\u003c/code\u003e functions support long-running operations (LROs), allowing for asynchronous management server creation and deletion, and offering options for immediate operation returns or background polling.\u003c/p\u003e\n"],["\u003cp\u003eThe client class uses various parameters such as \u003ccode\u003eOptions\u003c/code\u003e, \u003ccode\u003estd::shared_ptr<BackupDRConnection>\u003c/code\u003e, and \u003ccode\u003estd::string\u003c/code\u003e to perform various functions, and the requests and responses to said functions are defined using the Protobuf mapping rules.\u003c/p\u003e\n"]]],[],null,["# Class BackupDRClient (2.28.0)\n\nVersion 2.28.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/backupdr/latest/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.41.0](/cpp/docs/reference/backupdr/2.41.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.40.0](/cpp/docs/reference/backupdr/2.40.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.39.0](/cpp/docs/reference/backupdr/2.39.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.38.0](/cpp/docs/reference/backupdr/2.38.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.37.0](/cpp/docs/reference/backupdr/2.37.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.36.0](/cpp/docs/reference/backupdr/2.36.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.35.0](/cpp/docs/reference/backupdr/2.35.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.34.0](/cpp/docs/reference/backupdr/2.34.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.33.0](/cpp/docs/reference/backupdr/2.33.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.32.0](/cpp/docs/reference/backupdr/2.32.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.31.0](/cpp/docs/reference/backupdr/2.31.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.30.0](/cpp/docs/reference/backupdr/2.30.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.29.0](/cpp/docs/reference/backupdr/2.29.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.28.0](/cpp/docs/reference/backupdr/2.28.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.27.0](/cpp/docs/reference/backupdr/2.27.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.26.0](/cpp/docs/reference/backupdr/2.26.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.25.1](/cpp/docs/reference/backupdr/2.25.1/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.24.0](/cpp/docs/reference/backupdr/2.24.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient)\n- [2.23.0](/cpp/docs/reference/backupdr/2.23.0/classgoogle_1_1cloud_1_1backupdr__v1_1_1BackupDRClient) \nThe BackupDR Service. \n\n###### Equality\n\nInstances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal `std::shared_ptr\u003c*Connection\u003e` objects compare equal. Objects that compare equal share the same underlying resources.\n\n###### Performance\n\nCreating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.\n\n###### Thread Safety\n\nConcurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.\n\nConstructors\n------------\n\n### BackupDRClient(BackupDRClient const \\&)\n\nCopy and move support\n\n### BackupDRClient(BackupDRClient \\&\\&)\n\nCopy and move support\n\n### BackupDRClient(std::shared_ptr\\\u003c BackupDRConnection \\\u003e, Options)\n\nOperators\n---------\n\n### operator=(BackupDRClient const \\&)\n\nCopy and move support\n\n### operator=(BackupDRClient \\&\\&)\n\nCopy and move support\n\nFunctions\n---------\n\n### ListManagementServers(std::string const \\&, Options)\n\nLists ManagementServers in a given project and location.\n\n### ListManagementServers(google::cloud::backupdr::v1::ListManagementServersRequest, Options)\n\nLists ManagementServers in a given project and location.\n\n### GetManagementServer(std::string const \\&, Options)\n\nGets details of a single ManagementServer.\n\n### GetManagementServer(google::cloud::backupdr::v1::GetManagementServerRequest const \\&, Options)\n\nGets details of a single ManagementServer.\n\n### CreateManagementServer(std::string const \\&, google::cloud::backupdr::v1::ManagementServer const \\&, std::string const \\&, Options)\n\nCreates a new ManagementServer in a given project and location.\n\n### CreateManagementServer(NoAwaitTag, std::string const \\&, google::cloud::backupdr::v1::ManagementServer const \\&, std::string const \\&, Options)\n\nCreates a new ManagementServer in a given project and location. \nSpecifying the [`NoAwaitTag`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1NoAwaitTag.html) immediately returns the \\[`google::longrunning::Operation`\\] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.\n\n### CreateManagementServer(google::cloud::backupdr::v1::CreateManagementServerRequest const \\&, Options)\n\nCreates a new ManagementServer in a given project and location.\n\n### CreateManagementServer(NoAwaitTag, google::cloud::backupdr::v1::CreateManagementServerRequest const \\&, Options)\n\nCreates a new ManagementServer in a given project and location. \nSpecifying the [`NoAwaitTag`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1NoAwaitTag.html) immediately returns the \\[`google::longrunning::Operation`\\] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.\n\n### CreateManagementServer(google::longrunning::Operation const \\&, Options)\n\nCreates a new ManagementServer in a given project and location. \nThis method accepts a `google::longrunning::Operation` that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.\n\n### DeleteManagementServer(std::string const \\&, Options)\n\nDeletes a single ManagementServer.\n\n### DeleteManagementServer(NoAwaitTag, std::string const \\&, Options)\n\nDeletes a single ManagementServer. \nSpecifying the [`NoAwaitTag`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1NoAwaitTag.html) immediately returns the \\[`google::longrunning::Operation`\\] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.\n\n### DeleteManagementServer(google::cloud::backupdr::v1::DeleteManagementServerRequest const \\&, Options)\n\nDeletes a single ManagementServer.\n\n### DeleteManagementServer(NoAwaitTag, google::cloud::backupdr::v1::DeleteManagementServerRequest const \\&, Options)\n\nDeletes a single ManagementServer. \nSpecifying the [`NoAwaitTag`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1NoAwaitTag.html) immediately returns the \\[`google::longrunning::Operation`\\] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.\n\n### DeleteManagementServer(google::longrunning::Operation const \\&, Options)\n\nDeletes a single ManagementServer. \nThis method accepts a `google::longrunning::Operation` that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background."]]
