Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://googleapis.deno.dev/v1/bigtableadmin:v2.ts";

§Classes

BigtableAdmin

Administer your Cloud Bigtable tables and instances.

GoogleAuth

§Variables

auth

§Interfaces

AppProfile

A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.

AuditConfig

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

AuditLogConfig

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

AuthorizedView

An Authorized View of a Cloud Bigtable Table.

AutomatedBackupPolicy

Defines an automated backup policy for a table

AutoscalingLimits

Limits for the number of nodes a Cluster can autoscale up/down to.

AutoscalingTargets

The Autoscaling targets for a Cluster. These determine the recommended nodes.

Backup

A backup of a Cloud Bigtable table.

BackupInfo

Information about a backup.

Binding

Associates members, or principals, with a role.

ChangeStreamConfig

Change stream configuration.

CheckConsistencyRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency

CheckConsistencyResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency

Cluster

A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.

ClusterAutoscalingConfig

Autoscaling config for a cluster.

ClusterConfig

Configuration for a cluster.

ClusterState

The state of a table's data in a particular cluster.

ColumnFamily

A set of columns within a table which share a common configuration.

ColumnFamilyStats

Approximate statistics related to a single column family within a table. This information may change rapidly, interpreting these values at a point in time may already preset out-of-date information. Everything below is approximate, unless otherwise specified.

CopyBackupMetadata

Metadata type for the google.longrunning.Operation returned by CopyBackup.

CopyBackupRequest

The request for CopyBackup.

CreateAuthorizedViewMetadata

The metadata for the Operation returned by CreateAuthorizedView.

CreateAuthorizedViewRequest

The request for CreateAuthorizedView

CreateBackupMetadata

Metadata type for the operation returned by CreateBackup.

CreateClusterMetadata

The metadata for the Operation returned by CreateCluster.

CreateClusterRequest

Request message for BigtableInstanceAdmin.CreateCluster.

CreateInstanceMetadata

The metadata for the Operation returned by CreateInstance.

CreateInstanceRequest

Request message for BigtableInstanceAdmin.CreateInstance.

CreateTableRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

DataBoostIsolationReadOnly

Data Boost is a serverless compute capability that lets you run high-throughput read jobs and queries on your Bigtable data, without impacting the performance of the clusters that handle your application traffic. Data Boost supports read-only use cases with single-cluster routing.

DataBoostReadLocalWrites

Checks that all writes before the consistency token was generated in the same cluster are readable by Databoost.

DropRowRangeRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

EncryptionConfig

Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.

EncryptionInfo

Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.

Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

GcRule

Rule for determining which cells to delete during garbage collection.

GenerateConsistencyTokenRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken

GenerateConsistencyTokenResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken

GetIamPolicyRequest

Request message for GetIamPolicy method.

GetPolicyOptions

Encapsulates settings provided to GetIamPolicy.

GoogleBigtableAdminV2AuthorizedViewFamilySubsets

Subsets of a column family that are included in this AuthorizedView.

GoogleBigtableAdminV2AuthorizedViewSubsetView

Defines a simple AuthorizedView that is a subset of the underlying Table.

GoogleBigtableAdminV2TypeAggregate

A value that combines incremental updates into a summarized value. Data is never directly written or read using type Aggregate. Writes will provide either the input_type or state_type, and reads will always return the state_type .

GoogleBigtableAdminV2TypeAggregateSum

Computes the sum of the input values. Allowed input: Int64 State: same as input

GoogleBigtableAdminV2TypeBytes

Bytes Values of type Bytes are stored in Value.bytes_value.

GoogleBigtableAdminV2TypeBytesEncoding

Rules used to convert to/from lower level types.

GoogleBigtableAdminV2TypeBytesEncodingRaw

Leaves the value "as-is" * Natural sort? Yes * Self-delimiting? No * Compatibility? N/A

GoogleBigtableAdminV2TypeInt64

Int64 Values of type Int64 are stored in Value.int_value.

GoogleBigtableAdminV2TypeInt64Encoding

Rules used to convert to/from lower level types.

GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes

Encodes the value as an 8-byte big endian twos complement Bytes value. * Natural sort? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation BINARY encoding - HBase Bytes.toBytes - Java ByteBuffer.putLong() with ByteOrder.BIG_ENDIAN

HotTablet

A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time.

Instance

A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.

Intersection

A GcRule which deletes cells matching all of the given rules.

ListAppProfilesResponse

Response message for BigtableInstanceAdmin.ListAppProfiles.

ListAuthorizedViewsResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews

ListBackupsResponse

The response for ListBackups.

ListClustersResponse

Response message for BigtableInstanceAdmin.ListClusters.

ListHotTabletsResponse

Response message for BigtableInstanceAdmin.ListHotTablets.

ListInstancesResponse

Response message for BigtableInstanceAdmin.ListInstances.

ListLocationsResponse

The response message for Locations.ListLocations.

ListOperationsResponse

The response message for Operations.ListOperations.

ListTablesResponse

Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables

Location

A resource that represents a Google Cloud location.

Modification

A create, update, or delete of a particular column family.

ModifyColumnFamiliesRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies

MultiClusterRoutingUseAny

Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.

Operation

This resource represents a long-running operation that is the result of a network API call.

OperationProgress

Encapsulates progress related information for a Cloud Bigtable long running operation.

OperationsProjectsOperationsListOptions

Additional options for BigtableAdmin#operationsProjectsOperationsList.

OptimizeRestoredTableMetadata

Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored table. This long-running operation is automatically created by the system after the successful completion of a table restore, and cannot be cancelled.

PartialUpdateClusterMetadata

The metadata for the Operation returned by PartialUpdateCluster.

PartialUpdateClusterRequest

Request message for BigtableInstanceAdmin.PartialUpdateCluster.

PartialUpdateInstanceRequest

Request message for BigtableInstanceAdmin.PartialUpdateInstance.

Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: ``` bindings: - members:

ProjectsInstancesAppProfilesCreateOptions

Additional options for BigtableAdmin#projectsInstancesAppProfilesCreate.

ProjectsInstancesAppProfilesDeleteOptions

Additional options for BigtableAdmin#projectsInstancesAppProfilesDelete.

ProjectsInstancesAppProfilesListOptions

Additional options for BigtableAdmin#projectsInstancesAppProfilesList.

ProjectsInstancesAppProfilesPatchOptions

Additional options for BigtableAdmin#projectsInstancesAppProfilesPatch.

ProjectsInstancesClustersBackupsCreateOptions

Additional options for BigtableAdmin#projectsInstancesClustersBackupsCreate.

ProjectsInstancesClustersBackupsListOptions

Additional options for BigtableAdmin#projectsInstancesClustersBackupsList.

ProjectsInstancesClustersBackupsPatchOptions

Additional options for BigtableAdmin#projectsInstancesClustersBackupsPatch.

ProjectsInstancesClustersCreateOptions

Additional options for BigtableAdmin#projectsInstancesClustersCreate.

ProjectsInstancesClustersHotTabletsListOptions

Additional options for BigtableAdmin#projectsInstancesClustersHotTabletsList.

ProjectsInstancesClustersListOptions

Additional options for BigtableAdmin#projectsInstancesClustersList.

ProjectsInstancesClustersPartialUpdateClusterOptions

Additional options for BigtableAdmin#projectsInstancesClustersPartialUpdateCluster.

ProjectsInstancesListOptions

Additional options for BigtableAdmin#projectsInstancesList.

ProjectsInstancesPartialUpdateInstanceOptions

Additional options for BigtableAdmin#projectsInstancesPartialUpdateInstance.

ProjectsInstancesTablesAuthorizedViewsCreateOptions

Additional options for BigtableAdmin#projectsInstancesTablesAuthorizedViewsCreate.

ProjectsInstancesTablesAuthorizedViewsDeleteOptions

Additional options for BigtableAdmin#projectsInstancesTablesAuthorizedViewsDelete.

ProjectsInstancesTablesAuthorizedViewsGetOptions

Additional options for BigtableAdmin#projectsInstancesTablesAuthorizedViewsGet.

ProjectsInstancesTablesAuthorizedViewsListOptions

Additional options for BigtableAdmin#projectsInstancesTablesAuthorizedViewsList.

ProjectsInstancesTablesAuthorizedViewsPatchOptions

Additional options for BigtableAdmin#projectsInstancesTablesAuthorizedViewsPatch.

ProjectsInstancesTablesGetOptions

Additional options for BigtableAdmin#projectsInstancesTablesGet.

ProjectsInstancesTablesListOptions

Additional options for BigtableAdmin#projectsInstancesTablesList.

ProjectsInstancesTablesPatchOptions

Additional options for BigtableAdmin#projectsInstancesTablesPatch.

ProjectsLocationsListOptions

Additional options for BigtableAdmin#projectsLocationsList.

RestoreInfo

Information about a table restore.

RestoreTableMetadata

Metadata type for the long-running operation returned by RestoreTable.

RestoreTableRequest

The request for RestoreTable.

SetIamPolicyRequest

Request message for SetIamPolicy method.

SingleClusterRouting

Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.

Split

An initial split point for a newly created table.

StandardIsolation

Standard options for isolating this app profile's traffic from other use cases.

StandardReadRemoteWrites

Checks that all writes before the consistency token was generated are replicated in every cluster and readable.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Table

A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.

TableProgress

Progress info for copying a table's data to the new cluster.

TableStats

Approximate statistics related to a table. These statistics are calculated infrequently, while simultaneously, data in the table can change rapidly. Thus the values reported here (e.g. row count) are very likely out-of date, even the instant they are received in this API. Thus, only treat these values as approximate. IMPORTANT: Everything below is approximate, unless otherwise specified.

TestIamPermissionsRequest

Request message for TestIamPermissions method.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

Type

Type represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each Type includes an Encoding which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like CAST. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, not the decoded type. - Example: STRING values sort in the same order as their UTF-8 encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does not preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). - The overall encoding chain sorts naturally if every link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain is self-delimiting if any link is. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?

UndeleteTableMetadata

Metadata type for the operation returned by google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable.

UndeleteTableRequest

Request message for google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable

Union

A GcRule which deletes cells matching any of the given rules.

UpdateAppProfileMetadata

The metadata for the Operation returned by UpdateAppProfile.

UpdateAuthorizedViewMetadata

Metadata for the google.longrunning.Operation returned by UpdateAuthorizedView.

UpdateAuthorizedViewRequest

The request for UpdateAuthorizedView.

UpdateClusterMetadata

The metadata for the Operation returned by UpdateCluster.

UpdateInstanceMetadata

The metadata for the Operation returned by UpdateInstance.

UpdateTableMetadata

Metadata type for the operation returned by UpdateTable.