class

AppProfile

Source: app-profile.js:36

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

Methods

create([options])
delete([options][, callback])
exists([gaxOptions], callback)
get([gaxOptions])
getMetadata([gaxOptions], callback)
setMetadata(metadata[, gaxOptions], callback)

new AppProfile(instance, name)

Example 

const Bigtable = require('@google-cloud/bigtable');
const bigtable = new Bigtable();
const instance = bigtable.instance('my-instance');
const appProfile = instance.appProfile('my-app-profile');

Parameters

Name Type Optional Description

instance

 

 

The parent instance of this app profile.

name

 

 

Name of the app profile.

Methods

create([options])

Create an app profile.

Example

include:samples/document-snippets/app-profile.js

region_tag:bigtable_create_app_profile

Parameter

Name Type Optional Description

options

object

Yes

See Instance#createAppProfile.

delete([options][, callback])

Delete the app profile.

Example

include:samples/document-snippets/app-profile.js

region_tag:bigtable_delete_app_profile

Parameters

Name Type Optional Description

options

object

Yes

Cluster creation options.

Values in options have the following properties:

Name Type Optional Description

gaxOptions

object

Yes

Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.

ignoreWarnings

boolean

Yes

Whether to ignore safety checks when deleting the app profile.

callback

function()

Yes

The callback function.

Values in callback have the following properties:

Name Type Optional Description

err

error

 

An error returned while making this request.

Value can be null.

apiResponse

object

 

The full API response.

exists([gaxOptions], callback)

Check if an app profile exists.

Example

include:samples/document-snippets/app-profile.js

region_tag:bigtable_exists_app_profile

Parameters

Name Type Optional Description

gaxOptions

object

Yes

Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.

callback

function()

 

The callback function.

Values in callback have the following properties:

Name Type Optional Description

err

error

 

An error returned while making this request.

Value can be null.

exists

boolean

 

Whether the app profile exists or not.

get([gaxOptions])

Get a appProfile if it exists.

Example

include:samples/document-snippets/app-profile.js

region_tag:bigtable_get_app_profile

Parameter

Name Type Optional Description

gaxOptions

object

Yes

Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.

getMetadata([gaxOptions], callback)

Get the app profile metadata.

Example

include:samples/document-snippets/app-profile.js

region_tag:bigtable_app_profile_get_meta

Parameters

Name Type Optional Description

gaxOptions

object

Yes

Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.

callback

function()

 

The callback function.

Values in callback have the following properties:

Name Type Optional Description

err

error

 

An error returned while making this request.

Value can be null.

metadata

object

 

The metadata.

apiResponse

object

 

The full API response.

setMetadata(metadata[, gaxOptions], callback)

Set the app profile metadata.

Example

include:samples/document-snippets/app-profile.js

region_tag:bigtable_app_profile_set_meta

Parameters

Name Type Optional Description

metadata

object

 

See Instance#createAppProfile for the available metadata options.

gaxOptions

object

Yes

Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.

callback

function()

 

The callback function.

Values in callback have the following properties:

Name Type Optional Description

err

error

 

An error returned while making this request.

Value can be null.

apiResponse

object

 

The full API response.