npm package: @maxim_mazurok/gapi.client.bigtableadmin
Description: TypeScript typings for Cloud Bigtable Admin API v2
Author: Maxim Mazurok
Latest version: 2.0.20220725

# TypeScript typings for Cloud Bigtable Admin API v2

Administer your Cloud Bigtable tables and instances.
For detailed description please check [documentation](https://cloud.google.com/bigtable/).

## Installing

Install typings for Cloud Bigtable Admin API:

```
npm install @types/gapi.client.bigtableadmin@v2 --save-dev
```

## Usage

You need to initialize Google API client in your code:

```typescript
gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});
```

Then load api client wrapper:

```typescript
gapi.client.load('bigtableadmin', 'v2', () => {
  // now we can use gapi.client.bigtableadmin
  // ...
});
```

Don't forget to authenticate your client before sending any request to resources:

```typescript
// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [ 
      // Administer your Cloud Bigtable tables and clusters
      'https://www.googleapis.com/auth/bigtable.admin',

      // Administer your Cloud Bigtable clusters
      'https://www.googleapis.com/auth/bigtable.admin.cluster',

      // Administer your Cloud Bigtable clusters
      'https://www.googleapis.com/auth/bigtable.admin.instance',

      // Administer your Cloud Bigtable tables
      'https://www.googleapis.com/auth/bigtable.admin.table',

      // Administer your Cloud Bigtable tables and clusters
      'https://www.googleapis.com/auth/cloud-bigtable.admin',

      // Administer your Cloud Bigtable clusters
      'https://www.googleapis.com/auth/cloud-bigtable.admin.cluster',

      // Administer your Cloud Bigtable tables
      'https://www.googleapis.com/auth/cloud-bigtable.admin.table',

      // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
      'https://www.googleapis.com/auth/cloud-platform',

      // View your data across Google Cloud services and see the email address of your Google Account
      'https://www.googleapis.com/auth/cloud-platform.read-only',
    ],
    immediate = true;
// ...

gapi.auth.authorize(
  { client_id: client_id, scope: scope, immediate: immediate },
  authResult => {
    if (authResult && !authResult.error) {
        /* handle successful authorization */
    } else {
        /* handle authorization error */
    }
});
```

After that you can use Cloud Bigtable Admin API resources:

```typescript

/*
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
*/
await gapi.client.bigtableadmin.operations.cancel({ name: "name",  });

/*
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
*/
await gapi.client.bigtableadmin.operations.delete({ name: "name",  });

/*
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
*/
await gapi.client.bigtableadmin.operations.get({ name: "name",  });
```