target.apidocs.com.google.api.services.bigtableadmin.v2.BigtableAdmin.Projects.Instances.Tables.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-bigtableadmin Show documentation

The newest version!







BigtableAdmin.Projects.Instances.Tables (Cloud Bigtable Admin API v2-rev20241203-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.bigtableadmin.v2
Class BigtableAdmin.Projects.Instances.Tables



java.lang.Object


com.google.api.services.bigtableadmin.v2.BigtableAdmin.Projects.Instances.Tables







Enclosing class:
BigtableAdmin.Projects.Instances




public class BigtableAdmin.Projects.Instances.Tables
extends Object
The "tables" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
BigtableAdmin.Projects.Instances.Tables.AuthorizedViews
The "authorizedViews" collection of methods.



class 
BigtableAdmin.Projects.Instances.Tables.CheckConsistency 


class 
BigtableAdmin.Projects.Instances.Tables.Create 


class 
BigtableAdmin.Projects.Instances.Tables.Delete 


class 
BigtableAdmin.Projects.Instances.Tables.DropRowRange 


class 
BigtableAdmin.Projects.Instances.Tables.GenerateConsistencyToken 


class 
BigtableAdmin.Projects.Instances.Tables.Get 


class 
BigtableAdmin.Projects.Instances.Tables.GetIamPolicy 


class 
BigtableAdmin.Projects.Instances.Tables.List 


class 
BigtableAdmin.Projects.Instances.Tables.ModifyColumnFamilies 


class 
BigtableAdmin.Projects.Instances.Tables.Patch 


class 
BigtableAdmin.Projects.Instances.Tables.Restore 


class 
BigtableAdmin.Projects.Instances.Tables.SetIamPolicy 


class 
BigtableAdmin.Projects.Instances.Tables.TestIamPermissions 


class 
BigtableAdmin.Projects.Instances.Tables.Undelete 









Constructor Summary

Constructors 

Constructor and Description


Tables() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BigtableAdmin.Projects.Instances.Tables.AuthorizedViews
authorizedViews()
An accessor for creating requests from the AuthorizedViews collection.



BigtableAdmin.Projects.Instances.Tables.CheckConsistency
checkConsistency(String name,
                CheckConsistencyRequest content)
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.



BigtableAdmin.Projects.Instances.Tables.Create
create(String parent,
      CreateTableRequest content)
Creates a new table in the specified instance.



BigtableAdmin.Projects.Instances.Tables.Delete
delete(String name)
Permanently deletes a specified table and all of its data.



BigtableAdmin.Projects.Instances.Tables.DropRowRange
dropRowRange(String name,
            DropRowRangeRequest content)
Permanently drop/delete a row range from a specified table.



BigtableAdmin.Projects.Instances.Tables.GenerateConsistencyToken
generateConsistencyToken(String name,
                        GenerateConsistencyTokenRequest content)
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.



BigtableAdmin.Projects.Instances.Tables.Get
get(String name)
Gets metadata information about the specified table.



BigtableAdmin.Projects.Instances.Tables.GetIamPolicy
getIamPolicy(String resource,
            GetIamPolicyRequest content)
Gets the access control policy for a Bigtable resource.



BigtableAdmin.Projects.Instances.Tables.List
list(String parent)
Lists all tables served from a specified instance.



BigtableAdmin.Projects.Instances.Tables.ModifyColumnFamilies
modifyColumnFamilies(String name,
                    ModifyColumnFamiliesRequest content)
Performs a series of column family modifications on the specified table.



BigtableAdmin.Projects.Instances.Tables.Patch
patch(String name,
     Table content)
Updates a specified table.



BigtableAdmin.Projects.Instances.Tables.Restore
restore(String parent,
       RestoreTableRequest content)
Create a new table by restoring from a completed backup.



BigtableAdmin.Projects.Instances.Tables.SetIamPolicy
setIamPolicy(String resource,
            SetIamPolicyRequest content)
Sets the access control policy on a Bigtable resource.



BigtableAdmin.Projects.Instances.Tables.TestIamPermissions
testIamPermissions(String resource,
                  TestIamPermissionsRequest content)
Returns permissions that the caller has on the specified Bigtable resource.



BigtableAdmin.Projects.Instances.Tables.Undelete
undelete(String name,
        UndeleteTableRequest content)
Restores a specified table which was accidentally deleted.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Tables
public Tables()









Method Detail





checkConsistency
public BigtableAdmin.Projects.Instances.Tables.CheckConsistency checkConsistency(String name,
                                                                                 CheckConsistencyRequest content)
                                                                          throws IOException
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.

 Create a request for the method "tables.checkConsistency".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
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}`.
content - the CheckConsistencyRequest
Returns:
the request
Throws:
IOException








create
public BigtableAdmin.Projects.Instances.Tables.Create create(String parent,
                                                             CreateTableRequest content)
                                                      throws IOException
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.

 Create a request for the method "tables.create".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The unique name of the instance in which to create the table. Values are of the form
        `projects/{project}/instances/{instance}`.
content - the CreateTableRequest
Returns:
the request
Throws:
IOException








delete
public BigtableAdmin.Projects.Instances.Tables.Delete delete(String name)
                                                      throws IOException
Permanently deletes a specified table and all of its data.

 Create a request for the method "tables.delete".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The unique name of the table to be deleted. Values are of the form
        `projects/{project}/instances/{instance}/tables/{table}`.
Returns:
the request
Throws:
IOException








dropRowRange
public BigtableAdmin.Projects.Instances.Tables.DropRowRange dropRowRange(String name,
                                                                         DropRowRangeRequest content)
                                                                  throws IOException
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. Note that row key
 prefixes used here are treated as service data. For more information about how service data is
 handled, see the [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-
 notice).

 Create a request for the method "tables.dropRowRange".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
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}`.
content - the DropRowRangeRequest
Returns:
the request
Throws:
IOException








generateConsistencyToken
public BigtableAdmin.Projects.Instances.Tables.GenerateConsistencyToken generateConsistencyToken(String name,
                                                                                                 GenerateConsistencyTokenRequest content)
                                                                                          throws IOException
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.

 Create a request for the method "tables.generateConsistencyToken".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
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}`.
content - the GenerateConsistencyTokenRequest
Returns:
the request
Throws:
IOException








get
public BigtableAdmin.Projects.Instances.Tables.Get get(String name)
                                                throws IOException
Gets metadata information about the specified table.

 Create a request for the method "tables.get".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The unique name of the requested table. Values are of the form
        `projects/{project}/instances/{instance}/tables/{table}`.
Returns:
the request
Throws:
IOException








getIamPolicy
public BigtableAdmin.Projects.Instances.Tables.GetIamPolicy getIamPolicy(String resource,
                                                                         GetIamPolicyRequest content)
                                                                  throws IOException
Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource
 exists but does not have a policy set.

 Create a request for the method "tables.getIamPolicy".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy is being requested. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
content - the GetIamPolicyRequest
Returns:
the request
Throws:
IOException








list
public BigtableAdmin.Projects.Instances.Tables.List list(String parent)
                                                  throws IOException
Lists all tables served from a specified instance.

 Create a request for the method "tables.list".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The unique name of the instance for which tables should be listed. Values are of the form
        `projects/{project}/instances/{instance}`.
Returns:
the request
Throws:
IOException








modifyColumnFamilies
public BigtableAdmin.Projects.Instances.Tables.ModifyColumnFamilies modifyColumnFamilies(String name,
                                                                                         ModifyColumnFamiliesRequest content)
                                                                                  throws IOException
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.

 Create a request for the method "tables.modifyColumnFamilies".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
name - Required. The unique name of the table whose families should be modified. Values are of the form
        `projects/{project}/instances/{instance}/tables/{table}`.
content - the ModifyColumnFamiliesRequest
Returns:
the request
Throws:
IOException








patch
public BigtableAdmin.Projects.Instances.Tables.Patch patch(String name,
                                                           Table content)
                                                    throws IOException
Updates a specified table.

 Create a request for the method "tables.patch".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
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`
content - the Table
Returns:
the request
Throws:
IOException








restore
public BigtableAdmin.Projects.Instances.Tables.Restore restore(String parent,
                                                               RestoreTableRequest content)
                                                        throws IOException
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.

 Create a request for the method "tables.restore".

 This request holds the parameters needed by the bigtableadmin 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 to create the restored table. Values are of the form
        `projects//instances/`.
content - the RestoreTableRequest
Returns:
the request
Throws:
IOException








setIamPolicy
public BigtableAdmin.Projects.Instances.Tables.SetIamPolicy setIamPolicy(String resource,
                                                                         SetIamPolicyRequest content)
                                                                  throws IOException
Sets the access control policy on a Bigtable resource. Replaces any existing policy.

 Create a request for the method "tables.setIamPolicy".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy is being specified. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
content - the SetIamPolicyRequest
Returns:
the request
Throws:
IOException








testIamPermissions
public BigtableAdmin.Projects.Instances.Tables.TestIamPermissions testIamPermissions(String resource,
                                                                                     TestIamPermissionsRequest content)
                                                                              throws IOException
Returns permissions that the caller has on the specified Bigtable resource.

 Create a request for the method "tables.testIamPermissions".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
content - the TestIamPermissionsRequest
Returns:
the request
Throws:
IOException








undelete
public BigtableAdmin.Projects.Instances.Tables.Undelete undelete(String name,
                                                                 UndeleteTableRequest content)
                                                          throws IOException
Restores a specified table which was accidentally deleted.

 Create a request for the method "tables.undelete".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The unique name of the table to be restored. Values are of the form
        `projects/{project}/instances/{instance}/tables/{table}`.
content - the UndeleteTableRequest
Returns:
the request
Throws:
IOException








authorizedViews
public BigtableAdmin.Projects.Instances.Tables.AuthorizedViews authorizedViews()
An accessor for creating requests from the AuthorizedViews collection.

 The typical use is:
     BigtableAdmin bigtableadmin = new BigtableAdmin(...);
    BigtableAdmin.AuthorizedViews.List request = bigtableadmin.authorizedViews().list(parameters ...)
 

Returns:
the resource collection














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`	`BigtableAdmin.Projects.Instances.Tables.AuthorizedViews` The "authorizedViews" collection of methods.
`class`	`BigtableAdmin.Projects.Instances.Tables.CheckConsistency`
`class`	`BigtableAdmin.Projects.Instances.Tables.Create`
`class`	`BigtableAdmin.Projects.Instances.Tables.Delete`
`class`	`BigtableAdmin.Projects.Instances.Tables.DropRowRange`
`class`	`BigtableAdmin.Projects.Instances.Tables.GenerateConsistencyToken`
`class`	`BigtableAdmin.Projects.Instances.Tables.Get`
`class`	`BigtableAdmin.Projects.Instances.Tables.GetIamPolicy`
`class`	`BigtableAdmin.Projects.Instances.Tables.List`
`class`	`BigtableAdmin.Projects.Instances.Tables.ModifyColumnFamilies`
`class`	`BigtableAdmin.Projects.Instances.Tables.Patch`
`class`	`BigtableAdmin.Projects.Instances.Tables.Restore`
`class`	`BigtableAdmin.Projects.Instances.Tables.SetIamPolicy`
`class`	`BigtableAdmin.Projects.Instances.Tables.TestIamPermissions`
`class`	`BigtableAdmin.Projects.Instances.Tables.Undelete`

Modifier and Type	Method and Description
`BigtableAdmin.Projects.Instances.Tables.AuthorizedViews`	`authorizedViews()` An accessor for creating requests from the AuthorizedViews collection.
`BigtableAdmin.Projects.Instances.Tables.CheckConsistency`	`checkConsistency(String name, CheckConsistencyRequest content)` 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.
`BigtableAdmin.Projects.Instances.Tables.Create`	`create(String parent, CreateTableRequest content)` Creates a new table in the specified instance.
`BigtableAdmin.Projects.Instances.Tables.Delete`	`delete(String name)` Permanently deletes a specified table and all of its data.
`BigtableAdmin.Projects.Instances.Tables.DropRowRange`	`dropRowRange(String name, DropRowRangeRequest content)` Permanently drop/delete a row range from a specified table.
`BigtableAdmin.Projects.Instances.Tables.GenerateConsistencyToken`	`generateConsistencyToken(String name, GenerateConsistencyTokenRequest content)` 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.
`BigtableAdmin.Projects.Instances.Tables.Get`	`get(String name)` Gets metadata information about the specified table.
`BigtableAdmin.Projects.Instances.Tables.GetIamPolicy`	`getIamPolicy(String resource, GetIamPolicyRequest content)` Gets the access control policy for a Bigtable resource.
`BigtableAdmin.Projects.Instances.Tables.List`	`list(String parent)` Lists all tables served from a specified instance.
`BigtableAdmin.Projects.Instances.Tables.ModifyColumnFamilies`	`modifyColumnFamilies(String name, ModifyColumnFamiliesRequest content)` Performs a series of column family modifications on the specified table.
`BigtableAdmin.Projects.Instances.Tables.Patch`	`patch(String name, Table content)` Updates a specified table.
`BigtableAdmin.Projects.Instances.Tables.Restore`	`restore(String parent, RestoreTableRequest content)` Create a new table by restoring from a completed backup.
`BigtableAdmin.Projects.Instances.Tables.SetIamPolicy`	`setIamPolicy(String resource, SetIamPolicyRequest content)` Sets the access control policy on a Bigtable resource.
`BigtableAdmin.Projects.Instances.Tables.TestIamPermissions`	`testIamPermissions(String resource, TestIamPermissionsRequest content)` Returns permissions that the caller has on the specified Bigtable resource.
`BigtableAdmin.Projects.Instances.Tables.Undelete`	`undelete(String name, UndeleteTableRequest content)` Restores a specified table which was accidentally deleted.