com.google.api.services.spanner.v1

Class Spanner.Projects.Instances.Backups

java.lang.Object

com.google.api.services.spanner.v1.Spanner.Projects.Instances.Backups

Enclosing class:

Spanner.Projects.Instances

public class Spanner.Projects.Instances.Backups
extends Object

The "backups" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Spanner.Projects.Instances.Backups.Copy
class	Spanner.Projects.Instances.Backups.Create
class	Spanner.Projects.Instances.Backups.Delete
class	Spanner.Projects.Instances.Backups.Get
class	Spanner.Projects.Instances.Backups.GetIamPolicy
class	Spanner.Projects.Instances.Backups.List
class	Spanner.Projects.Instances.Backups.Operations The "operations" collection of methods.
class	Spanner.Projects.Instances.Backups.Patch
class	Spanner.Projects.Instances.Backups.SetIamPolicy
class	Spanner.Projects.Instances.Backups.TestIamPermissions

Constructor Summary

Constructors

Constructor and Description
Backups()

Method Summary

Modifier and Type	Method and Description
Spanner.Projects.Instances.Backups.Copy	copy(String parent, CopyBackupRequest content) Starts copying a Cloud Spanner Backup.
Spanner.Projects.Instances.Backups.Create	create(String parent, Backup content) Starts creating a new Cloud Spanner Backup.
Spanner.Projects.Instances.Backups.Delete	delete(String name) Deletes a pending or completed Backup.
Spanner.Projects.Instances.Backups.Get	get(String name) Gets metadata on a pending or completed Backup.
Spanner.Projects.Instances.Backups.GetIamPolicy	getIamPolicy(String resource, GetIamPolicyRequest content) Gets the access control policy for a database or backup resource.
Spanner.Projects.Instances.Backups.List	list(String parent) Lists completed and pending backups.
Spanner.Projects.Instances.Backups.Operations	operations() An accessor for creating requests from the Operations collection.
Spanner.Projects.Instances.Backups.Patch	patch(String name, Backup content) Updates a pending or completed Backup.
Spanner.Projects.Instances.Backups.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on a database or backup resource.
Spanner.Projects.Instances.Backups.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that the caller has on the specified database or backup resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Backups

public Backups()

Method Detail

copy

public Spanner.Projects.Instances.Backups.Copy copy(String parent,
                                                    CopyBackupRequest content)
                                             throws IOException

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. Create a request for the method "backups.copy". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects//instances/`.

content - the CopyBackupRequest

Returns:

the request

Throws:

IOException

create

public Spanner.Projects.Instances.Backups.Create create(String parent,
                                                        Backup content)
                                                 throws IOException

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. Create a request for the method "backups.create". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects//instances/`.

content - the Backup

Returns:

the request

Throws:

IOException

delete

public Spanner.Projects.Instances.Backups.Delete delete(String name)
                                                 throws IOException

Deletes a pending or completed Backup. Create a request for the method "backups.delete". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the backup to delete. Values are of the form `projects//instances//backups/`.

Returns:

the request

Throws:

IOException

get

public Spanner.Projects.Instances.Backups.Get get(String name)
                                           throws IOException

Gets metadata on a pending or completed Backup. Create a request for the method "backups.get". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the backup. Values are of the form `projects//instances//backups/`.

Returns:

the request

Throws:

IOException

getIamPolicy

public Spanner.Projects.Instances.Backups.GetIamPolicy getIamPolicy(String resource,
                                                                    GetIamPolicyRequest content)
                                                             throws IOException

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. For backup schedules, authorization requires `spanner.backupSchedules.getIamPolicy` permission on resource. Create a request for the method "backups.getIamPolicy". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.

content - the GetIamPolicyRequest

Returns:

the request

Throws:

IOException

list

public Spanner.Projects.Instances.Backups.List list(String parent)
                                             throws IOException

Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`. Create a request for the method "backups.list". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The instance to list backups from. Values are of the form `projects//instances/`.

Returns:

the request

Throws:

IOException

patch

public Spanner.Projects.Instances.Backups.Patch patch(String name,
                                                      Backup content)
                                               throws IOException

Updates a pending or completed Backup. Create a request for the method "backups.patch". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.

content - the Backup

Returns:

the request

Throws:

IOException

setIamPolicy

public Spanner.Projects.Instances.Backups.SetIamPolicy setIamPolicy(String resource,
                                                                    SetIamPolicyRequest content)
                                                             throws IOException

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. For backup schedules, authorization requires `spanner.backupSchedules.setIamPolicy` permission on resource. Create a request for the method "backups.setIamPolicy". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public Spanner.Projects.Instances.Backups.TestIamPermissions testIamPermissions(String resource,
                                                                                TestIamPermissionsRequest content)
                                                                         throws IOException

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. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database. Create a request for the method "backups.testIamPermissions". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException

operations

public Spanner.Projects.Instances.Backups.Operations operations()

An accessor for creating requests from the Operations collection.

The typical use is:

    Spanner spanner = new Spanner(...);
    Spanner.Operations.List request = spanner.operations().list(parameters ...)
 

Returns:

the resource collection