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
Name Description
options BigtableOptions

Properties

api

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

AppProfile

  static 
  
 AppProfile 
 : 
  
 AppProfile 
 ; 
 
Property Value
Type Description
AppProfile

appProfileId

  appProfileId 
 ?: 
  
 string 
 ; 
 
Property Value
Type Description
string

auth

  auth 
 : 
  
 GoogleAuth 
 ; 
 
Property Value
Type Description
GoogleAuth

Cluster

  static 
  
 Cluster 
 : 
  
 Cluster 
 ; 
 
Property Value
Type Description
Cluster

customEndpoint

  customEndpoint 
 ?: 
  
 string 
 ; 
 
Property Value
Type Description
string

Instance

  static 
  
 Instance 
 : 
  
 Instance 
 ; 
 
Property Value
Type Description
Instance

options

  options 
 : 
  
 BigtableOptions 
 ; 
 
Property Value
Type Description
BigtableOptions

projectId

  projectId 
 : 
  
 string 
 ; 
 
Property Value
Type Description
string

projectName

  projectName 
 : 
  
 string 
 ; 
 
Property Value
Type Description
string

shouldReplaceProjectIdToken

  shouldReplaceProjectIdToken 
 : 
  
 boolean 
 ; 
 
Property Value
Type Description
boolean

Methods

createInstance(id, options)

  createInstance 
 ( 
 id 
 : 
  
 string 
 , 
  
 options 
 : 
  
 InstanceOptions 
 ) 
 : 
  
 Promise<CreateInstanceResponse> 
 ; 
 
Parameters
Name Description
id string
options InstanceOptions
Returns
Type Description
Promise < CreateInstanceResponse >

createInstance(id, options, callback)

  createInstance 
 ( 
 id 
 : 
  
 string 
 , 
  
 options 
 : 
  
 InstanceOptions 
 , 
  
 callback 
 : 
  
 CreateInstanceCallback 
 ) 
 : 
  
 void 
 ; 
 
Parameters
Name Description
id string
options InstanceOptions
callback CreateInstanceCallback
Returns
Type Description
void

getInstances(gaxOptions)

  getInstances 
 ( 
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<GetInstancesResponse> 
 ; 
 
Parameter
Name Description
gaxOptions CallOptions
Returns
Type Description
Promise < GetInstancesResponse >

getInstances(callback)

  getInstances 
 ( 
 callback 
 : 
  
 GetInstancesCallback 
 ) 
 : 
  
 void 
 ; 
 
Parameter
Name Description
callback GetInstancesCallback
Returns
Type Description
void

getInstances(gaxOptions, callback)

  getInstances 
 ( 
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 GetInstancesCallback 
 ) 
 : 
  
 void 
 ; 
 
Parameters
Name Description
gaxOptions CallOptions
callback GetInstancesCallback
Returns
Type Description
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
Name Description
callback (err: Error | null, projectId?: string) => void

Callback function.

Returns
Type Description
void

instance(name)

  instance 
 ( 
 name 
 : 
  
 string 
 ) 
 : 
  
 Instance 
 ; 
 

Get a reference to a Cloud Bigtable instance.

Parameter
Name Description
name string
Returns
Type Description
Instance

{Instance}

request(config)

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

request(config, callback)

  request<T 
  
 = 
  
 any 
> ( 
 config 
 ?: 
  
 any 
 , 
  
 callback 
 ?: 
  
 RequestCallback<T> 
 ) 
 : 
  
 void 
 ; 
 
Parameters
Name Description
config any
callback RequestCallback <T>
Returns
Type Description
void
Type Parameter
Name Description
T
Create a Mobile Website
View Site in Mobile | Classic
Share by: