BigtableAdmin
import { BigtableAdmin } from "https://googleapis.deno.dev/v1/bigtableadmin:v2.ts";
Administer your Cloud Bigtable tables and instances.
§Methods
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
The name of the operation's parent resource.
Creates an app profile within an instance.
Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}
.
Deletes an app profile from an instance.
Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}
.
Gets information about an app profile.
Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}
.
Lists information about app profiles in an instance.
Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance}
. Use {instance} = '-'
to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-
.
Updates an app profile within an instance.
The unique name of the app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*
.
Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
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}
.
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.
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}
.
Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.
REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
Lists Cloud Bigtable backups. Returns both completed and pending backups.
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/-
.
Updates a pending or completed Cloud Bigtable Backup.
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}
.
Sets the access control policy on a Bigtable resource. Replaces any existing policy.
REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
Returns permissions that the caller has on the specified Bigtable resource.
REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.
Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}
.
Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.
Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}
.
Lists information about clusters in an instance.
Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}
. Use {instance} = '-'
to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-
.
Partially updates a cluster within a project. This method is the preferred way to update a Cluster. To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask. To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.
The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z*
.
Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.
The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z*
.
Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.
Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}
.
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
Lists information about instances in a project.
Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}
.
Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.
The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9]
.
Sets the access control policy on an instance resource. Replaces any existing policy.
REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
Creates a new AuthorizedView in a table.
Required. This is the name of the table the AuthorizedView belongs to. Values are of the form projects/{project}/instances/{instance}/tables/{table}
.
Permanently deletes a specified AuthorizedView.
Required. The unique name of the AuthorizedView to be deleted. Values are of the form projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}
.
Gets information from a specified AuthorizedView.
Required. The unique name of the requested AuthorizedView. Values are of the form projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}
.
Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.
REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
Lists all AuthorizedViews from a specific table.
Required. The unique name of the table for which AuthorizedViews should be listed. Values are of the form projects/{project}/instances/{instance}/tables/{table}
.
Updates an AuthorizedView in a table.
Identifier. The name of this AuthorizedView. Values are of the form projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}
Sets the access control policy on a Bigtable resource. Replaces any existing policy.
REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
Returns permissions that the caller has on the specified Bigtable resource.
REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
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.
Required. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table}
.
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.
Required. The unique name of the instance in which to create the table. Values are of the form projects/{project}/instances/{instance}
.
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.
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}
.
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.
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}
.
Gets metadata information about the specified table.
Required. The unique name of the requested table. Values are of the form projects/{project}/instances/{instance}/tables/{table}
.
Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.
REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
Lists all tables served from a specified instance.
Required. The unique name of the instance for which tables should be listed. Values are of the form projects/{project}/instances/{instance}
.
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.
Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table}
.
Updates a specified table.
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
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.
Required. The name of the instance in which to create the restored table. Values are of the form projects//instances/
.
Sets the access control policy on a Bigtable resource. Replaces any existing policy.
REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
Returns permissions that the caller has on the specified Bigtable resource.
REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
Restores a specified table which was accidentally deleted.
Required. The unique name of the table to be restored. Values are of the form projects/{project}/instances/{instance}/tables/{table}
.
Returns permissions that the caller has on the specified instance resource.
REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.
The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9]
.
Lists information about the supported locations for this service.
The resource that owns the locations collection, if applicable.