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 Google Cloud 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 |
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 |
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 |
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 |
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 |
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 |
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 Google Cloud 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 |
CreateManagementServer(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 |
|
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 |
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 |
CreateManagementServer(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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::CreateManagementServerRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateManagementServer(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 |
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 |
DeleteManagementServer(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 |
|
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 |
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 |
DeleteManagementServer(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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::DeleteManagementServerRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteManagementServer(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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::OperationMetadata > > |
CreateBackupVault(std::string const &, google::cloud::backupdr::v1::BackupVault const &, std::string const &, Options)
Creates a new BackupVault in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Value for parent. |
backup_vault |
google::cloud::backupdr::v1::BackupVault const &
Required. The resource being created |
backup_vault_id |
std::string const &
Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupVault > > |
A |
CreateBackupVault(NoAwaitTag, std::string const &, google::cloud::backupdr::v1::BackupVault const &, std::string const &, Options)
Creates a new BackupVault 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 |
|
NoAwaitTag
|
parent |
std::string const &
|
backup_vault |
google::cloud::backupdr::v1::BackupVault const &
|
backup_vault_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateBackupVault(google::cloud::backupdr::v1::CreateBackupVaultRequest const &, Options)
Creates a new BackupVault in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::CreateBackupVaultRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupVault > > |
A |
CreateBackupVault(NoAwaitTag, google::cloud::backupdr::v1::CreateBackupVaultRequest const &, Options)
Creates a new BackupVault 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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::CreateBackupVaultRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateBackupVault(google::longrunning::Operation const &, Options)
Creates a new BackupVault 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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupVault > > |
ListBackupVaults(std::string const &, Options)
Lists BackupVaults in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve backupvault stores 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::BackupVault > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListBackupVaults(google::cloud::backupdr::v1::ListBackupVaultsRequest, Options)
Lists BackupVaults in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::ListBackupVaultsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::backupdr::v1::BackupVault > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
FetchUsableBackupVaults(std::string const &, Options)
FetchUsableBackupVaults lists usable BackupVaults in a given project and location.
Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve backupvault stores 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::BackupVault > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
FetchUsableBackupVaults(google::cloud::backupdr::v1::FetchUsableBackupVaultsRequest, Options)
FetchUsableBackupVaults lists usable BackupVaults in a given project and location.
Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::FetchUsableBackupVaultsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::backupdr::v1::BackupVault > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetBackupVault(std::string const &, Options)
Gets details of a BackupVault.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the backupvault store resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}' |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::backupdr::v1::BackupVault > |
the result of the RPC. The response message type (google.cloud.backupdr.v1.BackupVault) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBackupVault(google::cloud::backupdr::v1::GetBackupVaultRequest const &, Options)
Gets details of a BackupVault.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::GetBackupVaultRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::backupdr::v1::BackupVault > |
the result of the RPC. The response message type (google.cloud.backupdr.v1.BackupVault) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateBackupVault(google::cloud::backupdr::v1::BackupVault const &, google::protobuf::FieldMask const &, Options)
Updates the settings of a BackupVault.
Parameters | |
---|---|
Name | Description |
backup_vault |
google::cloud::backupdr::v1::BackupVault const &
Required. The resource being updated |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the BackupVault resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupVault > > |
A |
UpdateBackupVault(NoAwaitTag, google::cloud::backupdr::v1::BackupVault const &, google::protobuf::FieldMask const &, Options)
Updates the settings of a BackupVault.
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 |
|
NoAwaitTag
|
backup_vault |
google::cloud::backupdr::v1::BackupVault const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateBackupVault(google::cloud::backupdr::v1::UpdateBackupVaultRequest const &, Options)
Updates the settings of a BackupVault.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::UpdateBackupVaultRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupVault > > |
A |
UpdateBackupVault(NoAwaitTag, google::cloud::backupdr::v1::UpdateBackupVaultRequest const &, Options)
Updates the settings of a BackupVault.
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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::UpdateBackupVaultRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateBackupVault(google::longrunning::Operation const &, Options)
Updates the settings of a BackupVault.
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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupVault > > |
DeleteBackupVault(std::string const &, Options)
Deletes a BackupVault.
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 |
DeleteBackupVault(NoAwaitTag, std::string const &, Options)
Deletes a BackupVault.
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 |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteBackupVault(google::cloud::backupdr::v1::DeleteBackupVaultRequest const &, Options)
Deletes a BackupVault.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::DeleteBackupVaultRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
DeleteBackupVault(NoAwaitTag, google::cloud::backupdr::v1::DeleteBackupVaultRequest const &, Options)
Deletes a BackupVault.
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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::DeleteBackupVaultRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteBackupVault(google::longrunning::Operation const &, Options)
Deletes a BackupVault.
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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::OperationMetadata > > |
ListDataSources(std::string const &, Options)
Lists DataSources in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location for which to retrieve data sources information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve data sources 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::DataSource > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDataSources(google::cloud::backupdr::v1::ListDataSourcesRequest, Options)
Lists DataSources in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::ListDataSourcesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::backupdr::v1::DataSource > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetDataSource(std::string const &, Options)
Gets details of a DataSource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}' |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::backupdr::v1::DataSource > |
the result of the RPC. The response message type (google.cloud.backupdr.v1.DataSource) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDataSource(google::cloud::backupdr::v1::GetDataSourceRequest const &, Options)
Gets details of a DataSource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::GetDataSourceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::backupdr::v1::DataSource > |
the result of the RPC. The response message type (google.cloud.backupdr.v1.DataSource) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateDataSource(google::cloud::backupdr::v1::DataSource const &, google::protobuf::FieldMask const &, Options)
Updates the settings of a DataSource.
Parameters | |
---|---|
Name | Description |
data_source |
google::cloud::backupdr::v1::DataSource const &
Required. The resource being updated |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the DataSource resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::DataSource > > |
A |
UpdateDataSource(NoAwaitTag, google::cloud::backupdr::v1::DataSource const &, google::protobuf::FieldMask const &, Options)
Updates the settings of a DataSource.
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 |
|
NoAwaitTag
|
data_source |
google::cloud::backupdr::v1::DataSource const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateDataSource(google::cloud::backupdr::v1::UpdateDataSourceRequest const &, Options)
Updates the settings of a DataSource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::UpdateDataSourceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::DataSource > > |
A |
UpdateDataSource(NoAwaitTag, google::cloud::backupdr::v1::UpdateDataSourceRequest const &, Options)
Updates the settings of a DataSource.
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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::UpdateDataSourceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateDataSource(google::longrunning::Operation const &, Options)
Updates the settings of a DataSource.
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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::DataSource > > |
ListBackups(std::string const &, Options)
Lists Backups in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location for which to retrieve backup information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve data sources 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::Backup > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListBackups(google::cloud::backupdr::v1::ListBackupsRequest, Options)
Lists Backups in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::ListBackupsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::backupdr::v1::Backup > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetBackup(std::string const &, Options)
Gets details of a Backup.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}' |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::backupdr::v1::Backup > |
the result of the RPC. The response message type (google.cloud.backupdr.v1.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBackup(google::cloud::backupdr::v1::GetBackupRequest const &, Options)
Gets details of a Backup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::GetBackupRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::backupdr::v1::Backup > |
the result of the RPC. The response message type (google.cloud.backupdr.v1.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateBackup(google::cloud::backupdr::v1::Backup const &, google::protobuf::FieldMask const &, Options)
Updates the settings of a Backup.
Parameters | |
---|---|
Name | Description |
backup |
google::cloud::backupdr::v1::Backup const &
Required. The resource being updated |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::Backup > > |
A |
UpdateBackup(NoAwaitTag, google::cloud::backupdr::v1::Backup const &, google::protobuf::FieldMask const &, Options)
Updates the settings of a Backup.
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 |
|
NoAwaitTag
|
backup |
google::cloud::backupdr::v1::Backup const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateBackup(google::cloud::backupdr::v1::UpdateBackupRequest const &, Options)
Updates the settings of a Backup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::UpdateBackupRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::Backup > > |
A |
UpdateBackup(NoAwaitTag, google::cloud::backupdr::v1::UpdateBackupRequest const &, Options)
Updates the settings of a Backup.
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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::UpdateBackupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateBackup(google::longrunning::Operation const &, Options)
Updates the settings of a Backup.
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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::Backup > > |
DeleteBackup(std::string const &, Options)
Deletes a Backup.
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::Backup > > |
A |
DeleteBackup(NoAwaitTag, std::string const &, Options)
Deletes a Backup.
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 |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteBackup(google::cloud::backupdr::v1::DeleteBackupRequest const &, Options)
Deletes a Backup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::DeleteBackupRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::Backup > > |
A |
DeleteBackup(NoAwaitTag, google::cloud::backupdr::v1::DeleteBackupRequest const &, Options)
Deletes a Backup.
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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::DeleteBackupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteBackup(google::longrunning::Operation const &, Options)
Deletes a Backup.
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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::Backup > > |
RestoreBackup(std::string const &, Options)
Restore from a Backup.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the Backup instance, in the format 'projects//locations//backupVaults//dataSources//backups/'. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::RestoreBackupResponse > > |
A |
RestoreBackup(NoAwaitTag, std::string const &, Options)
Restore from a Backup.
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 |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RestoreBackup(google::cloud::backupdr::v1::RestoreBackupRequest const &, Options)
Restore from a Backup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::RestoreBackupRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::RestoreBackupResponse > > |
A |
RestoreBackup(NoAwaitTag, google::cloud::backupdr::v1::RestoreBackupRequest const &, Options)
Restore from a Backup.
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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::RestoreBackupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RestoreBackup(google::longrunning::Operation const &, Options)
Restore from a Backup.
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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::RestoreBackupResponse > > |
CreateBackupPlan(std::string const &, google::cloud::backupdr::v1::BackupPlan const &, std::string const &, Options)
Create a BackupPlan.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The |
backup_plan |
google::cloud::backupdr::v1::BackupPlan const &
Required. The |
backup_plan_id |
std::string const &
Required. The name of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupPlan > > |
A |
CreateBackupPlan(NoAwaitTag, std::string const &, google::cloud::backupdr::v1::BackupPlan const &, std::string const &, Options)
Create a BackupPlan.
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 |
|
NoAwaitTag
|
parent |
std::string const &
|
backup_plan |
google::cloud::backupdr::v1::BackupPlan const &
|
backup_plan_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateBackupPlan(google::cloud::backupdr::v1::CreateBackupPlanRequest const &, Options)
Create a BackupPlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::CreateBackupPlanRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupPlan > > |
A |
CreateBackupPlan(NoAwaitTag, google::cloud::backupdr::v1::CreateBackupPlanRequest const &, Options)
Create a BackupPlan.
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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::CreateBackupPlanRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateBackupPlan(google::longrunning::Operation const &, Options)
Create a BackupPlan.
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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupPlan > > |
GetBackupPlan(std::string const &, Options)
Gets details of a single BackupPlan.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::backupdr::v1::BackupPlan > |
the result of the RPC. The response message type (google.cloud.backupdr.v1.BackupPlan) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBackupPlan(google::cloud::backupdr::v1::GetBackupPlanRequest const &, Options)
Gets details of a single BackupPlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::GetBackupPlanRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::backupdr::v1::BackupPlan > |
the result of the RPC. The response message type (google.cloud.backupdr.v1.BackupPlan) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListBackupPlans(std::string const &, Options)
Lists BackupPlans in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location for which to retrieve |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::backupdr::v1::BackupPlan > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListBackupPlans(google::cloud::backupdr::v1::ListBackupPlansRequest, Options)
Lists BackupPlans in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::ListBackupPlansRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::backupdr::v1::BackupPlan > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteBackupPlan(std::string const &, Options)
Deletes a single BackupPlan.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the |
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 |
DeleteBackupPlan(NoAwaitTag, std::string const &, Options)
Deletes a single BackupPlan.
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 |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteBackupPlan(google::cloud::backupdr::v1::DeleteBackupPlanRequest const &, Options)
Deletes a single BackupPlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::DeleteBackupPlanRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
DeleteBackupPlan(NoAwaitTag, google::cloud::backupdr::v1::DeleteBackupPlanRequest const &, Options)
Deletes a single BackupPlan.
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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::DeleteBackupPlanRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteBackupPlan(google::longrunning::Operation const &, Options)
Deletes a single BackupPlan.
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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::OperationMetadata > > |
CreateBackupPlanAssociation(std::string const &, google::cloud::backupdr::v1::BackupPlanAssociation const &, std::string const &, Options)
Create a BackupPlanAssociation.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The backup plan association project and location in the format |
backup_plan_association |
google::cloud::backupdr::v1::BackupPlanAssociation const &
Required. The resource being created |
backup_plan_association_id |
std::string const &
Required. The name of the backup plan association 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::BackupPlanAssociation > > |
A |
CreateBackupPlanAssociation(NoAwaitTag, std::string const &, google::cloud::backupdr::v1::BackupPlanAssociation const &, std::string const &, Options)
Create a BackupPlanAssociation.
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 |
|
NoAwaitTag
|
parent |
std::string const &
|
backup_plan_association |
google::cloud::backupdr::v1::BackupPlanAssociation const &
|
backup_plan_association_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateBackupPlanAssociation(google::cloud::backupdr::v1::CreateBackupPlanAssociationRequest const &, Options)
Create a BackupPlanAssociation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::CreateBackupPlanAssociationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupPlanAssociation > > |
A |
CreateBackupPlanAssociation(NoAwaitTag, google::cloud::backupdr::v1::CreateBackupPlanAssociationRequest const &, Options)
Create a BackupPlanAssociation.
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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::CreateBackupPlanAssociationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateBackupPlanAssociation(google::longrunning::Operation const &, Options)
Create a BackupPlanAssociation.
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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupPlanAssociation > > |
GetBackupPlanAssociation(std::string const &, Options)
Gets details of a single BackupPlanAssociation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the backup plan association resource, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::backupdr::v1::BackupPlanAssociation > |
the result of the RPC. The response message type (google.cloud.backupdr.v1.BackupPlanAssociation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBackupPlanAssociation(google::cloud::backupdr::v1::GetBackupPlanAssociationRequest const &, Options)
Gets details of a single BackupPlanAssociation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::GetBackupPlanAssociationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::backupdr::v1::BackupPlanAssociation > |
the result of the RPC. The response message type (google.cloud.backupdr.v1.BackupPlanAssociation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListBackupPlanAssociations(std::string const &, Options)
Lists BackupPlanAssociations in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location for which to retrieve backup Plan Associations information, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::backupdr::v1::BackupPlanAssociation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListBackupPlanAssociations(google::cloud::backupdr::v1::ListBackupPlanAssociationsRequest, Options)
Lists BackupPlanAssociations in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::ListBackupPlanAssociationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::backupdr::v1::BackupPlanAssociation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteBackupPlanAssociation(std::string const &, Options)
Deletes a single BackupPlanAssociation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the backup plan association resource, in the format |
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 |
DeleteBackupPlanAssociation(NoAwaitTag, std::string const &, Options)
Deletes a single BackupPlanAssociation.
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 |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteBackupPlanAssociation(google::cloud::backupdr::v1::DeleteBackupPlanAssociationRequest const &, Options)
Deletes a single BackupPlanAssociation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::DeleteBackupPlanAssociationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
DeleteBackupPlanAssociation(NoAwaitTag, google::cloud::backupdr::v1::DeleteBackupPlanAssociationRequest const &, Options)
Deletes a single BackupPlanAssociation.
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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::DeleteBackupPlanAssociationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteBackupPlanAssociation(google::longrunning::Operation const &, Options)
Deletes a single BackupPlanAssociation.
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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::OperationMetadata > > |
TriggerBackup(std::string const &, std::string const &, Options)
Triggers a new Backup.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the backup plan association resource, in the format |
rule_id |
std::string const &
Required. backup rule_id for which a backup needs to be triggered. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupPlanAssociation > > |
A |
TriggerBackup(NoAwaitTag, std::string const &, std::string const &, Options)
Triggers a new Backup.
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 |
|
NoAwaitTag
|
name |
std::string const &
|
rule_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
TriggerBackup(google::cloud::backupdr::v1::TriggerBackupRequest const &, Options)
Triggers a new Backup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::backupdr::v1::TriggerBackupRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupPlanAssociation > > |
A |
TriggerBackup(NoAwaitTag, google::cloud::backupdr::v1::TriggerBackupRequest const &, Options)
Triggers a new Backup.
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 |
|
NoAwaitTag
|
request |
google::cloud::backupdr::v1::TriggerBackupRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
TriggerBackup(google::longrunning::Operation const &, Options)
Triggers a new Backup.
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 |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::backupdr::v1::BackupPlanAssociation > > |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::ListLocationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::GetLocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::SetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy set.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::GetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::TestIamPermissionsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::iam::v1::TestIamPermissionsResponse > |
the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::DeleteOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::CancelOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |