BigtableInstanceAdmin

google.bigtable.admin.v2. BigtableInstanceAdmin

Represents a BigtableInstanceAdmin

Constructor

new BigtableInstanceAdmin(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new BigtableInstanceAdmin service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {BigtableInstanceAdmin}

Creates new BigtableInstanceAdmin service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
BigtableInstanceAdmin

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

createAppProfile(request, callback) → {undefined}

Calls CreateAppProfile.

Parameters:
Name Type Description
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:
Type Description
undefined

createAppProfile(request) → {Promise.<google.bigtable.admin.v2.AppProfile>}

Calls CreateAppProfile.

Parameters:
Name Type Description
request google.bigtable.admin.v2.ICreateAppProfileRequest

CreateAppProfileRequest message or plain object

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

Promise

createCluster(request, callback) → {undefined}

Calls CreateCluster.

Parameters:
Name Type 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
undefined

createCluster(request) → {Promise.<google.longrunning.Operation>}

Calls CreateCluster.

Parameters:
Name Type Description
request google.bigtable.admin.v2.ICreateClusterRequest

CreateClusterRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

createInstance(request, callback) → {undefined}

Calls CreateInstance.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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
undefined

createInstance(request) → {Promise.<google.longrunning.Operation>}

Calls CreateInstance.

Parameters:
Name Type Description
request google.bigtable.admin.v2.ICreateInstanceRequest

CreateInstanceRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

deleteAppProfile(request, callback) → {undefined}

Calls DeleteAppProfile.

Parameters:
Name Type Description
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:
Type Description
undefined

deleteAppProfile(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteAppProfile.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IDeleteAppProfileRequest

DeleteAppProfileRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteCluster(request, callback) → {undefined}

Calls DeleteCluster.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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
undefined

deleteCluster(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteCluster.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IDeleteClusterRequest

DeleteClusterRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteInstance(request, callback) → {undefined}

Calls DeleteInstance.

Parameters:
Name Type 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
undefined

deleteInstance(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteInstance.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IDeleteInstanceRequest

DeleteInstanceRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

getAppProfile(request, callback) → {undefined}

Calls GetAppProfile.

Parameters:
Name Type 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
undefined

getAppProfile(request) → {Promise.<google.bigtable.admin.v2.AppProfile>}

Calls GetAppProfile.

Parameters:
Name Type 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) → {undefined}

Calls GetCluster.

Parameters:
Name Type Description
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:
Type Description
undefined

getCluster(request) → {Promise.<google.bigtable.admin.v2.Cluster>}

Calls GetCluster.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IGetClusterRequest

GetClusterRequest message or plain object

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

Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:
Name Type Description
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:
Type Description
undefined

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

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

Promise

getInstance(request, callback) → {undefined}

Calls GetInstance.

Parameters:
Name Type Description
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:
Type Description
undefined

getInstance(request) → {Promise.<google.bigtable.admin.v2.Instance>}

Calls GetInstance.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IGetInstanceRequest

GetInstanceRequest message or plain object

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

Promise

listAppProfiles(request, callback) → {undefined}

Calls ListAppProfiles.

Parameters:
Name Type 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
undefined

listAppProfiles(request) → {Promise.<google.bigtable.admin.v2.ListAppProfilesResponse>}

Calls ListAppProfiles.

Parameters:
Name Type 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) → {undefined}

Calls ListClusters.

Parameters:
Name Type Description
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:
Type Description
undefined

listClusters(request) → {Promise.<google.bigtable.admin.v2.ListClustersResponse>}

Calls ListClusters.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IListClustersRequest

ListClustersRequest message or plain object

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

Promise

listInstances(request, callback) → {undefined}

Calls ListInstances.

Parameters:
Name Type Description
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:
Type Description
undefined

listInstances(request) → {Promise.<google.bigtable.admin.v2.ListInstancesResponse>}

Calls ListInstances.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IListInstancesRequest

ListInstancesRequest message or plain object

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

Promise

partialUpdateInstance(request, callback) → {undefined}

Calls PartialUpdateInstance.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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
undefined

partialUpdateInstance(request) → {Promise.<google.longrunning.Operation>}

Calls PartialUpdateInstance.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IPartialUpdateInstanceRequest

PartialUpdateInstanceRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:
Name Type 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
undefined

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

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

Promise

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:
Name Type 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
undefined

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

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

Promise

updateAppProfile(request, callback) → {undefined}

Calls UpdateAppProfile.

Parameters:
Name Type 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
undefined

updateAppProfile(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateAppProfile.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IUpdateAppProfileRequest

UpdateAppProfileRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

updateCluster(request, callback) → {undefined}

Calls UpdateCluster.

Parameters:
Name Type Description
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:
Type Description
undefined

updateCluster(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateCluster.

Parameters:
Name Type Description
request google.bigtable.admin.v2.ICluster

Cluster message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

updateInstance(request, callback) → {undefined}

Calls UpdateInstance.

Parameters:
Name Type 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
undefined

updateInstance(request) → {Promise.<google.bigtable.admin.v2.Instance>}

Calls UpdateInstance.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IInstance

Instance message or plain object

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

Promise

Type Definitions

CreateAppProfileCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#createAppProfile.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.AppProfile <optional>

AppProfile

CreateClusterCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#createCluster.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

CreateInstanceCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#createInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

DeleteAppProfileCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#deleteAppProfile.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DeleteClusterCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#deleteCluster.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DeleteInstanceCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#deleteInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

GetAppProfileCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#getAppProfile.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.AppProfile <optional>

AppProfile

GetClusterCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#getCluster.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.Cluster <optional>

Cluster

GetIamPolicyCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#getIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.Policy <optional>

Policy

GetInstanceCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#getInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.Instance <optional>

Instance

ListAppProfilesCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#listAppProfiles.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.ListAppProfilesResponse <optional>

ListAppProfilesResponse

ListClustersCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#listClusters.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.ListClustersResponse <optional>

ListClustersResponse

ListInstancesCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#listInstances.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.ListInstancesResponse <optional>

ListInstancesResponse

PartialUpdateInstanceCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#partialUpdateInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

SetIamPolicyCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#setIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.Policy <optional>

Policy

TestIamPermissionsCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#testIamPermissions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.TestIamPermissionsResponse <optional>

TestIamPermissionsResponse

UpdateAppProfileCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#updateAppProfile.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

UpdateClusterCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#updateCluster.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

UpdateInstanceCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableInstanceAdmin#updateInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.Instance <optional>

Instance