AppProfile

AppProfile

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

Constructor

new AppProfile(instance, name)

Parameters:
Name Type Description
instance Instance

The parent instance of this app profile.
name string

Name of the app profile.
Example
```
const {Bigtable} = require('@google-cloud/bigtable');
const bigtable = new Bigtable();
const instance = bigtable.instance('my-instance');
const appProfile = instance.appProfile('my-app-profile');
```

Methods

create(optionsopt)

Create an app profile.

Parameters:
Name Type Attributes Description
options object <optional>

See Instance#createAppProfile.
Example
```
<caption>include:samples/api-reference-doc-snippets/app-profile.js</caption>
region_tag:bigtable_api_create_app_profile
```

delete(optionsopt, callbackopt)

Delete the app profile.

Parameters:
Name Type Attributes Description
options object <optional>

Cluster creation options.

Properties
Name Type Attributes Description
gaxOptions object <optional>

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

Whether to ignore safety checks when deleting the app profile.
callback function <optional>

The callback function.

Properties
Name Type Attributes Description
err error <nullable>

An error returned while making this request.
apiResponse object

The full API response.
Example
```
<caption>include:samples/api-reference-doc-snippets/app-profile.js</caption>
region_tag:bigtable_api_delete_app_profile
```

exists(gaxOptionsopt, callback)

Check if an app profile exists.

Parameters:
Name Type Attributes Description
gaxOptions object <optional>

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

The callback function.

Properties
Name Type Attributes Description
err error <nullable>

An error returned while making this request.
exists boolean

Whether the app profile exists or not.
Example
```
<caption>include:samples/api-reference-doc-snippets/app-profile.js</caption>
region_tag:bigtable_api_exists_app_profile
```

get(gaxOptionsopt)

Get a appProfile if it exists.

Parameters:
Name Type Attributes Description
gaxOptions object <optional>

Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html.
Example
```
<caption>include:samples/api-reference-doc-snippets/app-profile.js</caption>
region_tag:bigtable_api_get_app_profile
```

getMetadata(gaxOptionsopt, callback)

Get the app profile metadata.

Parameters:
Name Type Attributes Description
gaxOptions object <optional>

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

The callback function.

Properties
Name Type Attributes Description
err error <nullable>

An error returned while making this request.
metadata object

The metadata.
apiResponse object

The full API response.
Example
```
<caption>include:samples/api-reference-doc-snippets/app-profile.js</caption>
region_tag:bigtable_api_app_profile_get_meta
```

setMetadata(metadata, gaxOptionsopt, callback)

Set the app profile metadata.

Parameters:
Name Type Attributes Description
metadata object

See Instance#createAppProfile for the available metadata options.
gaxOptions object <optional>

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

The callback function.

Properties
Name Type Attributes Description
err error <nullable>

An error returned while making this request.
apiResponse object

The full API response.
Example
```
<caption>include:samples/api-reference-doc-snippets/app-profile.js</caption>
region_tag:bigtable_api_app_profile_set_meta
```