Class AppProfile (5.0.0)

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

Package

Example


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

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;

id

id: string;

instance

instance: Instance;

metadata

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

name

name: 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}

Example


// Any cluster routing:
Family.formatAppProfile_({
  routing: 'any',
  description: 'My App Profile',
});
// {
//   multiClusterRoutingUseAny: {},
//   description: 'My App Profile',
// }

// Single cluster routing:
const cluster = myInstance.cluster('my-cluster');
Family.formatAppProfile_({
  routing: cluster,
  allowTransactionalWrites: true,
  description: 'My App Profile',
});
// {
//   singleClusterRouting: {
//     clusterId: 'my-cluster',
//     allowTransactionalWrites: true,
//   },
//   description: 'My App Profile',
// }

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`