target.apidocs.com.google.api.services.spanner.v1.Spanner.Projects.Instances.Databases.BackupSchedules.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-spanner Show documentation

There is a newer version: v1-rev20241119-2.0.0

Show newest version







Spanner.Projects.Instances.Databases.BackupSchedules (Cloud Spanner API v1-rev20240910-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.spanner.v1
Class Spanner.Projects.Instances.Databases.BackupSchedules



java.lang.Object


com.google.api.services.spanner.v1.Spanner.Projects.Instances.Databases.BackupSchedules







Enclosing class:
Spanner.Projects.Instances.Databases




public class Spanner.Projects.Instances.Databases.BackupSchedules
extends Object
The "backupSchedules" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Spanner.Projects.Instances.Databases.BackupSchedules.Create 


class 
Spanner.Projects.Instances.Databases.BackupSchedules.Delete 


class 
Spanner.Projects.Instances.Databases.BackupSchedules.Get 


class 
Spanner.Projects.Instances.Databases.BackupSchedules.GetIamPolicy 


class 
Spanner.Projects.Instances.Databases.BackupSchedules.List 


class 
Spanner.Projects.Instances.Databases.BackupSchedules.Patch 


class 
Spanner.Projects.Instances.Databases.BackupSchedules.SetIamPolicy 


class 
Spanner.Projects.Instances.Databases.BackupSchedules.TestIamPermissions 









Constructor Summary

Constructors 

Constructor and Description


BackupSchedules() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Spanner.Projects.Instances.Databases.BackupSchedules.Create
create(String parent,
      BackupSchedule content)
Creates a new backup schedule.



Spanner.Projects.Instances.Databases.BackupSchedules.Delete
delete(String name)
Deletes a backup schedule.



Spanner.Projects.Instances.Databases.BackupSchedules.Get
get(String name)
Gets backup schedule for the input schedule name.



Spanner.Projects.Instances.Databases.BackupSchedules.GetIamPolicy
getIamPolicy(String resource,
            GetIamPolicyRequest content)
Gets the access control policy for a database or backup resource.



Spanner.Projects.Instances.Databases.BackupSchedules.List
list(String parent)
Lists all the backup schedules for the database.



Spanner.Projects.Instances.Databases.BackupSchedules.Patch
patch(String name,
     BackupSchedule content)
Updates a backup schedule.



Spanner.Projects.Instances.Databases.BackupSchedules.SetIamPolicy
setIamPolicy(String resource,
            SetIamPolicyRequest content)
Sets the access control policy on a database or backup resource.



Spanner.Projects.Instances.Databases.BackupSchedules.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





BackupSchedules
public BackupSchedules()









Method Detail





create
public Spanner.Projects.Instances.Databases.BackupSchedules.Create create(String parent,
                                                                          BackupSchedule content)
                                                                   throws IOException
Creates a new backup schedule.

 Create a request for the method "backupSchedules.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 database that this backup schedule applies to.
content - the BackupSchedule
Returns:
the request
Throws:
IOException








delete
public Spanner.Projects.Instances.Databases.BackupSchedules.Delete delete(String name)
                                                                   throws IOException
Deletes a backup schedule.

 Create a request for the method "backupSchedules.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. The name of the schedule to delete. Values are of the form
        `projects//instances//databases//backupSchedules/`.
Returns:
the request
Throws:
IOException








get
public Spanner.Projects.Instances.Databases.BackupSchedules.Get get(String name)
                                                             throws IOException
Gets backup schedule for the input schedule name.

 Create a request for the method "backupSchedules.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. The name of the schedule to retrieve. Values are of the form
        `projects//instances//databases//backupSchedules/`.
Returns:
the request
Throws:
IOException








getIamPolicy
public Spanner.Projects.Instances.Databases.BackupSchedules.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.

 Create a request for the method "backupSchedules.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.Databases.BackupSchedules.List list(String parent)
                                                               throws IOException
Lists all the backup schedules for the database.

 Create a request for the method "backupSchedules.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. Database is the parent resource whose backup schedules should be listed. Values are of the
        form projects//instances//databases/
Returns:
the request
Throws:
IOException








patch
public Spanner.Projects.Instances.Databases.BackupSchedules.Patch patch(String name,
                                                                        BackupSchedule content)
                                                                 throws IOException
Updates a backup schedule.

 Create a request for the method "backupSchedules.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 - Identifier. Output only for the CreateBackupSchedule operation. Required for the
        UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which
        cannot be changed. Values are of the form
        `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the
        name must be between 2 and 60 characters in length.
content - the BackupSchedule
Returns:
the request
Throws:
IOException








setIamPolicy
public Spanner.Projects.Instances.Databases.BackupSchedules.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.

 Create a request for the method "backupSchedules.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.Databases.BackupSchedules.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.

 Create a request for the method "backupSchedules.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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Spanner.Projects.Instances.Databases.BackupSchedules.Create`
`class`	`Spanner.Projects.Instances.Databases.BackupSchedules.Delete`
`class`	`Spanner.Projects.Instances.Databases.BackupSchedules.Get`
`class`	`Spanner.Projects.Instances.Databases.BackupSchedules.GetIamPolicy`
`class`	`Spanner.Projects.Instances.Databases.BackupSchedules.List`
`class`	`Spanner.Projects.Instances.Databases.BackupSchedules.Patch`
`class`	`Spanner.Projects.Instances.Databases.BackupSchedules.SetIamPolicy`
`class`	`Spanner.Projects.Instances.Databases.BackupSchedules.TestIamPermissions`

Modifier and Type	Method and Description
`Spanner.Projects.Instances.Databases.BackupSchedules.Create`	`create(String parent, BackupSchedule content)` Creates a new backup schedule.
`Spanner.Projects.Instances.Databases.BackupSchedules.Delete`	`delete(String name)` Deletes a backup schedule.
`Spanner.Projects.Instances.Databases.BackupSchedules.Get`	`get(String name)` Gets backup schedule for the input schedule name.
`Spanner.Projects.Instances.Databases.BackupSchedules.GetIamPolicy`	`getIamPolicy(String resource, GetIamPolicyRequest content)` Gets the access control policy for a database or backup resource.
`Spanner.Projects.Instances.Databases.BackupSchedules.List`	`list(String parent)` Lists all the backup schedules for the database.
`Spanner.Projects.Instances.Databases.BackupSchedules.Patch`	`patch(String name, BackupSchedule content)` Updates a backup schedule.
`Spanner.Projects.Instances.Databases.BackupSchedules.SetIamPolicy`	`setIamPolicy(String resource, SetIamPolicyRequest content)` Sets the access control policy on a database or backup resource.
`Spanner.Projects.Instances.Databases.BackupSchedules.TestIamPermissions`	`testIamPermissions(String resource, TestIamPermissionsRequest content)` Returns permissions that the caller has on the specified database or backup resource.