Send feedback
Class Cluster (3.6.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.6.0 keyboard_arrow_down
Create a cluster object to interact with your cluster.
Package
@google-cloud/bigtable!
Constructors
(constructor)(instance, id)
constructor ( instance : Instance , id : string );
Constructs a new instance of the Cluster
class
Parameters
Name
Description
instance
Instance
id
string
Properties
bigtable
Property Value
id
Property Value
instance
Property Value
Property Value
Type
Description
ICluster
name
Property Value
Methods
backup(id)
backup ( id : string ) : Backup ;
Get a reference to a Bigtable Cluster.
Parameter
Name
Description
id
string
The backup name or id.
Returns
Type
Description
Backup
{Backup}
create()
create () : Promise<CreateClusterResponse> ;
Returns
Type
Description
Promise <CreateClusterResponse >
create(options)
create ( options : CreateClusterOptions ) : Promise<CreateClusterResponse> ;
Parameter
Returns
Type
Description
Promise <CreateClusterResponse >
create(callback)
create ( callback : CreateClusterCallback ) : void ;
Parameter
Name
Description
callback
CreateClusterCallback
Returns
create(options, callback)
create ( options : CreateClusterOptions , callback : CreateClusterCallback ) : void ;
Parameters
Returns
createBackup(id, config)
createBackup ( id : string , config : CreateBackupConfig ) : Promise<CreateBackupResponse> ;
Parameters
Name
Description
id
string
config
CreateBackupConfig
Returns
Type
Description
Promise <CreateBackupResponse >
createBackup(id, config, callback)
createBackup ( id : string , config : CreateBackupConfig , callback : CreateBackupCallback ) : void ;
Parameters
Name
Description
id
string
config
CreateBackupConfig
callback
CreateBackupCallback
Returns
delete()
delete () : Promise<ApiResponse> ;
Returns
Type
Description
Promise <ApiResponse >
delete(gaxOptions)
delete ( gaxOptions : CallOptions ) : Promise<ApiResponse> ;
Parameter
Name
Description
gaxOptions
CallOptions
Returns
Type
Description
Promise <ApiResponse >
delete(callback)
delete ( callback : DeleteClusterCallback ) : void ;
Parameter
Name
Description
callback
DeleteClusterCallback
Returns
delete(gaxOptions, callback)
delete ( gaxOptions : CallOptions , callback : DeleteClusterCallback ) : void ;
Parameters
Name
Description
gaxOptions
CallOptions
callback
DeleteClusterCallback
Returns
exists()
exists () : Promise<BooleanResponse> ;
Returns
Type
Description
Promise <BooleanResponse >
exists(gaxOptions)
exists ( gaxOptions : CallOptions ) : Promise<BooleanResponse> ;
Parameter
Name
Description
gaxOptions
CallOptions
Returns
Type
Description
Promise <BooleanResponse >
exists(callback)
exists ( callback : ExistsClusterCallback ) : void ;
Parameter
Name
Description
callback
ExistsClusterCallback
Returns
exists(gaxOptions, callback)
exists ( gaxOptions : CallOptions , callback : ExistsClusterCallback ) : void ;
Parameters
Name
Description
gaxOptions
CallOptions
callback
ExistsClusterCallback
Returns
get()
get () : Promise<GetClusterResponse> ;
Returns
Type
Description
Promise <GetClusterResponse >
get(gaxOptions)
get ( gaxOptions : CallOptions ) : Promise<GetClusterResponse> ;
Parameter
Name
Description
gaxOptions
CallOptions
Returns
Type
Description
Promise <GetClusterResponse >
get(callback)
get ( callback : GetClusterCallback ) : void ;
Parameter
Name
Description
callback
GetClusterCallback
Returns
get(gaxOptions, callback)
get ( gaxOptions : CallOptions , callback : GetClusterCallback ) : void ;
Parameters
Name
Description
gaxOptions
CallOptions
callback
GetClusterCallback
Returns
getBackups(options)
getBackups ( options ?: GetBackupsOptions ) : Promise<GetBackupsResponse> ;
Parameter
Returns
Type
Description
Promise <GetBackupsResponse >
getBackups(options, callback)
getBackups ( options : GetBackupsOptions , callback : GetBackupsCallback ) : void ;
Parameters
Returns
getBackups(callback)
getBackups ( callback : GetBackupsCallback ) : void ;
Parameter
Name
Description
callback
GetBackupsCallback
Returns
getBackupsStream(options)
getBackupsStream ( options ?: GetBackupsOptions ) : NodeJS . ReadableStream ;
Lists Cloud Bigtable backups within this cluster. Provides both completed and pending backups as a readable object stream.
Parameter
Name
Description
options
GetBackupsOptions
Configuration object. See for a complete list of options.
Returns
Type
Description
NodeJS.ReadableStream
{ReadableStream
getLocation_(project, location)
static getLocation_ ( project : string , location : string ) : string ;
Parameters
Name
Description
project
string
The project ID.
location
string
The zone location.
Returns
Type
Description
string
{string}
getMetadata () : Promise<GetClusterMetadataResponse> ;
Returns
Type
Description
Promise <GetClusterMetadataResponse >
getMetadata ( gaxOptions : CallOptions ) : Promise<GetClusterMetadataResponse> ;
Parameter
Name
Description
gaxOptions
CallOptions
Returns
Type
Description
Promise <GetClusterMetadataResponse >
getMetadata ( callback : GetClusterMetadataCallback ) : void ;
Parameter
Name
Description
callback
GetClusterMetadataCallback
Returns
getMetadata ( gaxOptions : CallOptions , callback : GetClusterMetadataCallback ) : void ;
Parameters
Name
Description
gaxOptions
CallOptions
callback
GetClusterMetadataCallback
Returns
getStorageType_(type)
static getStorageType_ ( type : string ) : number ;
Maps the storage type to the proper integer.
Parameter
Name
Description
type
string
The storage type (hdd, ssd).
Returns
Type
Description
number
{number}
setMetadata ( metadata : SetClusterMetadataOptions , gaxOptions ?: CallOptions ) : Promise<SetClusterMetadataResponse> ;
Parameters
Name
Description
metadata
SetClusterMetadataOptions
gaxOptions
CallOptions
Returns
Type
Description
Promise <SetClusterMetadataResponse >
setMetadata ( metadata : SetClusterMetadataOptions , callback : SetClusterMetadataCallback ) : void ;
Parameters
Name
Description
metadata
SetClusterMetadataOptions
callback
SetClusterMetadataCallback
Returns
setMetadata ( metadata : SetClusterMetadataOptions , gaxOptions : CallOptions , callback : SetClusterMetadataCallback ) : void ;
Parameters
Name
Description
metadata
SetClusterMetadataOptions
gaxOptions
CallOptions
callback
SetClusterMetadataCallback
Returns
Send feedback
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 2025-05-02 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-02 UTC."],[],[]]