Class SqlBackupRunsServiceClient (2.19.0-rc)

Service for managing database backups.

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

SqlBackupRunsServiceClient(SqlBackupRunsServiceClient const &)

Copy and move support

Parameter
NameDescription
SqlBackupRunsServiceClient const &

SqlBackupRunsServiceClient(SqlBackupRunsServiceClient &&)

Copy and move support

Parameter
NameDescription
SqlBackupRunsServiceClient &&

SqlBackupRunsServiceClient(std::shared_ptr< SqlBackupRunsServiceConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< SqlBackupRunsServiceConnection >
opts Options

Operators

operator=(SqlBackupRunsServiceClient const &)

Copy and move support

Parameter
NameDescription
SqlBackupRunsServiceClient const &
Returns
TypeDescription
SqlBackupRunsServiceClient &

operator=(SqlBackupRunsServiceClient &&)

Copy and move support

Parameter
NameDescription
SqlBackupRunsServiceClient &&
Returns
TypeDescription
SqlBackupRunsServiceClient &

Functions

Delete(google::cloud::sql::v1::SqlBackupRunsDeleteRequest const &, Options)

Deletes the backup taken by a backup run.

Parameters
NameDescription
request google::cloud::sql::v1::SqlBackupRunsDeleteRequest 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.SqlBackupRunsDeleteRequest. 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
TypeDescription
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.

Get(google::cloud::sql::v1::SqlBackupRunsGetRequest const &, Options)

Retrieves a resource containing information about a backup run.

Parameters
NameDescription
request google::cloud::sql::v1::SqlBackupRunsGetRequest 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.SqlBackupRunsGetRequest. 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
TypeDescription
StatusOr< google::cloud::sql::v1::BackupRun >

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

Insert(google::cloud::sql::v1::SqlBackupRunsInsertRequest const &, Options)

Creates a new backup run on demand.

Parameters
NameDescription
request google::cloud::sql::v1::SqlBackupRunsInsertRequest 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.SqlBackupRunsInsertRequest. 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
TypeDescription
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.

List(google::cloud::sql::v1::SqlBackupRunsListRequest const &, Options)

Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.

Parameters
NameDescription
request google::cloud::sql::v1::SqlBackupRunsListRequest 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.SqlBackupRunsListRequest. 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
TypeDescription
StatusOr< google::cloud::sql::v1::BackupRunsListResponse >

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