Class AppProfile (3.5.4)

Create an app profile object to interact with your app profile.

Package

@google-cloud/bigtable!

Constructors

(constructor)(instance, id)

  constructor 
 ( 
 instance 
 : 
  
 Instance 
 , 
  
 id 
 : 
  
 string 
 );

Constructs a new instance of the AppProfile class

Parameters

Name	Description
instance	`Instance`
id	`string`

Properties

bigtable

  bigtable 
 : 
  
 Bigtable 
 ;

Property Value

Type	Description
Bigtable

id

  id 
 : 
  
 string 
 ;

Property Value

Type	Description
string

instance

  instance 
 : 
  
 Instance 
 ;

Property Value

Type	Description
Instance

metadata

  metadata 
 ?: 
  
 google 
 . 
 bigtable 
 . 
 admin 
 . 
 v2 
 . 
 IAppProfile 
 ;

Property Value

Type	Description
IAppProfile

name

  name 
 : 
  
 string 
 ;

Property Value

Type	Description
string

Methods

create(options)

  create 
 ( 
 options 
 : 
  
 AppProfileOptions 
 ) 
 : 
  
 Promise<CreateAppProfileResponse> 
 ;

Parameter

Name	Description
options	`AppProfileOptions`

Returns

Type	Description
Promise < CreateAppProfileResponse >

create(options, callback)

  create 
 ( 
 options 
 : 
  
 AppProfileOptions 
 , 
  
 callback 
 : 
  
 CreateAppProfileCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
options	`AppProfileOptions`
callback	`CreateAppProfileCallback`

Returns

Type	Description
void

create(callback)

  create 
 ( 
 callback 
 : 
  
 CreateAppProfileCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`CreateAppProfileCallback`

Returns

Type	Description
void

delete(options)

  delete 
 ( 
 options 
 ?: 
  
 DeleteAppProfileOptions 
 ) 
 : 
  
 Promise<DeleteAppProfileResponse> 
 ;

Parameter

Name	Description
options	`DeleteAppProfileOptions`

Returns

Type	Description
Promise < DeleteAppProfileResponse >

delete(options, callback)

  delete 
 ( 
 options 
 : 
  
 DeleteAppProfileOptions 
 , 
  
 callback 
 : 
  
 DeleteAppProfileCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
options	`DeleteAppProfileOptions`
callback	`DeleteAppProfileCallback`

Returns

Type	Description
void

delete(callback)

  delete 
 ( 
 callback 
 : 
  
 DeleteAppProfileCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`DeleteAppProfileCallback`

Returns

Type	Description
void

exists(options)

  exists 
 ( 
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<AppProfileExistsResponse> 
 ;

Parameter

Name	Description
options	`CallOptions`

Returns

Type	Description
Promise < AppProfileExistsResponse >

exists(options, callback)

  exists 
 ( 
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 AppProfileExistsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
options	`CallOptions`
callback	`AppProfileExistsCallback`

Returns

Type	Description
void

exists(callback)

  exists 
 ( 
 callback 
 : 
  
 AppProfileExistsCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`AppProfileExistsCallback`

Returns

Type	Description
void

formatAppProfile_(options)

  static 
  
 formatAppProfile_ 
 ( 
 options 
 : 
  
 AppProfileOptions 
 ) 
 : 
  
 google 
 . 
 bigtable 
 . 
 admin 
 . 
 v2 
 . 
 IAppProfile 
 ;

Formats a app profile options object into proto format.

Parameter

Name	Description
options	`AppProfileOptions` The options object.

Returns

Type	Description
IAppProfile	{object}

get(options)

  get 
 ( 
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<GetAppProfileResponse> 
 ;

Parameter

Name	Description
options	`CallOptions`

Returns

Type	Description
Promise < GetAppProfileResponse >

get(options, callback)

  get 
 ( 
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 GetAppProfileCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
options	`CallOptions`
callback	`GetAppProfileCallback`

Returns

Type	Description
void

get(callback)

  get 
 ( 
 callback 
 : 
  
 GetAppProfileCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`GetAppProfileCallback`

Returns

Type	Description
void

getMetadata(options)

  getMetadata 
 ( 
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<GetAppProfileMetadataResponse> 
 ;

Parameter

Name	Description
options	`CallOptions`

Returns

Type	Description
Promise < GetAppProfileMetadataResponse >

getMetadata(options, callback)

  getMetadata 
 ( 
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 GetAppProfileMetadataCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
options	`CallOptions`
callback	`GetAppProfileMetadataCallback`

Returns

Type	Description
void

getMetadata(callback)

  getMetadata 
 ( 
 callback 
 : 
  
 GetAppProfileMetadataCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`GetAppProfileMetadataCallback`

Returns

Type	Description
void

setMetadata(metadata, options)

  setMetadata 
 ( 
 metadata 
 : 
  
 AppProfileOptions 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<SetAppProfileMetadataResponse> 
 ;

Parameters

Name	Description
metadata	`AppProfileOptions`
options	`CallOptions`

Returns

Type	Description
Promise < SetAppProfileMetadataResponse >

setMetadata(metadata, options, callback)

  setMetadata 
 ( 
 metadata 
 : 
  
 AppProfileOptions 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 SetAppProfileMetadataCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
metadata	`AppProfileOptions`
options	`CallOptions`
callback	`SetAppProfileMetadataCallback`

Returns

Type	Description
void

setMetadata(metadata, callback)

  setMetadata 
 ( 
 metadata 
 : 
  
 AppProfileOptions 
 , 
  
 callback 
 : 
  
 SetAppProfileMetadataCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
metadata	`AppProfileOptions`
callback	`SetAppProfileMetadataCallback`

Returns

Type	Description
void

Class AppProfile (3.5.4) Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(instance, id)

Properties

bigtable

id

instance

metadata

name

Methods

create(options)

create(options, callback)

create(callback)

delete(options)

delete(options, callback)

delete(callback)

exists(options)

exists(options, callback)

exists(callback)

formatAppProfile_(options)

get(options)

get(options, callback)

get(callback)

getMetadata(options)

getMetadata(options, callback)

getMetadata(callback)

setMetadata(metadata, options)

setMetadata(metadata, options, callback)

setMetadata(metadata, callback)

Class AppProfile (3.5.4)