Class BackupForGKEClient (2.31.0)

Version 2.31.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0

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: projects/*/locations/*
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: be between 1 and 63 characters long (inclusive) consist of only lower-case ASCII letters, numbers, and dashes start with a lower-case letter end with a lower-case letter or number be unique within the set of BackupPlans in this location
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.BackupPlan proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBackupPlan(NoAwaitTag, std::string const &, google::cloud::gkebackup::v1::BackupPlan const &, std::string const &, Options)

Creates a new BackupPlan in a given 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_plan	google::cloud::gkebackup::v1::BackupPlan const &
backup_plan_id	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.CreateBackupPlanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::gkebackup::v1::BackupPlan > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.BackupPlan proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBackupPlan(NoAwaitTag, google::cloud::gkebackup::v1::CreateBackupPlanRequest const &, Options)

Creates a new BackupPlan in a given 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::gkebackup::v1::CreateBackupPlanRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateBackupPlan(google::longrunning::Operation const &, Options)

Creates a new BackupPlan in a given 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::gkebackup::v1::BackupPlan > >

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: projects/*/locations/*
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkebackup.v1.BackupPlan, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.ListBackupPlansRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::gkebackup::v1::BackupPlan >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkebackup.v1.BackupPlan, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: projects/*/locations/*/backupPlans/*
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.GetBackupPlanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::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 StatusOr contains the error details.

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 is provided.
update_mask	google::protobuf::FieldMask const & Optional. 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 backup_plan provided with this request. Field names are relative to the root of the resource (e.g., description, backup_config.include_volume_data, etc.) If no update_mask is provided, all fields in backup_plan will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup_plan are ignored and are not used to update the target BackupPlan.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.BackupPlan proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBackupPlan(NoAwaitTag, google::cloud::gkebackup::v1::BackupPlan const &, google::protobuf::FieldMask const &, Options)

Update 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
backup_plan	google::cloud::gkebackup::v1::BackupPlan const &
update_mask	google::protobuf::FieldMask const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.UpdateBackupPlanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::gkebackup::v1::BackupPlan > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.BackupPlan proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBackupPlan(NoAwaitTag, google::cloud::gkebackup::v1::UpdateBackupPlanRequest const &, Options)

Update 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::gkebackup::v1::UpdateBackupPlanRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

UpdateBackupPlan(google::longrunning::Operation const &, Options)

Update 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::gkebackup::v1::BackupPlan > >

DeleteBackupPlan(std::string const &, Options)

Deletes an existing BackupPlan.

Parameters
Name	Description
name	std::string const & Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteBackupPlan(NoAwaitTag, std::string const &, Options)

Deletes an existing 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::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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.DeleteBackupPlanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::gkebackup::v1::OperationMetadata > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteBackupPlan(NoAwaitTag, google::cloud::gkebackup::v1::DeleteBackupPlanRequest const &, Options)

Deletes an existing 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::gkebackup::v1::DeleteBackupPlanRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteBackupPlan(google::longrunning::Operation const &, Options)

Deletes an existing 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::gkebackup::v1::OperationMetadata > >

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: projects/*/locations/*/backupPlans/*
backup	google::cloud::gkebackup::v1::Backup const & Optional. The Backup resource to create.
backup_id	std::string const & Optional. The client-provided short name for the Backup resource. This name must: be between 1 and 63 characters long (inclusive) consist of only lower-case ASCII letters, numbers, and dashes start with a lower-case letter end with a lower-case letter or number be unique within the set of Backups in this BackupPlan
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBackup(NoAwaitTag, std::string const &, google::cloud::gkebackup::v1::Backup const &, std::string const &, Options)

Creates a Backup for the given 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	google::cloud::gkebackup::v1::Backup const &
backup_id	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.CreateBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::gkebackup::v1::Backup > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBackup(NoAwaitTag, google::cloud::gkebackup::v1::CreateBackupRequest const &, Options)

Creates a Backup for the given 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::gkebackup::v1::CreateBackupRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateBackup(google::longrunning::Operation const &, Options)

Creates a Backup for the given 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::gkebackup::v1::Backup > >

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: projects/*/locations/*/backupPlans/*
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkebackup.v1.Backup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.ListBackupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::gkebackup::v1::Backup >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkebackup.v1.Backup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: projects/*/locations/*/backupPlans/*/backups/*
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.GetBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::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 StatusOr contains the error details.

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 is provided.
update_mask	google::protobuf::FieldMask const & Optional. 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 backup_plan provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in backup will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup are ignored and are not used to update the target Backup.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBackup(NoAwaitTag, google::cloud::gkebackup::v1::Backup const &, google::protobuf::FieldMask const &, Options)

Update 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::gkebackup::v1::Backup const &
update_mask	google::protobuf::FieldMask const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.UpdateBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::gkebackup::v1::Backup > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.Backup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBackup(NoAwaitTag, google::cloud::gkebackup::v1::UpdateBackupRequest const &, Options)

Update 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::gkebackup::v1::UpdateBackupRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

UpdateBackup(google::longrunning::Operation const &, Options)

Update 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::gkebackup::v1::Backup > >

DeleteBackup(std::string const &, Options)

Deletes an existing Backup.

Parameters
Name	Description
name	std::string const & Required. Name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteBackup(NoAwaitTag, std::string const &, Options)

Deletes an existing 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::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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.DeleteBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::gkebackup::v1::OperationMetadata > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteBackup(NoAwaitTag, google::cloud::gkebackup::v1::DeleteBackupRequest const &, Options)

Deletes an existing 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::gkebackup::v1::DeleteBackupRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteBackup(google::longrunning::Operation const &, Options)

Deletes an existing 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::gkebackup::v1::OperationMetadata > >

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: projects/*/locations/*/backupPlans/*/backups/*
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkebackup.v1.VolumeBackup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.ListVolumeBackupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::gkebackup::v1::VolumeBackup >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkebackup.v1.VolumeBackup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.GetVolumeBackupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::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 StatusOr contains the error details.

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: projects/*/locations/*
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: be between 1 and 63 characters long (inclusive) consist of only lower-case ASCII letters, numbers, and dashes start with a lower-case letter end with a lower-case letter or number be unique within the set of RestorePlans in this location
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.RestorePlan proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRestorePlan(NoAwaitTag, std::string const &, google::cloud::gkebackup::v1::RestorePlan const &, std::string const &, Options)

Creates a new RestorePlan in a given 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 &
restore_plan	google::cloud::gkebackup::v1::RestorePlan const &
restore_plan_id	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.CreateRestorePlanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::gkebackup::v1::RestorePlan > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.RestorePlan proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRestorePlan(NoAwaitTag, google::cloud::gkebackup::v1::CreateRestorePlanRequest const &, Options)

Creates a new RestorePlan in a given 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::gkebackup::v1::CreateRestorePlanRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateRestorePlan(google::longrunning::Operation const &, Options)

Creates a new RestorePlan in a given 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::gkebackup::v1::RestorePlan > >

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: projects/*/locations/*
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkebackup.v1.RestorePlan, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.ListRestorePlansRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::gkebackup::v1::RestorePlan >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkebackup.v1.RestorePlan, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: projects/*/locations/*/restorePlans/*
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.GetRestorePlanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::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 StatusOr contains the error details.

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 is provided.
update_mask	google::protobuf::FieldMask const & Optional. 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 restore_plan provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in restore_plan will be written to the target RestorePlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in restore_plan are ignored and are not used to update the target RestorePlan.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.RestorePlan proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateRestorePlan(NoAwaitTag, google::cloud::gkebackup::v1::RestorePlan const &, google::protobuf::FieldMask const &, Options)

Update a RestorePlan.

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
restore_plan	google::cloud::gkebackup::v1::RestorePlan const &
update_mask	google::protobuf::FieldMask const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.UpdateRestorePlanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::gkebackup::v1::RestorePlan > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.RestorePlan proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateRestorePlan(NoAwaitTag, google::cloud::gkebackup::v1::UpdateRestorePlanRequest const &, Options)

Update a RestorePlan.

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::gkebackup::v1::UpdateRestorePlanRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

UpdateRestorePlan(google::longrunning::Operation const &, Options)

Update a RestorePlan.

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::gkebackup::v1::RestorePlan > >

DeleteRestorePlan(std::string const &, Options)

Deletes an existing RestorePlan.

Parameters
Name	Description
name	std::string const & Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRestorePlan(NoAwaitTag, std::string const &, Options)

Deletes an existing RestorePlan.

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 >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.DeleteRestorePlanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::gkebackup::v1::OperationMetadata > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRestorePlan(NoAwaitTag, google::cloud::gkebackup::v1::DeleteRestorePlanRequest const &, Options)

Deletes an existing RestorePlan.

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::gkebackup::v1::DeleteRestorePlanRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteRestorePlan(google::longrunning::Operation const &, Options)

Deletes an existing RestorePlan.

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::gkebackup::v1::OperationMetadata > >

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: projects/*/locations/*/restorePlans/*
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: be between 1 and 63 characters long (inclusive) consist of only lower-case ASCII letters, numbers, and dashes start with a lower-case letter end with a lower-case letter or number be unique within the set of Restores in this RestorePlan.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.Restore proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRestore(NoAwaitTag, std::string const &, google::cloud::gkebackup::v1::Restore const &, std::string const &, Options)

Creates a new Restore for the given RestorePlan.

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 &
restore	google::cloud::gkebackup::v1::Restore const &
restore_id	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.CreateRestoreRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::gkebackup::v1::Restore > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.Restore proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRestore(NoAwaitTag, google::cloud::gkebackup::v1::CreateRestoreRequest const &, Options)

Creates a new Restore for the given RestorePlan.

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::gkebackup::v1::CreateRestoreRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateRestore(google::longrunning::Operation const &, Options)

Creates a new Restore for the given RestorePlan.

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::gkebackup::v1::Restore > >

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: projects/*/locations/*/restorePlans/*
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkebackup.v1.Restore, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.ListRestoresRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::gkebackup::v1::Restore >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkebackup.v1.Restore, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: projects/*/locations/*/restorePlans/*/restores/*
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.GetRestoreRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::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 StatusOr contains the error details.

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 is provided.
update_mask	google::protobuf::FieldMask const & Optional. 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 restore provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in restore will be written to the target Restore resource. Note that OUTPUT_ONLY and IMMUTABLE fields in restore are ignored and are not used to update the target Restore.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.Restore proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateRestore(NoAwaitTag, google::cloud::gkebackup::v1::Restore const &, google::protobuf::FieldMask const &, Options)

Update a Restore.

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
restore	google::cloud::gkebackup::v1::Restore const &
update_mask	google::protobuf::FieldMask const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.UpdateRestoreRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::gkebackup::v1::Restore > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.Restore proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateRestore(NoAwaitTag, google::cloud::gkebackup::v1::UpdateRestoreRequest const &, Options)

Update a Restore.

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::gkebackup::v1::UpdateRestoreRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

UpdateRestore(google::longrunning::Operation const &, Options)

Update a Restore.

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::gkebackup::v1::Restore > >

DeleteRestore(std::string const &, Options)

Deletes an existing Restore.

Parameters
Name	Description
name	std::string const & Required. Full name of the Restore Format: projects/*/locations/*/restorePlans/*/restores/*
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRestore(NoAwaitTag, std::string const &, Options)

Deletes an existing Restore.

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 >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.DeleteRestoreRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::gkebackup::v1::OperationMetadata > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkebackup.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRestore(NoAwaitTag, google::cloud::gkebackup::v1::DeleteRestoreRequest const &, Options)

Deletes an existing Restore.

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::gkebackup::v1::DeleteRestoreRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteRestore(google::longrunning::Operation const &, Options)

Deletes an existing Restore.

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::gkebackup::v1::OperationMetadata > >

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: projects/*/locations/*/restorePlans/*/restores/*
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkebackup.v1.VolumeRestore, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.ListVolumeRestoresRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::gkebackup::v1::VolumeRestore >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkebackup.v1.VolumeRestore, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.GetVolumeRestoreRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::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 StatusOr contains the error details.

GetBackupIndexDownloadUrl(std::string const &, Options)

Retrieve the link to the backupIndex.

Parameters
Name	Description
backup	std::string const & Required. Full name of Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::gkebackup::v1::GetBackupIndexDownloadUrlResponse >	the result of the RPC. The response message type (google.cloud.gkebackup.v1.GetBackupIndexDownloadUrlResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetBackupIndexDownloadUrl(google::cloud::gkebackup::v1::GetBackupIndexDownloadUrlRequest const &, Options)

Retrieve the link to the backupIndex.

Parameters
Name	Description
request	google::cloud::gkebackup::v1::GetBackupIndexDownloadUrlRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkebackup.v1.GetBackupIndexDownloadUrlRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::gkebackup::v1::GetBackupIndexDownloadUrlResponse >	the result of the RPC. The response message type (google.cloud.gkebackup.v1.GetBackupIndexDownloadUrlResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.ListLocationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::location::Location >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.location.Location, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.GetLocationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::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 StatusOr contains the error details.

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.

NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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.

NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters
Name	Description
request	google::longrunning::ListOperationsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.ListOperationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::longrunning::Operation >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.GetOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::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 StatusOr contains the error details.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.DeleteOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.CancelOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.