Class Bigtable (3.6.0)
Stay organized with collections
Save and categorize content based on your preferences.
Package
@google-cloud/bigtable!
Constructors
(constructor)(options)
constructor(options?: BigtableOptions);
Constructs a new instance of the Bigtable class
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
appProfileId
Property Value
auth
Property Value
| Type | Description |
| GoogleAuth | |
Cluster
Property Value
customEndpoint
Property Value
Instance
static Instance: Instance;
Property Value
options
options: BigtableOptions;
Property Value
projectId
Property Value
projectName
Property Value
shouldReplaceProjectIdToken
shouldReplaceProjectIdToken: boolean;
Property Value
Methods
createInstance(id, options)
createInstance(id: string, options: InstanceOptions): Promise<CreateInstanceResponse>;
Parameters
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
getInstances(gaxOptions)
getInstances(gaxOptions?: CallOptions): Promise<GetInstancesResponse>;
Parameter
| Name | Description |
| gaxOptions |
CallOptions
|
Returns
| Type | Description |
| Promise<GetInstancesResponse> | |
getInstances(callback)
getInstances(callback: GetInstancesCallback): void;
Parameter
Returns
getInstances(gaxOptions, callback)
getInstances(gaxOptions: CallOptions, callback: GetInstancesCallback): void;
Parameters
Returns
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.
| Name | Description |
| callback |
(err: Error | null, projectId?: string) => void
Callback function.
|
Returns
instance(name)
instance(name: string): Instance;
Get a reference to a Cloud Bigtable instance.
| Name | Description |
| name |
string
|
Returns
request(config)
request<T = any>(config?: any): AbortableDuplex;
Parameter
| Name | Description |
| config |
any
|
Returns
Type Parameter
request(config, callback)
request<T = any>(config?: any, callback?: RequestCallback<T>): void;
Parameters
| Name | Description |
| config |
any
|
| callback |
RequestCallback<T>
|
Returns
Type Parameter
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-03-16 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
