ProjectsInstancesBackups
class ProjectsInstancesBackups extends Resource (View source)
The "backups" collection of methods.
Typical usage is:
$spannerService = new Google\Service\Spanner(...);
$backups = $spannerService->projects_instances_backups;Methods
Starts copying a Cloud Spanner Backup. The returned backup long-running
operation will have a name of the format
projects//instances//backups//operations/ and can be used to track copying
of the backup. The operation is associated with the destination backup. The
metadata field type is CopyBackupMetadata. The response field type is Backup,
if successful. Cancelling the returned operation will stop the copying and
delete the destination backup. Concurrent CopyBackup requests can run on the
same source backup. (backups.copy)
Starts creating a new Cloud Spanner Backup. The returned backup long-running
operation will have a name of the format
projects//instances//backups//operations/ and can be used to track creation
of the backup. The metadata field type is CreateBackupMetadata. The response
field type is Backup, if successful. Cancelling the returned operation will
stop the creation and delete the backup. There can be only one pending backup
creation per database. Backup creation of different databases can run
concurrently. (backups.create)
Deletes a pending or completed Backup. (backups.delete)
Gets metadata on a pending or completed Backup. (backups.get)
Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.
Lists completed and pending backups. Backups returned are ordered by
create_time in descending order, starting from the most recent
create_time. (backups.listProjectsInstancesBackups)
Sets the access control policy on a database or backup resource. Replaces any
existing policy. Authorization requires spanner.databases.setIamPolicy
permission on resource. For backups, authorization requires
spanner.backups.setIamPolicy permission on resource. (backups.setIamPolicy)
Returns permissions that the caller has on the specified database or backup
resource. Attempting this RPC on a non-existent Cloud Spanner database will
result in a NOT_FOUND error if the user has spanner.databases.list
permission on the containing Cloud Spanner instance. Otherwise returns an
empty set of permissions. Calling this method on a backup that does not exist
will result in a NOT_FOUND error if the user has spanner.backups.list
permission on the containing instance. (backups.testIamPermissions)
Details
Operation
copy(string $parent, CopyBackupRequest $postBody, array $optParams = [])
Starts copying a Cloud Spanner Backup. The returned backup long-running
operation will have a name of the format
projects//instances//backups//operations/ and can be used to track copying
of the backup. The operation is associated with the destination backup. The
metadata field type is CopyBackupMetadata. The response field type is Backup,
if successful. Cancelling the returned operation will stop the copying and
delete the destination backup. Concurrent CopyBackup requests can run on the
same source backup. (backups.copy)
Operation
create(string $parent, Backup $postBody, array $optParams = [])
Starts creating a new Cloud Spanner Backup. The returned backup long-running
operation will have a name of the format
projects//instances//backups//operations/ and can be used to track creation
of the backup. The metadata field type is CreateBackupMetadata. The response
field type is Backup, if successful. Cancelling the returned operation will
stop the creation and delete the backup. There can be only one pending backup
creation per database. Backup creation of different databases can run
concurrently. (backups.create)
SpannerEmpty
delete(string $name, array $optParams = [])
Deletes a pending or completed Backup. (backups.delete)
Backup
get(string $name, array $optParams = [])
Gets metadata on a pending or completed Backup. (backups.get)
Policy
getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])
Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.
Authorization requires spanner.databases.getIamPolicy permission on
resource. For backups, authorization requires spanner.backups.getIamPolicy
permission on resource. (backups.getIamPolicy)
ListBackupsResponse
listProjectsInstancesBackups(string $parent, array $optParams = [])
Lists completed and pending backups. Backups returned are ordered by
create_time in descending order, starting from the most recent
create_time. (backups.listProjectsInstancesBackups)
Backup
patch(string $name, Backup $postBody, array $optParams = [])
Updates a pending or completed Backup. (backups.patch)
Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])
Sets the access control policy on a database or backup resource. Replaces any
existing policy. Authorization requires spanner.databases.setIamPolicy
permission on resource. For backups, authorization requires
spanner.backups.setIamPolicy permission on resource. (backups.setIamPolicy)
TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])
Returns permissions that the caller has on the specified database or backup
resource. Attempting this RPC on a non-existent Cloud Spanner database will
result in a NOT_FOUND error if the user has spanner.databases.list
permission on the containing Cloud Spanner instance. Otherwise returns an
empty set of permissions. Calling this method on a backup that does not exist
will result in a NOT_FOUND error if the user has spanner.backups.list
permission on the containing instance. (backups.testIamPermissions)