BackupForGKE allows Kubernetes administrators to configure, execute, and manage backup and restore operations for their GKE clusters.
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
BackupForGKEClient(BackupForGKEClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
BackupForGKEClient const &
|
BackupForGKEClient(BackupForGKEClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
BackupForGKEClient &&
|
BackupForGKEClient(std::shared_ptr< BackupForGKEConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< BackupForGKEConnection >
|
opts |
Options
|
Operators
operator=(BackupForGKEClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
BackupForGKEClient const &
|
Returns | |
---|---|
Type | Description |
BackupForGKEClient & |
operator=(BackupForGKEClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
BackupForGKEClient &&
|
Returns | |
---|---|
Type | Description |
BackupForGKEClient & |
Functions
CreateBackupPlan(std::string const &, google::cloud::gkebackup::v1::BackupPlan const &, std::string const &, Options)
Creates a new BackupPlan in a given location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The location within which to create the BackupPlan. Format: |
backup_plan |
google::cloud::gkebackup::v1::BackupPlan const &
Required. The BackupPlan resource object to create. |
backup_plan_id |
std::string const &
Required. The client-provided short name for the BackupPlan resource. This name must:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkebackup::v1::BackupPlan > > | A |
CreateBackupPlan(google::cloud::gkebackup::v1::CreateBackupPlanRequest const &, Options)
Creates a new BackupPlan in a given location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::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::gkebackup::v1::BackupPlan > > | A |
ListBackupPlans(std::string const &, Options)
Lists BackupPlans in a given location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The location that contains the BackupPlans to list. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkebackup::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::gkebackup::v1::ListBackupPlansRequest, Options)
Lists BackupPlans in a given location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::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::gkebackup::v1::BackupPlan > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetBackupPlan(std::string const &, Options)
Retrieve the details of a single BackupPlan.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified BackupPlan name. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkebackup::v1::BackupPlan > | the result of the RPC. The response message type (google.cloud.gkebackup.v1.BackupPlan) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBackupPlan(google::cloud::gkebackup::v1::GetBackupPlanRequest const &, Options)
Retrieve the details of a single BackupPlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::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::gkebackup::v1::BackupPlan > | the result of the RPC. The response message type (google.cloud.gkebackup.v1.BackupPlan) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateBackupPlan(google::cloud::gkebackup::v1::BackupPlan const &, google::protobuf::FieldMask const &, Options)
Update a BackupPlan.
Parameters | |
---|---|
Name | Description |
backup_plan |
google::cloud::gkebackup::v1::BackupPlan const &
Required. A new version of the BackupPlan resource that contains updated fields. This may be sparsely populated if an |
update_mask |
google::protobuf::FieldMask const &
This is used to specify the fields to be overwritten in the BackupPlan targeted for update. The values for each of these updated fields will be taken from the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkebackup::v1::BackupPlan > > | A |
UpdateBackupPlan(google::cloud::gkebackup::v1::UpdateBackupPlanRequest const &, Options)
Update a BackupPlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::UpdateBackupPlanRequest 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::gkebackup::v1::BackupPlan > > | A |
DeleteBackupPlan(std::string const &, Options)
Deletes an existing BackupPlan.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified BackupPlan name. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkebackup::v1::OperationMetadata > > | A |
DeleteBackupPlan(google::cloud::gkebackup::v1::DeleteBackupPlanRequest const &, Options)
Deletes an existing BackupPlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::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::gkebackup::v1::OperationMetadata > > | A |
CreateBackup(std::string const &, google::cloud::gkebackup::v1::Backup const &, std::string const &, Options)
Creates a Backup for the given BackupPlan.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The BackupPlan within which to create the Backup. Format: |
backup |
google::cloud::gkebackup::v1::Backup const &
The Backup resource to create. |
backup_id |
std::string const &
The client-provided short name for the Backup resource. This name must:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkebackup::v1::Backup > > | A |
CreateBackup(google::cloud::gkebackup::v1::CreateBackupRequest const &, Options)
Creates a Backup for the given BackupPlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::CreateBackupRequest 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::gkebackup::v1::Backup > > | A |
ListBackups(std::string const &, Options)
Lists the Backups for a given BackupPlan.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The BackupPlan that contains the Backups to list. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkebackup::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::gkebackup::v1::ListBackupsRequest, Options)
Lists the Backups for a given BackupPlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::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::gkebackup::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)
Retrieve the details of a single Backup.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Full name of the Backup resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkebackup::v1::Backup > | the result of the RPC. The response message type (google.cloud.gkebackup.v1.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBackup(google::cloud::gkebackup::v1::GetBackupRequest const &, Options)
Retrieve the details of a single Backup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::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::gkebackup::v1::Backup > | the result of the RPC. The response message type (google.cloud.gkebackup.v1.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateBackup(google::cloud::gkebackup::v1::Backup const &, google::protobuf::FieldMask const &, Options)
Update a Backup.
Parameters | |
---|---|
Name | Description |
backup |
google::cloud::gkebackup::v1::Backup const &
Required. A new version of the Backup resource that contains updated fields. This may be sparsely populated if an |
update_mask |
google::protobuf::FieldMask const &
This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkebackup::v1::Backup > > | A |
UpdateBackup(google::cloud::gkebackup::v1::UpdateBackupRequest const &, Options)
Update a Backup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::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::gkebackup::v1::Backup > > | A |
DeleteBackup(std::string const &, Options)
Deletes an existing Backup.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the Backup resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkebackup::v1::OperationMetadata > > | A |
DeleteBackup(google::cloud::gkebackup::v1::DeleteBackupRequest const &, Options)
Deletes an existing Backup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::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::gkebackup::v1::OperationMetadata > > | A |
ListVolumeBackups(std::string const &, Options)
Lists the VolumeBackups for a given Backup.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The Backup that contains the VolumeBackups to list. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkebackup::v1::VolumeBackup > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListVolumeBackups(google::cloud::gkebackup::v1::ListVolumeBackupsRequest, Options)
Lists the VolumeBackups for a given Backup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::ListVolumeBackupsRequest
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::gkebackup::v1::VolumeBackup > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetVolumeBackup(std::string const &, Options)
Retrieve the details of a single VolumeBackup.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Full name of the VolumeBackup resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkebackup::v1::VolumeBackup > | the result of the RPC. The response message type (google.cloud.gkebackup.v1.VolumeBackup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetVolumeBackup(google::cloud::gkebackup::v1::GetVolumeBackupRequest const &, Options)
Retrieve the details of a single VolumeBackup.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::GetVolumeBackupRequest 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::gkebackup::v1::VolumeBackup > | the result of the RPC. The response message type (google.cloud.gkebackup.v1.VolumeBackup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateRestorePlan(std::string const &, google::cloud::gkebackup::v1::RestorePlan const &, std::string const &, Options)
Creates a new RestorePlan in a given location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The location within which to create the RestorePlan. Format: |
restore_plan |
google::cloud::gkebackup::v1::RestorePlan const &
Required. The RestorePlan resource object to create. |
restore_plan_id |
std::string const &
Required. The client-provided short name for the RestorePlan resource. This name must:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkebackup::v1::RestorePlan > > | A |
CreateRestorePlan(google::cloud::gkebackup::v1::CreateRestorePlanRequest const &, Options)
Creates a new RestorePlan in a given location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::CreateRestorePlanRequest 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::gkebackup::v1::RestorePlan > > | A |
ListRestorePlans(std::string const &, Options)
Lists RestorePlans in a given location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The location that contains the RestorePlans to list. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkebackup::v1::RestorePlan > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListRestorePlans(google::cloud::gkebackup::v1::ListRestorePlansRequest, Options)
Lists RestorePlans in a given location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::ListRestorePlansRequest
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::gkebackup::v1::RestorePlan > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetRestorePlan(std::string const &, Options)
Retrieve the details of a single RestorePlan.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified RestorePlan name. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkebackup::v1::RestorePlan > | the result of the RPC. The response message type (google.cloud.gkebackup.v1.RestorePlan) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetRestorePlan(google::cloud::gkebackup::v1::GetRestorePlanRequest const &, Options)
Retrieve the details of a single RestorePlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::GetRestorePlanRequest 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::gkebackup::v1::RestorePlan > | the result of the RPC. The response message type (google.cloud.gkebackup.v1.RestorePlan) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateRestorePlan(google::cloud::gkebackup::v1::RestorePlan const &, google::protobuf::FieldMask const &, Options)
Update a RestorePlan.
Parameters | |
---|---|
Name | Description |
restore_plan |
google::cloud::gkebackup::v1::RestorePlan const &
Required. A new version of the RestorePlan resource that contains updated fields. This may be sparsely populated if an |
update_mask |
google::protobuf::FieldMask const &
This is used to specify the fields to be overwritten in the RestorePlan targeted for update. The values for each of these updated fields will be taken from the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkebackup::v1::RestorePlan > > | A |
UpdateRestorePlan(google::cloud::gkebackup::v1::UpdateRestorePlanRequest const &, Options)
Update a RestorePlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::UpdateRestorePlanRequest 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::gkebackup::v1::RestorePlan > > | A |
DeleteRestorePlan(std::string const &, Options)
Deletes an existing RestorePlan.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified RestorePlan name. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkebackup::v1::OperationMetadata > > | A |
DeleteRestorePlan(google::cloud::gkebackup::v1::DeleteRestorePlanRequest const &, Options)
Deletes an existing RestorePlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::DeleteRestorePlanRequest 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::gkebackup::v1::OperationMetadata > > | A |
CreateRestore(std::string const &, google::cloud::gkebackup::v1::Restore const &, std::string const &, Options)
Creates a new Restore for the given RestorePlan.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The RestorePlan within which to create the Restore. Format: |
restore |
google::cloud::gkebackup::v1::Restore const &
Required. The restore resource to create. |
restore_id |
std::string const &
Required. The client-provided short name for the Restore resource. This name must:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkebackup::v1::Restore > > | A |
CreateRestore(google::cloud::gkebackup::v1::CreateRestoreRequest const &, Options)
Creates a new Restore for the given RestorePlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::CreateRestoreRequest 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::gkebackup::v1::Restore > > | A |
ListRestores(std::string const &, Options)
Lists the Restores for a given RestorePlan.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The RestorePlan that contains the Restores to list. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkebackup::v1::Restore > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListRestores(google::cloud::gkebackup::v1::ListRestoresRequest, Options)
Lists the Restores for a given RestorePlan.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::ListRestoresRequest
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::gkebackup::v1::Restore > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetRestore(std::string const &, Options)
Retrieves the details of a single Restore.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the restore resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkebackup::v1::Restore > | the result of the RPC. The response message type (google.cloud.gkebackup.v1.Restore) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetRestore(google::cloud::gkebackup::v1::GetRestoreRequest const &, Options)
Retrieves the details of a single Restore.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::GetRestoreRequest 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::gkebackup::v1::Restore > | the result of the RPC. The response message type (google.cloud.gkebackup.v1.Restore) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateRestore(google::cloud::gkebackup::v1::Restore const &, google::protobuf::FieldMask const &, Options)
Update a Restore.
Parameters | |
---|---|
Name | Description |
restore |
google::cloud::gkebackup::v1::Restore const &
Required. A new version of the Restore resource that contains updated fields. This may be sparsely populated if an |
update_mask |
google::protobuf::FieldMask const &
This is used to specify the fields to be overwritten in the Restore targeted for update. The values for each of these updated fields will be taken from the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkebackup::v1::Restore > > | A |
UpdateRestore(google::cloud::gkebackup::v1::UpdateRestoreRequest const &, Options)
Update a Restore.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::UpdateRestoreRequest 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::gkebackup::v1::Restore > > | A |
DeleteRestore(std::string const &, Options)
Deletes an existing Restore.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Full name of the Restore Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::gkebackup::v1::OperationMetadata > > | A |
DeleteRestore(google::cloud::gkebackup::v1::DeleteRestoreRequest const &, Options)
Deletes an existing Restore.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::DeleteRestoreRequest 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::gkebackup::v1::OperationMetadata > > | A |
ListVolumeRestores(std::string const &, Options)
Lists the VolumeRestores for a given Restore.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The Restore that contains the VolumeRestores to list. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::gkebackup::v1::VolumeRestore > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListVolumeRestores(google::cloud::gkebackup::v1::ListVolumeRestoresRequest, Options)
Lists the VolumeRestores for a given Restore.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::ListVolumeRestoresRequest
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::gkebackup::v1::VolumeRestore > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetVolumeRestore(std::string const &, Options)
Retrieve the details of a single VolumeRestore.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Full name of the VolumeRestore resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::gkebackup::v1::VolumeRestore > | the result of the RPC. The response message type (google.cloud.gkebackup.v1.VolumeRestore) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetVolumeRestore(google::cloud::gkebackup::v1::GetVolumeRestoreRequest const &, Options)
Retrieve the details of a single VolumeRestore.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::gkebackup::v1::GetVolumeRestoreRequest 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::gkebackup::v1::VolumeRestore > | the result of the RPC. The response message type (google.cloud.gkebackup.v1.VolumeRestore) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |