Show / Hide Table of Contents

Class ProjectsResource.InstancesResource.ClustersResource.BackupsResource

The "backups" collection of methods.

Inheritance
object
ProjectsResource.InstancesResource.ClustersResource.BackupsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.BigtableAdmin.v2
Assembly: Google.Apis.BigtableAdmin.v2.dll
Syntax
public class ProjectsResource.InstancesResource.ClustersResource.BackupsResource

Constructors

BackupsResource(IClientService)

Constructs a new resource.

Declaration
public BackupsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Copy(CopyBackupRequest, string)

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

Declaration
public virtual ProjectsResource.InstancesResource.ClustersResource.BackupsResource.CopyRequest Copy(CopyBackupRequest body, string parent)
Parameters
Type Name Description
CopyBackupRequest body

The body of the request.

string parent

Required. The name of the destination cluster that will contain the backup copy. The cluster must already exists. Values are of the form: projects/{project}/instances/{instance}/clusters/{cluster}.

Returns
Type Description
ProjectsResource.InstancesResource.ClustersResource.BackupsResource.CopyRequest

Create(Backup, string)

Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation 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.

Declaration
public virtual ProjectsResource.InstancesResource.ClustersResource.BackupsResource.CreateRequest Create(Backup body, string parent)
Parameters
Type Name Description
Backup body

The body of the request.

string parent

Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Returns
Type Description
ProjectsResource.InstancesResource.ClustersResource.BackupsResource.CreateRequest

Delete(string)

Deletes a pending or completed Cloud Bigtable backup.

Declaration
public virtual ProjectsResource.InstancesResource.ClustersResource.BackupsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. Name of the backup to delete. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}.

Returns
Type Description
ProjectsResource.InstancesResource.ClustersResource.BackupsResource.DeleteRequest

Get(string)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Declaration
public virtual ProjectsResource.InstancesResource.ClustersResource.BackupsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. Name of the backup. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}.

Returns
Type Description
ProjectsResource.InstancesResource.ClustersResource.BackupsResource.GetRequest

GetIamPolicy(GetIamPolicyRequest, string)

Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.

Declaration
public virtual ProjectsResource.InstancesResource.ClustersResource.BackupsResource.GetIamPolicyRequest GetIamPolicy(GetIamPolicyRequest body, string resource)
Parameters
Type Name Description
GetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.InstancesResource.ClustersResource.BackupsResource.GetIamPolicyRequest

List(string)

Lists Cloud Bigtable backups. Returns both completed and pending backups.

Declaration
public virtual ProjectsResource.InstancesResource.ClustersResource.BackupsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The cluster to list backups from. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}. Use {cluster} = '-' to list backups for all clusters in an instance, e.g., projects/{project}/instances/{instance}/clusters/-.

Returns
Type Description
ProjectsResource.InstancesResource.ClustersResource.BackupsResource.ListRequest

Patch(Backup, string)

Updates a pending or completed Cloud Bigtable Backup.

Declaration
public virtual ProjectsResource.InstancesResource.ClustersResource.BackupsResource.PatchRequest Patch(Backup body, string name)
Parameters
Type Name Description
Backup body

The body of the request.

string name

A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9* The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Returns
Type Description
ProjectsResource.InstancesResource.ClustersResource.BackupsResource.PatchRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets the access control policy on a Table resource. Replaces any existing policy.

Declaration
public virtual ProjectsResource.InstancesResource.ClustersResource.BackupsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.InstancesResource.ClustersResource.BackupsResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

Returns permissions that the caller has on the specified table resource.

Declaration
public virtual ProjectsResource.InstancesResource.ClustersResource.BackupsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.InstancesResource.ClustersResource.BackupsResource.TestIamPermissionsRequest
In This Article
Back to top Generated by DocFX