Class BackupDRClient (2.26.0)

The BackupDR Service.

Equality

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.

Constructors

BackupDRClient(BackupDRClient const &)

Copy and move support

Parameter
Name Description
BackupDRClient const &

BackupDRClient(BackupDRClient &&)

Copy and move support

Parameter
Name Description
BackupDRClient &&

BackupDRClient(std::shared_ptr< BackupDRConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< BackupDRConnection >
opts Options

Operators

operator=(BackupDRClient const &)

Copy and move support

Parameter
Name Description
BackupDRClient const &
Returns
Type Description
BackupDRClient &

operator=(BackupDRClient &&)

Copy and move support

Parameter
Name Description
BackupDRClient &&
Returns
Type Description
BackupDRClient &

Functions

ListManagementServers(std::string const &, Options)

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.

Returns
Type Description
StreamRange< google::cloud::backupdr::v1::ManagementServer >

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.

ListManagementServers(google::cloud::backupdr::v1::ListManagementServersRequest, Options)

Lists ManagementServers in a given project and location.

Parameters
Name Description
request google::cloud::backupdr::v1::ListManagementServersRequest

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.

Returns
Type Description
StreamRange< google::cloud::backupdr::v1::ManagementServer >

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.

Returns
Type Description
StatusOr< google::cloud::backupdr::v1::ManagementServer >

the result of the RPC. The response message type (google.cloud.backupdr.v1.ManagementServer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetManagementServer(google::cloud::backupdr::v1::GetManagementServerRequest const &, Options)

Gets details of a single ManagementServer.

Parameters
Name Description
request google::cloud::backupdr::v1::GetManagementServerRequest const &

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.

Returns
Type Description
StatusOr< google::cloud::backupdr::v1::ManagementServer >

the result of the RPC. The response message type (google.cloud.backupdr.v1.ManagementServer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateManagementServer(std::string const &, google::cloud::backupdr::v1::ManagementServer const &, std::string const &, Options)

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.

management_server google::cloud::backupdr::v1::ManagementServer const &

Required. A management server resource
management_server_id std::string const &

Required. The name of the management server to create. The name must be unique for the specified project and location.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::backupdr::v1::ManagementServer > >

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.

CreateManagementServer(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::backupdr::v1::ManagementServer const &, std::string const &, Options)

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.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
parent std::string const &
management_server google::cloud::backupdr::v1::ManagementServer const &
management_server_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateManagementServer(google::cloud::backupdr::v1::CreateManagementServerRequest const &, Options)

Creates a new ManagementServer in a given project and location.

Parameters
Name Description
request google::cloud::backupdr::v1::CreateManagementServerRequest const &

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.

Returns
Type Description
future< StatusOr< google::cloud::backupdr::v1::ManagementServer > >

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.

CreateManagementServer(ExperimentalTag, NoAwaitTag, google::cloud::backupdr::v1::CreateManagementServerRequest const &, Options)

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.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
request google::cloud::backupdr::v1::CreateManagementServerRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateManagementServer(ExperimentalTag, google::longrunning::Operation const &, Options)

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.

Parameters
Name Description
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::backupdr::v1::ManagementServer > >

DeleteManagementServer(std::string const &, Options)

Deletes a single ManagementServer.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::backupdr::v1::OperationMetadata > >

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.

DeleteManagementServer(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Deletes a single ManagementServer.

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.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteManagementServer(google::cloud::backupdr::v1::DeleteManagementServerRequest const &, Options)

Deletes a single ManagementServer.

Parameters
Name Description
request google::cloud::backupdr::v1::DeleteManagementServerRequest const &

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.

Returns
Type Description
future< StatusOr< google::cloud::backupdr::v1::OperationMetadata > >

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.

DeleteManagementServer(ExperimentalTag, NoAwaitTag, google::cloud::backupdr::v1::DeleteManagementServerRequest const &, Options)

Deletes a single ManagementServer.

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.

Parameters
Name Description
ExperimentalTag
NoAwaitTag
request google::cloud::backupdr::v1::DeleteManagementServerRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteManagementServer(ExperimentalTag, google::longrunning::Operation const &, Options)

Deletes a single ManagementServer.

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.

Parameters
Name Description
ExperimentalTag
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::backupdr::v1::OperationMetadata > >