v2. BigtableInstanceAdminClient
Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those tables.
Constructor
BigtableInstanceAdminClient
new BigtableInstanceAdminClient(options)
Construct an instance of BigtableInstanceAdminClient.
Parameter |
|||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Optional object The configuration object. See the subsequent parameters for more details. Values in
|
Properties
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
appProfilePath
appProfilePath(project, instance, appProfile) returns String
Return a fully-qualified app_profile resource name string.
Parameter |
|
---|---|
project |
String |
instance |
String |
appProfile |
String |
- Returns
-
String
clusterPath
clusterPath(project, instance, cluster) returns String
Return a fully-qualified cluster resource name string.
Parameter |
|
---|---|
project |
String |
instance |
String |
cluster |
String |
- Returns
-
String
createAppProfile
createAppProfile(request, options, callback) returns Promise
This is a private alpha release of Cloud Bigtable replication. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
Creates an app profile within an instance.
Parameter |
|||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing AppProfile. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing AppProfile. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');
var appProfileId = '';
var appProfile = {};
var request = {
parent: formattedParent,
appProfileId: appProfileId,
appProfile: appProfile,
};
client.createAppProfile(request)
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});
createCluster
createCluster(request, options, callback) returns Promise
Creates a cluster within an instance.
Parameter |
|||||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is a gax.Operation object. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');
var clusterId = '';
var cluster = {};
var request = {
parent: formattedParent,
clusterId: clusterId,
cluster: cluster,
};
// Handle the operation using the promise pattern.
client.createCluster(request)
.then(responses => {
var operation = responses[0];
var initialApiResponse = responses[1];
// Operation#promise starts polling for the completion of the LRO.
return operation.promise();
})
.then(responses => {
// The final result of the operation.
var result = responses[0];
// The metadata value of the completed operation.
var metadata = responses[1];
// The response of the api call returning the complete operation.
var finalApiResponse = responses[2];
})
.catch(err => {
console.error(err);
});
var formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');
var clusterId = '';
var cluster = {};
var request = {
parent: formattedParent,
clusterId: clusterId,
cluster: cluster,
};
// Handle the operation using the event emitter pattern.
client.createCluster(request)
.then(responses => {
var operation = responses[0];
var initialApiResponse = responses[1];
// Adding a listener for the "complete" event starts polling for the
// completion of the operation.
operation.on('complete', (result, metadata, finalApiResponse) => {
// doSomethingWith(result);
});
// Adding a listener for the "progress" event causes the callback to be
// called on any change in metadata when the operation is polled.
operation.on('progress', (metadata, apiResponse) => {
// doSomethingWith(metadata)
});
// Adding a listener for the "error" event handles any errors found during polling.
operation.on('error', err => {
// throw(err);
});
})
.catch(err => {
console.error(err);
});
createInstance
createInstance(request, options, callback) returns Promise
Create an instance within a project.
Parameter |
|||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is a gax.Operation object. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedParent = client.projectPath('[PROJECT]');
var instanceId = '';
var instance = {};
var clusters = {};
var request = {
parent: formattedParent,
instanceId: instanceId,
instance: instance,
clusters: clusters,
};
// Handle the operation using the promise pattern.
client.createInstance(request)
.then(responses => {
var operation = responses[0];
var initialApiResponse = responses[1];
// Operation#promise starts polling for the completion of the LRO.
return operation.promise();
})
.then(responses => {
// The final result of the operation.
var result = responses[0];
// The metadata value of the completed operation.
var metadata = responses[1];
// The response of the api call returning the complete operation.
var finalApiResponse = responses[2];
})
.catch(err => {
console.error(err);
});
var formattedParent = client.projectPath('[PROJECT]');
var instanceId = '';
var instance = {};
var clusters = {};
var request = {
parent: formattedParent,
instanceId: instanceId,
instance: instance,
clusters: clusters,
};
// Handle the operation using the event emitter pattern.
client.createInstance(request)
.then(responses => {
var operation = responses[0];
var initialApiResponse = responses[1];
// Adding a listener for the "complete" event starts polling for the
// completion of the operation.
operation.on('complete', (result, metadata, finalApiResponse) => {
// doSomethingWith(result);
});
// Adding a listener for the "progress" event causes the callback to be
// called on any change in metadata when the operation is polled.
operation.on('progress', (metadata, apiResponse) => {
// doSomethingWith(metadata)
});
// Adding a listener for the "error" event handles any errors found during polling.
operation.on('error', err => {
// throw(err);
});
})
.catch(err => {
console.error(err);
});
deleteAppProfile
deleteAppProfile(request, options, callback) returns Promise
This is a private alpha release of Cloud Bigtable replication. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
Deletes an app profile from an instance.
Parameter |
|||||||
---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
Optional function(nullable Error) The function which will be called with the result of the API call. |
- Returns
-
Promise
- The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedName = client.appProfilePath('[PROJECT]', '[INSTANCE]', '[APP_PROFILE]');
var ignoreWarnings = false;
var request = {
name: formattedName,
ignoreWarnings: ignoreWarnings,
};
client.deleteAppProfile(request).catch(err => {
console.error(err);
});
deleteCluster
deleteCluster(request, options, callback) returns Promise
Deletes a cluster from an instance.
Parameter |
|||||
---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||
callback |
Optional function(nullable Error) The function which will be called with the result of the API call. |
- Returns
-
Promise
- The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedName = client.clusterPath('[PROJECT]', '[INSTANCE]', '[CLUSTER]');
client.deleteCluster({name: formattedName}).catch(err => {
console.error(err);
});
deleteInstance
deleteInstance(request, options, callback) returns Promise
Delete an instance from a project.
Parameter |
|||||
---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||
callback |
Optional function(nullable Error) The function which will be called with the result of the API call. |
- Returns
-
Promise
- The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedName = client.instancePath('[PROJECT]', '[INSTANCE]');
client.deleteInstance({name: formattedName}).catch(err => {
console.error(err);
});
getAppProfile
getAppProfile(request, options, callback) returns Promise
This is a private alpha release of Cloud Bigtable replication. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
Gets information about an app profile.
Parameter |
|||||
---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing AppProfile. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing AppProfile. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedName = client.appProfilePath('[PROJECT]', '[INSTANCE]', '[APP_PROFILE]');
client.getAppProfile({name: formattedName})
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});
getCluster
getCluster(request, options, callback) returns Promise
Gets information about a cluster.
Parameter |
|||||
---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing Cluster. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing Cluster. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedName = client.clusterPath('[PROJECT]', '[INSTANCE]', '[CLUSTER]');
client.getCluster({name: formattedName})
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});
getIamPolicy
getIamPolicy(request, options, callback) returns Promise
This is a private alpha release of Cloud Bigtable instance level permissions. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
Parameter |
|||||
---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing Policy. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing Policy. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedResource = client.instancePath('[PROJECT]', '[INSTANCE]');
client.getIamPolicy({resource: formattedResource})
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});
getInstance
getInstance(request, options, callback) returns Promise
Gets information about an instance.
Parameter |
|||||
---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing Instance. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing Instance. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedName = client.instancePath('[PROJECT]', '[INSTANCE]');
client.getInstance({name: formattedName})
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});
getProjectId
getProjectId(callback)
Return the project ID used by this class.
Parameter |
|
---|---|
callback |
function(Error, string) the callback to be called with the current project Id. |
instancePath
instancePath(project, instance) returns String
Return a fully-qualified instance resource name string.
Parameter |
|
---|---|
project |
String |
instance |
String |
- Returns
-
String
listAppProfiles
listAppProfiles(request, options, callback) returns Promise
This is a private alpha release of Cloud Bigtable replication. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
Lists information about app profiles in an instance.
Parameter |
|||||
---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||
callback |
Optional function(nullable Error, nullable Array, nullable Object, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is Array of AppProfile. When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListAppProfilesResponse. |
- Returns
-
Promise
-
The promise which resolves to an array. The first element of the array is Array of AppProfile.
When autoPaginate: false is specified through options, the array has three elements. The first element is Array of AppProfile in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListAppProfilesResponse.
The promise has a method named "cancel" which cancels the ongoing API call.
-
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
// Iterate over all elements.
var formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');
client.listAppProfiles({parent: formattedParent})
.then(responses => {
var resources = responses[0];
for (let i = 0; i < resources.length; i += 1) {
// doThingsWith(resources[i])
}
})
.catch(err => {
console.error(err);
});
// Or obtain the paged response.
var formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');
var options = {autoPaginate: false};
var callback = responses => {
// The actual resources in a response.
var resources = responses[0];
// The next request if the response shows that there are more responses.
var nextRequest = responses[1];
// The actual response object, if necessary.
// var rawResponse = responses[2];
for (let i = 0; i < resources.length; i += 1) {
// doThingsWith(resources[i]);
}
if (nextRequest) {
// Fetch the next page.
return client.listAppProfiles(nextRequest, options).then(callback);
}
}
client.listAppProfiles({parent: formattedParent}, options)
.then(callback)
.catch(err => {
console.error(err);
});
listAppProfilesStream
listAppProfilesStream(request, options) returns Stream
Equivalent to listAppProfiles, but returns a NodeJS Stream object.
This fetches the paged responses for listAppProfiles continuously and invokes the callback registered for 'data' event for each element in the responses.
The returned object has 'end' method when no more elements are required.
autoPaginate option will be ignored.
Parameter |
|||||
---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
- See also
- https://nodejs.org/api/stream.html
- Returns
-
Stream
An object stream which emits an object representing AppProfile on 'data' event.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');
client.listAppProfilesStream({parent: formattedParent})
.on('data', element => {
// doThingsWith(element)
}).on('error', err => {
console.log(err);
});
listClusters
listClusters(request, options, callback) returns Promise
Lists information about clusters in an instance.
Parameter |
|||||||
---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing ListClustersResponse. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing ListClustersResponse. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedParent = client.instancePath('[PROJECT]', '[INSTANCE]');
client.listClusters({parent: formattedParent})
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});
listInstances
listInstances(request, options, callback) returns Promise
Lists information about instances in a project.
Parameter |
|||||||
---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing ListInstancesResponse. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing ListInstancesResponse. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedParent = client.projectPath('[PROJECT]');
client.listInstances({parent: formattedParent})
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});
locationPath
locationPath(project, location) returns String
Return a fully-qualified location resource name string.
Parameter |
|
---|---|
project |
String |
location |
String |
- Returns
-
String
matchAppProfileFromAppProfileName
matchAppProfileFromAppProfileName(appProfileName) returns String
Parse the appProfileName from a app_profile resource.
Parameter |
|
---|---|
appProfileName |
String A fully-qualified path representing a app_profile resources. |
- Returns
-
String
- A string representing the app_profile.
matchClusterFromClusterName
matchClusterFromClusterName(clusterName) returns String
Parse the clusterName from a cluster resource.
Parameter |
|
---|---|
clusterName |
String A fully-qualified path representing a cluster resources. |
- Returns
-
String
- A string representing the cluster.
matchInstanceFromAppProfileName
matchInstanceFromAppProfileName(appProfileName) returns String
Parse the appProfileName from a app_profile resource.
Parameter |
|
---|---|
appProfileName |
String A fully-qualified path representing a app_profile resources. |
- Returns
-
String
- A string representing the instance.
matchInstanceFromClusterName
matchInstanceFromClusterName(clusterName) returns String
Parse the clusterName from a cluster resource.
Parameter |
|
---|---|
clusterName |
String A fully-qualified path representing a cluster resources. |
- Returns
-
String
- A string representing the instance.
matchInstanceFromInstanceName
matchInstanceFromInstanceName(instanceName) returns String
Parse the instanceName from a instance resource.
Parameter |
|
---|---|
instanceName |
String A fully-qualified path representing a instance resources. |
- Returns
-
String
- A string representing the instance.
matchLocationFromLocationName
matchLocationFromLocationName(locationName) returns String
Parse the locationName from a location resource.
Parameter |
|
---|---|
locationName |
String A fully-qualified path representing a location resources. |
- Returns
-
String
- A string representing the location.
matchProjectFromAppProfileName
matchProjectFromAppProfileName(appProfileName) returns String
Parse the appProfileName from a app_profile resource.
Parameter |
|
---|---|
appProfileName |
String A fully-qualified path representing a app_profile resources. |
- Returns
-
String
- A string representing the project.
matchProjectFromClusterName
matchProjectFromClusterName(clusterName) returns String
Parse the clusterName from a cluster resource.
Parameter |
|
---|---|
clusterName |
String A fully-qualified path representing a cluster resources. |
- Returns
-
String
- A string representing the project.
matchProjectFromInstanceName
matchProjectFromInstanceName(instanceName) returns String
Parse the instanceName from a instance resource.
Parameter |
|
---|---|
instanceName |
String A fully-qualified path representing a instance resources. |
- Returns
-
String
- A string representing the project.
matchProjectFromLocationName
matchProjectFromLocationName(locationName) returns String
Parse the locationName from a location resource.
Parameter |
|
---|---|
locationName |
String A fully-qualified path representing a location resources. |
- Returns
-
String
- A string representing the project.
matchProjectFromProjectName
matchProjectFromProjectName(projectName) returns String
Parse the projectName from a project resource.
Parameter |
|
---|---|
projectName |
String A fully-qualified path representing a project resources. |
- Returns
-
String
- A string representing the project.
partialUpdateInstance
partialUpdateInstance(request, options, callback) returns Promise
Partially updates an instance within a project.
Parameter |
|||||||
---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is a gax.Operation object. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var instance = {};
var updateMask = {};
var request = {
instance: instance,
updateMask: updateMask,
};
// Handle the operation using the promise pattern.
client.partialUpdateInstance(request)
.then(responses => {
var operation = responses[0];
var initialApiResponse = responses[1];
// Operation#promise starts polling for the completion of the LRO.
return operation.promise();
})
.then(responses => {
// The final result of the operation.
var result = responses[0];
// The metadata value of the completed operation.
var metadata = responses[1];
// The response of the api call returning the complete operation.
var finalApiResponse = responses[2];
})
.catch(err => {
console.error(err);
});
var instance = {};
var updateMask = {};
var request = {
instance: instance,
updateMask: updateMask,
};
// Handle the operation using the event emitter pattern.
client.partialUpdateInstance(request)
.then(responses => {
var operation = responses[0];
var initialApiResponse = responses[1];
// Adding a listener for the "complete" event starts polling for the
// completion of the operation.
operation.on('complete', (result, metadata, finalApiResponse) => {
// doSomethingWith(result);
});
// Adding a listener for the "progress" event causes the callback to be
// called on any change in metadata when the operation is polled.
operation.on('progress', (metadata, apiResponse) => {
// doSomethingWith(metadata)
});
// Adding a listener for the "error" event handles any errors found during polling.
operation.on('error', err => {
// throw(err);
});
})
.catch(err => {
console.error(err);
});
projectPath
projectPath(project) returns String
Return a fully-qualified project resource name string.
Parameter |
|
---|---|
project |
String |
- Returns
-
String
setIamPolicy
setIamPolicy(request, options, callback) returns Promise
This is a private alpha release of Cloud Bigtable instance level permissions. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
Sets the access control policy on an instance resource. Replaces any existing policy.
Parameter |
|||||||
---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing Policy. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing Policy. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedResource = client.instancePath('[PROJECT]', '[INSTANCE]');
var policy = {};
var request = {
resource: formattedResource,
policy: policy,
};
client.setIamPolicy(request)
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});
testIamPermissions
testIamPermissions(request, options, callback) returns Promise
This is a private alpha release of Cloud Bigtable instance level permissions. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
Returns permissions that the caller has on the specified instance resource.
Parameter |
|||||||
---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing TestIamPermissionsResponse. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedResource = client.instancePath('[PROJECT]', '[INSTANCE]');
var permissions = [];
var request = {
resource: formattedResource,
permissions: permissions,
};
client.testIamPermissions(request)
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});
updateAppProfile
updateAppProfile(request, options, callback) returns Promise
This is a private alpha release of Cloud Bigtable replication. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
Updates an app profile within an instance.
Parameter |
|||||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is a gax.Operation object. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var appProfile = {};
var updateMask = {};
var request = {
appProfile: appProfile,
updateMask: updateMask,
};
// Handle the operation using the promise pattern.
client.updateAppProfile(request)
.then(responses => {
var operation = responses[0];
var initialApiResponse = responses[1];
// Operation#promise starts polling for the completion of the LRO.
return operation.promise();
})
.then(responses => {
// The final result of the operation.
var result = responses[0];
// The metadata value of the completed operation.
var metadata = responses[1];
// The response of the api call returning the complete operation.
var finalApiResponse = responses[2];
})
.catch(err => {
console.error(err);
});
var appProfile = {};
var updateMask = {};
var request = {
appProfile: appProfile,
updateMask: updateMask,
};
// Handle the operation using the event emitter pattern.
client.updateAppProfile(request)
.then(responses => {
var operation = responses[0];
var initialApiResponse = responses[1];
// Adding a listener for the "complete" event starts polling for the
// completion of the operation.
operation.on('complete', (result, metadata, finalApiResponse) => {
// doSomethingWith(result);
});
// Adding a listener for the "progress" event causes the callback to be
// called on any change in metadata when the operation is polled.
operation.on('progress', (metadata, apiResponse) => {
// doSomethingWith(metadata)
});
// Adding a listener for the "error" event handles any errors found during polling.
operation.on('error', err => {
// throw(err);
});
})
.catch(err => {
console.error(err);
});
updateCluster
updateCluster(request, options, callback) returns Promise
Updates a cluster within an instance.
Parameter |
|||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||||||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is a gax.Operation object. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedName = client.clusterPath('[PROJECT]', '[INSTANCE]', '[CLUSTER]');
var location = '';
var serveNodes = 0;
var request = {
name: formattedName,
location: location,
serveNodes: serveNodes,
};
// Handle the operation using the promise pattern.
client.updateCluster(request)
.then(responses => {
var operation = responses[0];
var initialApiResponse = responses[1];
// Operation#promise starts polling for the completion of the LRO.
return operation.promise();
})
.then(responses => {
// The final result of the operation.
var result = responses[0];
// The metadata value of the completed operation.
var metadata = responses[1];
// The response of the api call returning the complete operation.
var finalApiResponse = responses[2];
})
.catch(err => {
console.error(err);
});
var formattedName = client.clusterPath('[PROJECT]', '[INSTANCE]', '[CLUSTER]');
var location = '';
var serveNodes = 0;
var request = {
name: formattedName,
location: location,
serveNodes: serveNodes,
};
// Handle the operation using the event emitter pattern.
client.updateCluster(request)
.then(responses => {
var operation = responses[0];
var initialApiResponse = responses[1];
// Adding a listener for the "complete" event starts polling for the
// completion of the operation.
operation.on('complete', (result, metadata, finalApiResponse) => {
// doSomethingWith(result);
});
// Adding a listener for the "progress" event causes the callback to be
// called on any change in metadata when the operation is polled.
operation.on('progress', (metadata, apiResponse) => {
// doSomethingWith(metadata)
});
// Adding a listener for the "error" event handles any errors found during polling.
operation.on('error', err => {
// throw(err);
});
})
.catch(err => {
console.error(err);
});
updateInstance
updateInstance(request, options, callback) returns Promise
Updates an instance within a project.
Parameter |
|||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||||||||
options |
Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||
callback |
Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing Instance. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing Instance. The promise has a method named "cancel" which cancels the ongoing API call.
Example
const admin = require('admin.v2');
var client = new admin.v2.BigtableInstanceAdminClient({
// optional auth parameters.
});
var formattedName = client.instancePath('[PROJECT]', '[INSTANCE]');
var displayName = '';
var type = 'TYPE_UNSPECIFIED';
var labels = {};
var request = {
name: formattedName,
displayName: displayName,
type: type,
labels: labels,
};
client.updateInstance(request)
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});