Show / Hide Table of Contents

Class ProjectsResource.InstancesResource.TablesResource

The "tables" collection of methods.

Inheritance
object
ProjectsResource.InstancesResource.TablesResource
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.TablesResource

Constructors

TablesResource(IClientService)

Constructs a new resource.

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

Methods

CheckConsistency(CheckConsistencyRequest, string)

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

Declaration
public virtual ProjectsResource.InstancesResource.TablesResource.CheckConsistencyRequest CheckConsistency(CheckConsistencyRequest body, string name)
Parameters
Type Name Description
CheckConsistencyRequest body

The body of the request.

string name

Required. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Returns
Type Description
ProjectsResource.InstancesResource.TablesResource.CheckConsistencyRequest

Create(CreateTableRequest, string)

Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.

Declaration
public virtual ProjectsResource.InstancesResource.TablesResource.CreateRequest Create(CreateTableRequest body, string parent)
Parameters
Type Name Description
CreateTableRequest body

The body of the request.

string parent

Required. The unique name of the instance in which to create the table. Values are of the form projects/{project}/instances/{instance}.

Returns
Type Description
ProjectsResource.InstancesResource.TablesResource.CreateRequest

Delete(string)

Permanently deletes a specified table and all of its data.

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

Required. The unique name of the table to be deleted. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Returns
Type Description
ProjectsResource.InstancesResource.TablesResource.DeleteRequest

DropRowRange(DropRowRangeRequest, string)

Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.

Declaration
public virtual ProjectsResource.InstancesResource.TablesResource.DropRowRangeRequest DropRowRange(DropRowRangeRequest body, string name)
Parameters
Type Name Description
DropRowRangeRequest body

The body of the request.

string name

Required. The unique name of the table on which to drop a range of rows. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Returns
Type Description
ProjectsResource.InstancesResource.TablesResource.DropRowRangeRequest

GenerateConsistencyToken(GenerateConsistencyTokenRequest, string)

Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.

Declaration
public virtual ProjectsResource.InstancesResource.TablesResource.GenerateConsistencyTokenRequest GenerateConsistencyToken(GenerateConsistencyTokenRequest body, string name)
Parameters
Type Name Description
GenerateConsistencyTokenRequest body

The body of the request.

string name

Required. The unique name of the Table for which to create a consistency token. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Returns
Type Description
ProjectsResource.InstancesResource.TablesResource.GenerateConsistencyTokenRequest

Get(string)

Gets metadata information about the specified table.

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

Required. The unique name of the requested table. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Returns
Type Description
ProjectsResource.InstancesResource.TablesResource.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.TablesResource.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.TablesResource.GetIamPolicyRequest

List(string)

Lists all tables served from a specified instance.

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

Required. The unique name of the instance for which tables should be listed. Values are of the form projects/{project}/instances/{instance}.

Returns
Type Description
ProjectsResource.InstancesResource.TablesResource.ListRequest

ModifyColumnFamilies(ModifyColumnFamiliesRequest, string)

Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.

Declaration
public virtual ProjectsResource.InstancesResource.TablesResource.ModifyColumnFamiliesRequest ModifyColumnFamilies(ModifyColumnFamiliesRequest body, string name)
Parameters
Type Name Description
ModifyColumnFamiliesRequest body

The body of the request.

string name

Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Returns
Type Description
ProjectsResource.InstancesResource.TablesResource.ModifyColumnFamiliesRequest

Patch(Table, string)

Updates a specified table.

Declaration
public virtual ProjectsResource.InstancesResource.TablesResource.PatchRequest Patch(Table body, string name)
Parameters
Type Name Description
Table body

The body of the request.

string name

The unique name of the table. Values are of the form projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, STATS_VIEW, FULL

Returns
Type Description
ProjectsResource.InstancesResource.TablesResource.PatchRequest

Restore(RestoreTableRequest, string)

Create a new table by restoring from a completed backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.

Declaration
public virtual ProjectsResource.InstancesResource.TablesResource.RestoreRequest Restore(RestoreTableRequest body, string parent)
Parameters
Type Name Description
RestoreTableRequest body

The body of the request.

string parent

Required. The name of the instance in which to create the restored table. Values are of the form projects//instances/.

Returns
Type Description
ProjectsResource.InstancesResource.TablesResource.RestoreRequest

SetIamPolicy(SetIamPolicyRequest, string)

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

Declaration
public virtual ProjectsResource.InstancesResource.TablesResource.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.TablesResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

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

Declaration
public virtual ProjectsResource.InstancesResource.TablesResource.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.TablesResource.TestIamPermissionsRequest

Undelete(UndeleteTableRequest, string)

Restores a specified table which was accidentally deleted.

Declaration
public virtual ProjectsResource.InstancesResource.TablesResource.UndeleteRequest Undelete(UndeleteTableRequest body, string name)
Parameters
Type Name Description
UndeleteTableRequest body

The body of the request.

string name

Required. The unique name of the table to be restored. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Returns
Type Description
ProjectsResource.InstancesResource.TablesResource.UndeleteRequest
In This Article
Back to top Generated by DocFX