@google-cloud/bigtable
Version:
Cloud Bigtable Client Library for Node.js
1,066 lines (1,065 loc) • 123 kB
JavaScript
"use strict";
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ** This file is automatically generated by gapic-generator-typescript. **
// ** https://github.com/googleapis/gapic-generator-typescript **
// ** All changes to this file may be overwritten. **
Object.defineProperty(exports, "__esModule", { value: true });
exports.BigtableTableAdminClient = void 0;
const jsonProtos = require("../../protos/protos.json");
const google_gax_1 = require("google-gax");
/**
* Client JSON configuration object, loaded from
* `src/v2/bigtable_table_admin_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
const gapicConfig = require("./bigtable_table_admin_client_config.json");
const version = require('../../../package.json').version;
/**
* Service for creating, configuring, and deleting Cloud Bigtable tables.
*
*
* Provides access to the table schemas only, not the data stored within
* the tables.
* @class
* @memberof v2
*/
class BigtableTableAdminClient {
_terminated = false;
_opts;
_providedCustomServicePath;
_gaxModule;
_gaxGrpc;
_protos;
_defaults;
_universeDomain;
_servicePath;
_log = google_gax_1.loggingUtils.log('bigtable');
auth;
descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn;
innerApiCalls;
pathTemplates;
operationsClient;
bigtableTableAdminStub;
/**
* Construct an instance of BigtableTableAdminClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new BigtableTableAdminClient({fallback: true}, gax);
* ```
*/
constructor(opts, gaxInstance) {
// Ensure that options include all the required fields.
const staticMembers = this.constructor;
if (opts?.universe_domain &&
opts?.universeDomain &&
opts?.universe_domain !== opts?.universeDomain) {
throw new Error('Please set either universe_domain or universeDomain, but not both.');
}
const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
: undefined;
this._universeDomain =
opts?.universeDomain ??
opts?.universe_domain ??
universeDomainEnvVar ??
'googleapis.com';
this._servicePath = 'bigtableadmin.' + this._universeDomain;
const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
const port = opts?.port || staticMembers.port;
const clientConfig = opts?.clientConfig ?? {};
const fallback = opts?.fallback ??
(typeof window !== 'undefined' && typeof window?.fetch === 'function');
opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
// Request numeric enum values if REST transport is used.
opts.numericEnums = true;
// If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
if (servicePath !== this._servicePath && !('scopes' in opts)) {
opts['scopes'] = staticMembers.scopes;
}
// Load google-gax module synchronously if needed
if (!gaxInstance) {
gaxInstance = require('google-gax');
}
// Choose either gRPC or proto-over-HTTP implementation of google-gax.
this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
// Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
// Save options to use in initialize() method.
this._opts = opts;
// Save the auth object to the client, for use by other methods.
this.auth = this._gaxGrpc.auth;
// Set useJWTAccessWithScope on the auth object.
this.auth.useJWTAccessWithScope = true;
// Set defaultServicePath on the auth object.
this.auth.defaultServicePath = this._servicePath;
// Set the default scopes in auth client if needed.
if (servicePath === this._servicePath) {
this.auth.defaultScopes = staticMembers.scopes;
}
// Determine the client header string.
const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
if (typeof process === 'object' && 'versions' in process) {
clientHeader.push(`gl-node/${process.versions.node}`);
}
else {
clientHeader.push(`gl-web/${this._gaxModule.version}`);
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
}
else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
clientHeader.push(`${opts.libName}/${opts.libVersion}`);
}
// Load the applicable protos.
this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
// This API contains "path templates"; forward-slash-separated
// identifiers to uniquely identify resources within the API.
// Create useful helper objects for these.
this.pathTemplates = {
appProfilePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/instances/{instance}/appProfiles/{app_profile}'),
authorizedViewPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}'),
backupPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}'),
clusterPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/instances/{instance}/clusters/{cluster}'),
hotTabletPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/{hot_tablet}'),
instancePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/instances/{instance}'),
logicalViewPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/instances/{instance}/logicalViews/{logical_view}'),
materializedViewPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/instances/{instance}/materializedViews/{materialized_view}'),
projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
snapshotPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}'),
tablePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/instances/{instance}/tables/{table}'),
};
// Some of the methods on this service return "paged" results,
// (e.g. 50 results at a time, with tokens to get subsequent
// pages). Denote the keys used for pagination and results.
this.descriptors.page = {
listTables: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'tables'),
listAuthorizedViews: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'authorizedViews'),
listSnapshots: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'snapshots'),
listBackups: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'backups'),
};
const protoFilesRoot = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
// This API contains "long-running operations", which return a
// an Operation object that allows for tracking of the operation,
// rather than holding a request open.
const lroOptions = {
auth: this.auth,
grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined,
};
if (opts.fallback) {
lroOptions.protoJson = protoFilesRoot;
lroOptions.httpRules = [
{
selector: 'google.longrunning.Operations.CancelOperation',
post: '/v2/{name=operations/**}:cancel',
},
{
selector: 'google.longrunning.Operations.DeleteOperation',
delete: '/v2/{name=operations/**}',
},
{
selector: 'google.longrunning.Operations.GetOperation',
get: '/v2/{name=operations/**}',
},
{
selector: 'google.longrunning.Operations.ListOperations',
get: '/v2/{name=operations/projects/**}/operations',
},
];
}
this.operationsClient = this._gaxModule
.lro(lroOptions)
.operationsClient(opts);
const createTableFromSnapshotResponse = protoFilesRoot.lookup('.google.bigtable.admin.v2.Table');
const createTableFromSnapshotMetadata = protoFilesRoot.lookup('.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata');
const updateTableResponse = protoFilesRoot.lookup('.google.bigtable.admin.v2.Table');
const updateTableMetadata = protoFilesRoot.lookup('.google.bigtable.admin.v2.UpdateTableMetadata');
const undeleteTableResponse = protoFilesRoot.lookup('.google.bigtable.admin.v2.Table');
const undeleteTableMetadata = protoFilesRoot.lookup('.google.bigtable.admin.v2.UndeleteTableMetadata');
const createAuthorizedViewResponse = protoFilesRoot.lookup('.google.bigtable.admin.v2.AuthorizedView');
const createAuthorizedViewMetadata = protoFilesRoot.lookup('.google.bigtable.admin.v2.CreateAuthorizedViewMetadata');
const updateAuthorizedViewResponse = protoFilesRoot.lookup('.google.bigtable.admin.v2.AuthorizedView');
const updateAuthorizedViewMetadata = protoFilesRoot.lookup('.google.bigtable.admin.v2.UpdateAuthorizedViewMetadata');
const snapshotTableResponse = protoFilesRoot.lookup('.google.bigtable.admin.v2.Snapshot');
const snapshotTableMetadata = protoFilesRoot.lookup('.google.bigtable.admin.v2.SnapshotTableMetadata');
const createBackupResponse = protoFilesRoot.lookup('.google.bigtable.admin.v2.Backup');
const createBackupMetadata = protoFilesRoot.lookup('.google.bigtable.admin.v2.CreateBackupMetadata');
const restoreTableResponse = protoFilesRoot.lookup('.google.bigtable.admin.v2.Table');
const restoreTableMetadata = protoFilesRoot.lookup('.google.bigtable.admin.v2.RestoreTableMetadata');
const copyBackupResponse = protoFilesRoot.lookup('.google.bigtable.admin.v2.Backup');
const copyBackupMetadata = protoFilesRoot.lookup('.google.bigtable.admin.v2.CopyBackupMetadata');
this.descriptors.longrunning = {
createTableFromSnapshot: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createTableFromSnapshotResponse.decode.bind(createTableFromSnapshotResponse), createTableFromSnapshotMetadata.decode.bind(createTableFromSnapshotMetadata)),
updateTable: new this._gaxModule.LongrunningDescriptor(this.operationsClient, updateTableResponse.decode.bind(updateTableResponse), updateTableMetadata.decode.bind(updateTableMetadata)),
undeleteTable: new this._gaxModule.LongrunningDescriptor(this.operationsClient, undeleteTableResponse.decode.bind(undeleteTableResponse), undeleteTableMetadata.decode.bind(undeleteTableMetadata)),
createAuthorizedView: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createAuthorizedViewResponse.decode.bind(createAuthorizedViewResponse), createAuthorizedViewMetadata.decode.bind(createAuthorizedViewMetadata)),
updateAuthorizedView: new this._gaxModule.LongrunningDescriptor(this.operationsClient, updateAuthorizedViewResponse.decode.bind(updateAuthorizedViewResponse), updateAuthorizedViewMetadata.decode.bind(updateAuthorizedViewMetadata)),
snapshotTable: new this._gaxModule.LongrunningDescriptor(this.operationsClient, snapshotTableResponse.decode.bind(snapshotTableResponse), snapshotTableMetadata.decode.bind(snapshotTableMetadata)),
createBackup: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createBackupResponse.decode.bind(createBackupResponse), createBackupMetadata.decode.bind(createBackupMetadata)),
restoreTable: new this._gaxModule.LongrunningDescriptor(this.operationsClient, restoreTableResponse.decode.bind(restoreTableResponse), restoreTableMetadata.decode.bind(restoreTableMetadata)),
copyBackup: new this._gaxModule.LongrunningDescriptor(this.operationsClient, copyBackupResponse.decode.bind(copyBackupResponse), copyBackupMetadata.decode.bind(copyBackupMetadata)),
};
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings('google.bigtable.admin.v2.BigtableTableAdmin', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
// Set up a dictionary of "inner API calls"; the core implementation
// of calling the API is handled in `google-gax`, with this code
// merely providing the destination and request information.
this.innerApiCalls = {};
// Add a warn function to the client constructor so it can be easily tested.
this.warn = this._gaxModule.warn;
}
/**
* Initialize the client.
* Performs asynchronous operations (such as authentication) and prepares the client.
* This function will be called automatically when any class method is called for the
* first time, but if you need to initialize it before calling an actual method,
* feel free to call initialize() directly.
*
* You can await on this method if you want to make sure the client is initialized.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize() {
// If the client stub promise is already initialized, return immediately.
if (this.bigtableTableAdminStub) {
return this.bigtableTableAdminStub;
}
// Put together the "service stub" for
// google.bigtable.admin.v2.BigtableTableAdmin.
this.bigtableTableAdminStub = this._gaxGrpc.createStub(this._opts.fallback
? this._protos.lookupService('google.bigtable.admin.v2.BigtableTableAdmin')
: // eslint-disable-next-line @typescript-eslint/no-explicit-any
this._protos.google.bigtable.admin.v2.BigtableTableAdmin, this._opts, this._providedCustomServicePath);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const bigtableTableAdminStubMethods = [
'createTable',
'createTableFromSnapshot',
'listTables',
'getTable',
'updateTable',
'deleteTable',
'undeleteTable',
'createAuthorizedView',
'listAuthorizedViews',
'getAuthorizedView',
'updateAuthorizedView',
'deleteAuthorizedView',
'modifyColumnFamilies',
'dropRowRange',
'generateConsistencyToken',
'checkConsistency',
'snapshotTable',
'getSnapshot',
'listSnapshots',
'deleteSnapshot',
'createBackup',
'getBackup',
'updateBackup',
'deleteBackup',
'listBackups',
'restoreTable',
'copyBackup',
'getIamPolicy',
'setIamPolicy',
'testIamPermissions',
];
for (const methodName of bigtableTableAdminStubMethods) {
const callPromise = this.bigtableTableAdminStub.then(stub => (...args) => {
if (this._terminated) {
return Promise.reject('The client has already been closed.');
}
const func = stub[methodName];
return func.apply(stub, args);
}, (err) => () => {
throw err;
});
const descriptor = this.descriptors.page[methodName] ||
this.descriptors.longrunning[methodName] ||
undefined;
const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
this.innerApiCalls[methodName] = apiCall;
}
return this.bigtableTableAdminStub;
}
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath() {
if (typeof process === 'object' &&
typeof process.emitWarning === 'function') {
process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'bigtableadmin.googleapis.com';
}
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint() {
if (typeof process === 'object' &&
typeof process.emitWarning === 'function') {
process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'bigtableadmin.googleapis.com';
}
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint() {
return this._servicePath;
}
get universeDomain() {
return this._universeDomain;
}
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port() {
return 443;
}
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes() {
return [
'https://www.googleapis.com/auth/bigtable.admin',
'https://www.googleapis.com/auth/bigtable.admin.table',
'https://www.googleapis.com/auth/cloud-bigtable.admin',
'https://www.googleapis.com/auth/cloud-bigtable.admin.table',
'https://www.googleapis.com/auth/cloud-platform',
'https://www.googleapis.com/auth/cloud-platform.read-only',
];
}
/**
* Return the project ID used by this class.
* @returns {Promise} A promise that resolves to string containing the project ID.
*/
getProjectId(callback) {
if (callback) {
this.auth.getProjectId(callback);
return;
}
return this.auth.getProjectId();
}
createTable(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
parent: request.parent ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('createTable request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('createTable response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.createTable(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('createTable response %j', response);
return [response, options, rawResponse];
});
}
getTable(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('getTable request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getTable response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.getTable(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getTable response %j', response);
return [response, options, rawResponse];
});
}
deleteTable(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('deleteTable request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('deleteTable response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.deleteTable(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('deleteTable response %j', response);
return [response, options, rawResponse];
});
}
getAuthorizedView(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('getAuthorizedView request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getAuthorizedView response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.getAuthorizedView(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getAuthorizedView response %j', response);
return [response, options, rawResponse];
});
}
deleteAuthorizedView(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('deleteAuthorizedView request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('deleteAuthorizedView response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.deleteAuthorizedView(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('deleteAuthorizedView response %j', response);
return [response, options, rawResponse];
});
}
modifyColumnFamilies(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('modifyColumnFamilies request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('modifyColumnFamilies response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.modifyColumnFamilies(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('modifyColumnFamilies response %j', response);
return [response, options, rawResponse];
});
}
dropRowRange(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('dropRowRange request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('dropRowRange response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.dropRowRange(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('dropRowRange response %j', response);
return [response, options, rawResponse];
});
}
generateConsistencyToken(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('generateConsistencyToken request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('generateConsistencyToken response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.generateConsistencyToken(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('generateConsistencyToken response %j', response);
return [response, options, rawResponse];
});
}
checkConsistency(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('checkConsistency request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('checkConsistency response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.checkConsistency(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('checkConsistency response %j', response);
return [response, options, rawResponse];
});
}
getSnapshot(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('getSnapshot request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getSnapshot response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.getSnapshot(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getSnapshot response %j', response);
return [response, options, rawResponse];
});
}
deleteSnapshot(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('deleteSnapshot request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('deleteSnapshot response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.deleteSnapshot(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('deleteSnapshot response %j', response);
return [response, options, rawResponse];
});
}
getBackup(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('getBackup request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getBackup response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.getBackup(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getBackup response %j', response);
return [response, options, rawResponse];
});
}
updateBackup(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
'backup.name': request.backup.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('updateBackup request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('updateBackup response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.updateBackup(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('updateBackup response %j', response);
return [response, options, rawResponse];
});
}
deleteBackup(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('deleteBackup request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('deleteBackup response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.deleteBackup(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('deleteBackup response %j', response);
return [response, options, rawResponse];
});
}
getIamPolicy(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
resource: request.resource ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('getIamPolicy request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getIamPolicy response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.getIamPolicy(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getIamPolicy response %j', response);
return [response, options, rawResponse];
});
}
setIamPolicy(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
resource: request.resource ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('setIamPolicy request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('setIamPolicy response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.setIamPolicy(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('setIamPolicy response %j', response);
return [response, options, rawResponse];
});
}
testIamPermissions(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
resource: request.resource ?? '',
});
this.initialize().catch(err => {
throw err;
});
this._log.info('testIamPermissions request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('testIamPermissions response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.testIamPermissions(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('testIamPermissions response %j', response);
return [response, options, rawResponse];
});
}
createTableFromSnapshot(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
parent: request.parent ?? '',
});
this.initialize().catch(err => {
throw err;
});
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('createTableFromSnapshot response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('createTableFromSnapshot request %j', request);
return this.innerApiCalls
.createTableFromSnapshot(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('createTableFromSnapshot response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `createTableFromSnapshot()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2/bigtable_table_admin.create_table_from_snapshot.js</caption>
* region_tag:bigtableadmin_v2_generated_BigtableTableAdmin_CreateTableFromSnapshot_async
*/
async checkCreateTableFromSnapshotProgress(name) {
this._log.info('createTableFromSnapshot long-running');
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
const [operation] = await this.operationsClient.getOperation(request);
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.createTableFromSnapshot, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
updateTable(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
'table.name': request.table.name ?? '',
});
this.initialize().catch(err => {
throw err;
});
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('updateTable response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('updateTable request %j', request);
return this.innerApiCalls
.updateTable(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {