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
Property Value
id
Property Value
instance
Property Value
metadata?: google.bigtable.admin.v2.IAppProfile;
Property Value
Type | Description |
IAppProfile | |
name
Property Value
Methods
create(options)
create(options: AppProfileOptions): Promise<CreateAppProfileResponse>;
Parameter
Returns
Type | Description |
Promise<CreateAppProfileResponse> | |
create(options, callback)
create(options: AppProfileOptions, callback: CreateAppProfileCallback): void;
Parameters
Returns
create(callback)
create(callback: CreateAppProfileCallback): void;
Parameter
Name | Description |
callback |
CreateAppProfileCallback
|
Returns
delete(options)
delete(options?: DeleteAppProfileOptions): Promise<DeleteAppProfileResponse>;
Parameter
Returns
Type | Description |
Promise<DeleteAppProfileResponse> | |
delete(options, callback)
delete(options: DeleteAppProfileOptions, callback: DeleteAppProfileCallback): void;
Parameters
Returns
delete(callback)
delete(callback: DeleteAppProfileCallback): void;
Parameter
Name | Description |
callback |
DeleteAppProfileCallback
|
Returns
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
exists(callback)
exists(callback: AppProfileExistsCallback): void;
Parameter
Name | Description |
callback |
AppProfileExistsCallback
|
Returns
static formatAppProfile_(options: AppProfileOptions): google.bigtable.admin.v2.IAppProfile;
Formats a app profile options object into proto format.
Parameter
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
get(callback)
get(callback: GetAppProfileCallback): void;
Parameter
Name | Description |
callback |
GetAppProfileCallback
|
Returns
getMetadata(options?: CallOptions): Promise<GetAppProfileMetadataResponse>;
Parameter
Name | Description |
options |
CallOptions
|
Returns
Type | Description |
Promise<GetAppProfileMetadataResponse> | |
getMetadata(options: CallOptions, callback: GetAppProfileMetadataCallback): void;
Parameters
Name | Description |
options |
CallOptions
|
callback |
GetAppProfileMetadataCallback
|
Returns
getMetadata(callback: GetAppProfileMetadataCallback): void;
Parameter
Name | Description |
callback |
GetAppProfileMetadataCallback
|
Returns
setMetadata(metadata: AppProfileOptions, options?: CallOptions): Promise<SetAppProfileMetadataResponse>;
Parameters
Returns
Type | Description |
Promise<SetAppProfileMetadataResponse> | |
setMetadata(metadata: AppProfileOptions, options: CallOptions, callback: SetAppProfileMetadataCallback): void;
Parameters
Name | Description |
metadata |
AppProfileOptions
|
options |
CallOptions
|
callback |
SetAppProfileMetadataCallback
|
Returns
setMetadata(metadata: AppProfileOptions, callback: SetAppProfileMetadataCallback): void;
Parameters
Returns