Class SqlBackupsServiceClient (3.8.0-rc)

3.8.0-rc 3.7.0 (latest) 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 2.48.0-rc 2.47.1 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 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.1 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 2.11.0

SqlBackupsServiceClient.

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

SqlBackupsServiceClient(SqlBackupsServiceClient const &)

Copy and move support

Parameter
Name	Description
	SqlBackupsServiceClient const &

SqlBackupsServiceClient(SqlBackupsServiceClient &&)

Copy and move support

Parameter
Name	Description
	SqlBackupsServiceClient &&

SqlBackupsServiceClient(std::shared_ptr< SqlBackupsServiceConnection >, Options)

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

Operators

operator=(SqlBackupsServiceClient const &)

Copy and move support

Parameter
Name	Description
	SqlBackupsServiceClient const &

Returns
Type	Description
SqlBackupsServiceClient &

operator=(SqlBackupsServiceClient &&)

Copy and move support

Parameter
Name	Description
	SqlBackupsServiceClient &&

Returns
Type	Description
SqlBackupsServiceClient &

Functions

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

Creates a backup for a Cloud SQL instance.

This API can be used only to create on-demand backups.

Parameters
Name	Description
parent	std::string const & Required. The parent resource where this backup is created. Format: projects/{project}
backup	google::cloud::sql::v1::Backup const & Required. The Backup to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

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

Creates a backup for a Cloud SQL instance.

This API can be used only to create on-demand backups.

Parameters
Name	Description
request	google::cloud::sql::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.sql.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
StatusOr< google::cloud::sql::v1::Operation >	the result of the RPC. The response message type (google.cloud.sql.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetBackup(std::string const &, Options)

Retrieves a resource containing information about a backup.

Parameters
Name	Description
name	std::string const & Required. The name of the backup to retrieve. Format: projects/{project}/backups/{backup}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::sql::v1::Backup >	the result of the RPC. The response message type (google.cloud.sql.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::sql::v1::GetBackupRequest const &, Options)

Retrieves a resource containing information about a backup.

Parameters
Name	Description
request	google::cloud::sql::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.sql.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::sql::v1::Backup >	the result of the RPC. The response message type (google.cloud.sql.v1.Backup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListBackups(std::string const &, Options)

Lists all backups associated with the project.

Parameters
Name	Description
parent	std::string const & Required. The parent that owns this collection of backups. Format: projects/{project}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::sql::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.sql.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::sql::v1::ListBackupsRequest, Options)

Lists all backups associated with the project.

Parameters
Name	Description
request	google::cloud::sql::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.sql.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::sql::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.sql.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.

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

Updates the retention period and description of the backup.

You can use this API to update final backups only.

Parameters
Name	Description
backup	google::cloud::sql::v1::Backup const & Required. The backup to update. The backup’s name field is used to identify the backup to update. Format: projects/{project}/backups/{backup}
update_mask	google::protobuf::FieldMask const & The list of fields that you can update. You can update only the description and retention period of the final backup.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

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

Updates the retention period and description of the backup.

You can use this API to update final backups only.

Parameters
Name	Description
request	google::cloud::sql::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.sql.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
StatusOr< google::cloud::sql::v1::Operation >	the result of the RPC. The response message type (google.cloud.sql.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteBackup(std::string const &, Options)

Deletes the backup.

Parameters
Name	Description
name	std::string const & Required. The name of the backup to delete. Format: projects/{project}/backups/{backup}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

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

Deletes the backup.

Parameters
Name	Description
request	google::cloud::sql::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.sql.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
StatusOr< google::cloud::sql::v1::Operation >	the result of the RPC. The response message type (google.cloud.sql.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.