Class protos.google.bigtable.admin.v2.BigtableInstanceAdmin (3.6.0)

Represents a BigtableInstanceAdmin

Inheritance

$protobuf.rpc.Service > protos.google.bigtable.admin.v2.BigtableInstanceAdmin

Package

@google-cloud/bigtable!

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new BigtableInstanceAdmin service.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): BigtableInstanceAdmin;

Creates new BigtableInstanceAdmin service using the specified rpc implementation.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Returns

Type	Description
BigtableInstanceAdmin	RPC service. Useful where requests and/or responses are streamed.

createAppProfile(request, callback)

public createAppProfile(request: google.bigtable.admin.v2.ICreateAppProfileRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.CreateAppProfileCallback): void;

Calls CreateAppProfile.

Parameters

Name	Description
request	`ICreateAppProfileRequest` CreateAppProfileRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.CreateAppProfileCallback` Node-style callback called with the error, if any, and AppProfile

Returns

Type	Description
void

createAppProfile(request)

public createAppProfile(request: google.bigtable.admin.v2.ICreateAppProfileRequest): Promise<google.bigtable.admin.v2.AppProfile>;

Calls CreateAppProfile.

Parameter

Name	Description
request	`ICreateAppProfileRequest` CreateAppProfileRequest message or plain object

Returns

Type	Description
Promise<google.bigtable.admin.v2.AppProfile>	Promise

createCluster(request, callback)

public createCluster(request: google.bigtable.admin.v2.ICreateClusterRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.CreateClusterCallback): void;

Calls CreateCluster.

Parameters

Name	Description
request	`google.bigtable.admin.v2.ICreateClusterRequest` CreateClusterRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.CreateClusterCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

createCluster(request)

public createCluster(request: google.bigtable.admin.v2.ICreateClusterRequest): Promise<google.longrunning.Operation>;

Calls CreateCluster.

Parameter

Name	Description
request	`google.bigtable.admin.v2.ICreateClusterRequest` CreateClusterRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

createInstance(request, callback)

public createInstance(request: google.bigtable.admin.v2.ICreateInstanceRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.CreateInstanceCallback): void;

Calls CreateInstance.

Parameters

Name	Description
request	`ICreateInstanceRequest` CreateInstanceRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.CreateInstanceCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

createInstance(request)

public createInstance(request: google.bigtable.admin.v2.ICreateInstanceRequest): Promise<google.longrunning.Operation>;

Calls CreateInstance.

Parameter

Name	Description
request	`ICreateInstanceRequest` CreateInstanceRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

deleteAppProfile(request, callback)

public deleteAppProfile(request: google.bigtable.admin.v2.IDeleteAppProfileRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.DeleteAppProfileCallback): void;

Calls DeleteAppProfile.

Parameters

Name	Description
request	`IDeleteAppProfileRequest` DeleteAppProfileRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.DeleteAppProfileCallback` Node-style callback called with the error, if any, and Empty

Returns

Type	Description
void

deleteAppProfile(request)

public deleteAppProfile(request: google.bigtable.admin.v2.IDeleteAppProfileRequest): Promise<google.protobuf.Empty>;

Calls DeleteAppProfile.

Parameter

Name	Description
request	`IDeleteAppProfileRequest` DeleteAppProfileRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

deleteCluster(request, callback)

public deleteCluster(request: google.bigtable.admin.v2.IDeleteClusterRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.DeleteClusterCallback): void;

Calls DeleteCluster.

Parameters

Name	Description
request	`IDeleteClusterRequest` DeleteClusterRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.DeleteClusterCallback` Node-style callback called with the error, if any, and Empty

Returns

Type	Description
void

deleteCluster(request)

public deleteCluster(request: google.bigtable.admin.v2.IDeleteClusterRequest): Promise<google.protobuf.Empty>;

Calls DeleteCluster.

Parameter

Name	Description
request	`IDeleteClusterRequest` DeleteClusterRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

deleteInstance(request, callback)

public deleteInstance(request: google.bigtable.admin.v2.IDeleteInstanceRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.DeleteInstanceCallback): void;

Calls DeleteInstance.

Parameters

Name	Description
request	`google.bigtable.admin.v2.IDeleteInstanceRequest` DeleteInstanceRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.DeleteInstanceCallback` Node-style callback called with the error, if any, and Empty

Returns

Type	Description
void

deleteInstance(request)

public deleteInstance(request: google.bigtable.admin.v2.IDeleteInstanceRequest): Promise<google.protobuf.Empty>;

Calls DeleteInstance.

Parameter

Name	Description
request	`google.bigtable.admin.v2.IDeleteInstanceRequest` DeleteInstanceRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

getAppProfile(request, callback)

public getAppProfile(request: google.bigtable.admin.v2.IGetAppProfileRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.GetAppProfileCallback): void;

Calls GetAppProfile.

Parameters

Name	Description
request	`google.bigtable.admin.v2.IGetAppProfileRequest` GetAppProfileRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.GetAppProfileCallback` Node-style callback called with the error, if any, and AppProfile

Returns

Type	Description
void

getAppProfile(request)

public getAppProfile(request: google.bigtable.admin.v2.IGetAppProfileRequest): Promise<google.bigtable.admin.v2.AppProfile>;

Calls GetAppProfile.

Parameter

Name	Description
request	`google.bigtable.admin.v2.IGetAppProfileRequest` GetAppProfileRequest message or plain object

Returns

Type	Description
Promise<google.bigtable.admin.v2.AppProfile>	Promise

getCluster(request, callback)

public getCluster(request: google.bigtable.admin.v2.IGetClusterRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.GetClusterCallback): void;

Calls GetCluster.

Parameters

Name	Description
request	`IGetClusterRequest` GetClusterRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.GetClusterCallback` Node-style callback called with the error, if any, and Cluster

Returns

Type	Description
void

getCluster(request)

public getCluster(request: google.bigtable.admin.v2.IGetClusterRequest): Promise<google.bigtable.admin.v2.Cluster>;

Calls GetCluster.

Parameter

Name	Description
request	`IGetClusterRequest` GetClusterRequest message or plain object

Returns

Type	Description
Promise<google.bigtable.admin.v2.Cluster>	Promise

getIamPolicy(request, callback)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.GetIamPolicyCallback): void;

Calls GetIamPolicy.

Parameters

Name	Description
request	`IGetIamPolicyRequest` GetIamPolicyRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.GetIamPolicyCallback` Node-style callback called with the error, if any, and Policy

Returns

Type	Description
void

getIamPolicy(request)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls GetIamPolicy.

Parameter

Name	Description
request	`IGetIamPolicyRequest` GetIamPolicyRequest message or plain object

Returns

Type	Description
Promise<google.iam.v1.Policy>	Promise

getInstance(request, callback)

public getInstance(request: google.bigtable.admin.v2.IGetInstanceRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.GetInstanceCallback): void;

Calls GetInstance.

Parameters

Name	Description
request	`IGetInstanceRequest` GetInstanceRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.GetInstanceCallback` Node-style callback called with the error, if any, and Instance

Returns

Type	Description
void

getInstance(request)

public getInstance(request: google.bigtable.admin.v2.IGetInstanceRequest): Promise<google.bigtable.admin.v2.Instance>;

Calls GetInstance.

Parameter

Name	Description
request	`IGetInstanceRequest` GetInstanceRequest message or plain object

Returns

Type	Description
Promise<google.bigtable.admin.v2.Instance>	Promise

listAppProfiles(request, callback)

public listAppProfiles(request: google.bigtable.admin.v2.IListAppProfilesRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.ListAppProfilesCallback): void;

Calls ListAppProfiles.

Parameters

Name	Description
request	`google.bigtable.admin.v2.IListAppProfilesRequest` ListAppProfilesRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.ListAppProfilesCallback` Node-style callback called with the error, if any, and ListAppProfilesResponse

Returns

Type	Description
void

listAppProfiles(request)

public listAppProfiles(request: google.bigtable.admin.v2.IListAppProfilesRequest): Promise<google.bigtable.admin.v2.ListAppProfilesResponse>;

Calls ListAppProfiles.

Parameter

Name	Description
request	`google.bigtable.admin.v2.IListAppProfilesRequest` ListAppProfilesRequest message or plain object

Returns

Type	Description
Promise<google.bigtable.admin.v2.ListAppProfilesResponse>	Promise

listClusters(request, callback)

public listClusters(request: google.bigtable.admin.v2.IListClustersRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.ListClustersCallback): void;

Calls ListClusters.

Parameters

Name	Description
request	`IListClustersRequest` ListClustersRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.ListClustersCallback` Node-style callback called with the error, if any, and ListClustersResponse

Returns

Type	Description
void

listClusters(request)

public listClusters(request: google.bigtable.admin.v2.IListClustersRequest): Promise<google.bigtable.admin.v2.ListClustersResponse>;

Calls ListClusters.

Parameter

Name	Description
request	`IListClustersRequest` ListClustersRequest message or plain object

Returns

Type	Description
Promise<google.bigtable.admin.v2.ListClustersResponse>	Promise

listInstances(request, callback)

public listInstances(request: google.bigtable.admin.v2.IListInstancesRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.ListInstancesCallback): void;

Calls ListInstances.

Parameters

Name	Description
request	`IListInstancesRequest` ListInstancesRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.ListInstancesCallback` Node-style callback called with the error, if any, and ListInstancesResponse

Returns

Type	Description
void

listInstances(request)

public listInstances(request: google.bigtable.admin.v2.IListInstancesRequest): Promise<google.bigtable.admin.v2.ListInstancesResponse>;

Calls ListInstances.

Parameter

Name	Description
request	`IListInstancesRequest` ListInstancesRequest message or plain object

Returns

Type	Description
Promise<google.bigtable.admin.v2.ListInstancesResponse>	Promise

partialUpdateInstance(request, callback)

public partialUpdateInstance(request: google.bigtable.admin.v2.IPartialUpdateInstanceRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.PartialUpdateInstanceCallback): void;

Calls PartialUpdateInstance.

Parameters

Name	Description
request	`IPartialUpdateInstanceRequest` PartialUpdateInstanceRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.PartialUpdateInstanceCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

partialUpdateInstance(request)

public partialUpdateInstance(request: google.bigtable.admin.v2.IPartialUpdateInstanceRequest): Promise<google.longrunning.Operation>;

Calls PartialUpdateInstance.

Parameter

Name	Description
request	`IPartialUpdateInstanceRequest` PartialUpdateInstanceRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

setIamPolicy(request, callback)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.SetIamPolicyCallback): void;

Calls SetIamPolicy.

Parameters

Name	Description
request	`google.iam.v1.ISetIamPolicyRequest` SetIamPolicyRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.SetIamPolicyCallback` Node-style callback called with the error, if any, and Policy

Returns

Type	Description
void

setIamPolicy(request)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls SetIamPolicy.

Parameter

Name	Description
request	`google.iam.v1.ISetIamPolicyRequest` SetIamPolicyRequest message or plain object

Returns

Type	Description
Promise<google.iam.v1.Policy>	Promise

testIamPermissions(request, callback)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters

Name	Description
request	`google.iam.v1.ITestIamPermissionsRequest` TestIamPermissionsRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.TestIamPermissionsCallback` Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns

Type	Description
void

testIamPermissions(request)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;

Calls TestIamPermissions.

Parameter

Name	Description
request	`google.iam.v1.ITestIamPermissionsRequest` TestIamPermissionsRequest message or plain object

Returns

Type	Description
Promise<google.iam.v1.TestIamPermissionsResponse>	Promise

updateAppProfile(request, callback)

public updateAppProfile(request: google.bigtable.admin.v2.IUpdateAppProfileRequest, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.UpdateAppProfileCallback): void;

Calls UpdateAppProfile.

Parameters

Name	Description
request	`google.bigtable.admin.v2.IUpdateAppProfileRequest` UpdateAppProfileRequest message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.UpdateAppProfileCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

updateAppProfile(request)

public updateAppProfile(request: google.bigtable.admin.v2.IUpdateAppProfileRequest): Promise<google.longrunning.Operation>;

Calls UpdateAppProfile.

Parameter

Name	Description
request	`google.bigtable.admin.v2.IUpdateAppProfileRequest` UpdateAppProfileRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

updateCluster(request, callback)

public updateCluster(request: google.bigtable.admin.v2.ICluster, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.UpdateClusterCallback): void;

Calls UpdateCluster.

Parameters

Name	Description
request	`ICluster` Cluster message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.UpdateClusterCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

updateCluster(request)

public updateCluster(request: google.bigtable.admin.v2.ICluster): Promise<google.longrunning.Operation>;

Calls UpdateCluster.

Parameter

Name	Description
request	`ICluster` Cluster message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

updateInstance(request, callback)

public updateInstance(request: google.bigtable.admin.v2.IInstance, callback: google.bigtable.admin.v2.BigtableInstanceAdmin.UpdateInstanceCallback): void;

Calls UpdateInstance.

Parameters

Name	Description
request	`google.bigtable.admin.v2.IInstance` Instance message or plain object
callback	`google.bigtable.admin.v2.BigtableInstanceAdmin.UpdateInstanceCallback` Node-style callback called with the error, if any, and Instance

Returns

Type	Description
void

updateInstance(request)

public updateInstance(request: google.bigtable.admin.v2.IInstance): Promise<google.bigtable.admin.v2.Instance>;

Calls UpdateInstance.

Parameter

Name	Description
request	`google.bigtable.admin.v2.IInstance` Instance message or plain object

Returns

Type	Description
Promise<google.bigtable.admin.v2.Instance>	Promise