Class protos.google.bigtable.admin.v2.BigtableInstanceAdmin (3.7.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
NameDescription
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
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
TypeDescription
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
NameDescription
request google.bigtable.admin.v2.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
TypeDescription
void

createAppProfile(request)

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

Calls CreateAppProfile.

Parameter
NameDescription
request google.bigtable.admin.v2.ICreateAppProfileRequest

CreateAppProfileRequest message or plain object

Returns
TypeDescription
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
NameDescription
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
TypeDescription
void

createCluster(request)

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

Calls CreateCluster.

Parameter
NameDescription
request google.bigtable.admin.v2.ICreateClusterRequest

CreateClusterRequest message or plain object

Returns
TypeDescription
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
NameDescription
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
TypeDescription
void

createInstance(request)

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

Calls CreateInstance.

Parameter
NameDescription
request ICreateInstanceRequest

CreateInstanceRequest message or plain object

Returns
TypeDescription
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
NameDescription
request google.bigtable.admin.v2.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
TypeDescription
void

deleteAppProfile(request)

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

Calls DeleteAppProfile.

Parameter
NameDescription
request google.bigtable.admin.v2.IDeleteAppProfileRequest

DeleteAppProfileRequest message or plain object

Returns
TypeDescription
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
NameDescription
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
TypeDescription
void

deleteCluster(request)

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

Calls DeleteCluster.

Parameter
NameDescription
request IDeleteClusterRequest

DeleteClusterRequest message or plain object

Returns
TypeDescription
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
NameDescription
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
TypeDescription
void

deleteInstance(request)

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

Calls DeleteInstance.

Parameter
NameDescription
request google.bigtable.admin.v2.IDeleteInstanceRequest

DeleteInstanceRequest message or plain object

Returns
TypeDescription
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
NameDescription
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
TypeDescription
void

getAppProfile(request)

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

Calls GetAppProfile.

Parameter
NameDescription
request google.bigtable.admin.v2.IGetAppProfileRequest

GetAppProfileRequest message or plain object

Returns
TypeDescription
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
NameDescription
request google.bigtable.admin.v2.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
TypeDescription
void

getCluster(request)

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

Calls GetCluster.

Parameter
NameDescription
request google.bigtable.admin.v2.IGetClusterRequest

GetClusterRequest message or plain object

Returns
TypeDescription
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
NameDescription
request google.iam.v1.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
TypeDescription
void

getIamPolicy(request)

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

Calls GetIamPolicy.

Parameter
NameDescription
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

Returns
TypeDescription
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
NameDescription
request google.bigtable.admin.v2.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
TypeDescription
void

getInstance(request)

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

Calls GetInstance.

Parameter
NameDescription
request google.bigtable.admin.v2.IGetInstanceRequest

GetInstanceRequest message or plain object

Returns
TypeDescription
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
NameDescription
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
TypeDescription
void

listAppProfiles(request)

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

Calls ListAppProfiles.

Parameter
NameDescription
request google.bigtable.admin.v2.IListAppProfilesRequest

ListAppProfilesRequest message or plain object

Returns
TypeDescription
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
NameDescription
request google.bigtable.admin.v2.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
TypeDescription
void

listClusters(request)

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

Calls ListClusters.

Parameter
NameDescription
request google.bigtable.admin.v2.IListClustersRequest

ListClustersRequest message or plain object

Returns
TypeDescription
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
NameDescription
request google.bigtable.admin.v2.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
TypeDescription
void

listInstances(request)

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

Calls ListInstances.

Parameter
NameDescription
request google.bigtable.admin.v2.IListInstancesRequest

ListInstancesRequest message or plain object

Returns
TypeDescription
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
NameDescription
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
TypeDescription
void

partialUpdateInstance(request)

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

Calls PartialUpdateInstance.

Parameter
NameDescription
request IPartialUpdateInstanceRequest

PartialUpdateInstanceRequest message or plain object

Returns
TypeDescription
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
NameDescription
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
TypeDescription
void

setIamPolicy(request)

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

Calls SetIamPolicy.

Parameter
NameDescription
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

Returns
TypeDescription
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
NameDescription
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
TypeDescription
void

testIamPermissions(request)

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

Calls TestIamPermissions.

Parameter
NameDescription
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

Returns
TypeDescription
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
NameDescription
request 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
TypeDescription
void

updateAppProfile(request)

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

Calls UpdateAppProfile.

Parameter
NameDescription
request IUpdateAppProfileRequest

UpdateAppProfileRequest message or plain object

Returns
TypeDescription
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
NameDescription
request google.bigtable.admin.v2.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
TypeDescription
void

updateCluster(request)

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

Calls UpdateCluster.

Parameter
NameDescription
request google.bigtable.admin.v2.ICluster

Cluster message or plain object

Returns
TypeDescription
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
NameDescription
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
TypeDescription
void

updateInstance(request)

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

Calls UpdateInstance.

Parameter
NameDescription
request google.bigtable.admin.v2.IInstance

Instance message or plain object

Returns
TypeDescription
Promise<google.bigtable.admin.v2.Instance>

Promise