Class Bigtable (3.5.4)

[Creating a Cloud Bigtable Cluster]https://cloud.google.com/bigtable/docs/creating-instance [Cloud Bigtable Concepts Overview]https://cloud.google.com/bigtable/docs/concepts

Package

@google-cloud/bigtable!

Constructors

(constructor)(options)

constructor(options?: BigtableOptions);

Constructs a new instance of the Bigtable class

Parameter
NameDescription
options BigtableOptions

Properties

api

api: {
        [index: string]: v2.BigtableClient | v2.BigtableInstanceAdminClient | v2.BigtableTableAdminClient;
    };
Property Value
TypeDescription
{ [index: string]: v2.BigtableClient | v2.BigtableInstanceAdminClient | v2.BigtableTableAdminClient; }

AppProfile

static AppProfile: AppProfile;
Property Value
TypeDescription
AppProfile

appProfileId

appProfileId?: string;
Property Value
TypeDescription
string

auth

auth: GoogleAuth;
Property Value
TypeDescription
GoogleAuth

Cluster

static Cluster: Cluster;
Property Value
TypeDescription
Cluster

customEndpoint

customEndpoint?: string;
Property Value
TypeDescription
string

Instance

static Instance: Instance;
Property Value
TypeDescription
Instance

options

options: BigtableOptions;
Property Value
TypeDescription
BigtableOptions

projectId

projectId: string;
Property Value
TypeDescription
string

projectName

projectName: string;
Property Value
TypeDescription
string

shouldReplaceProjectIdToken

shouldReplaceProjectIdToken: boolean;
Property Value
TypeDescription
boolean

Methods

createInstance(id, options)

createInstance(id: string, options: InstanceOptions): Promise<CreateInstanceResponse>;
Parameters
NameDescription
id string
options InstanceOptions
Returns
TypeDescription
Promise<CreateInstanceResponse>

createInstance(id, options, callback)

createInstance(id: string, options: InstanceOptions, callback: CreateInstanceCallback): void;
Parameters
NameDescription
id string
options InstanceOptions
callback CreateInstanceCallback
Returns
TypeDescription
void

getInstances(gaxOptions)

getInstances(gaxOptions?: CallOptions): Promise<GetInstancesResponse>;
Parameter
NameDescription
gaxOptions CallOptions
Returns
TypeDescription
Promise<GetInstancesResponse>

getInstances(callback)

getInstances(callback: GetInstancesCallback): void;
Parameter
NameDescription
callback GetInstancesCallback
Returns
TypeDescription
void

getInstances(gaxOptions, callback)

getInstances(gaxOptions: CallOptions, callback: GetInstancesCallback): void;
Parameters
NameDescription
gaxOptions CallOptions
callback GetInstancesCallback
Returns
TypeDescription
void

getProjectId_(callback)

getProjectId_(callback: (err: Error | null, projectId?: string) => void): void;

Determine and localize the project ID. If a user provides an ID, we bypass checking with the auth client for an ID.

Parameter
NameDescription
callback (err: Error | null, projectId?: string) => void

Callback function.

Returns
TypeDescription
void

instance(name)

instance(name: string): Instance;

Get a reference to a Cloud Bigtable instance.

Parameter
NameDescription
name string
Returns
TypeDescription
Instance

{Instance}

request(config)

request<T = any>(config?: any): AbortableDuplex;
Parameter
NameDescription
config any
Returns
TypeDescription
AbortableDuplex
Type Parameter
NameDescription
T

request(config, callback)

request<T = any>(config?: any, callback?: RequestCallback<T>): void;
Parameters
NameDescription
config any
callback RequestCallback<T>
Returns
TypeDescription
void
Type Parameter
NameDescription
T