Constructor
new InstanceGroupManager(zone, name)
Parameters:
Name | Type | Description |
---|---|---|
zone |
Zone | |
name |
string |
Members
id
Methods
abandonInstances(vms, callback)
Flags the specified instances to be removed from the managed instance group.
Parameters:
Name | Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
vms |
VM | Array.<VM> |
VM instances to abandon from this instance group manager. |
||||||||||||||||
callback |
function |
The callback function. Properties
|
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const zone = compute.zone('us-central1-a');
const instanceGroupManager = zone.instanceGroupManager('web-servers');
const vms = [
gce.zone('us-central1-a').vm('http-server'),
gce.zone('us-central1-a').vm('https-server')
];
instanceGroupManager.abandonInstances(vms, function(err, operation, apiResponse) {
// `operation` is an Operation object that can be used to check the status
// of the request.
});
//-
// If the callback is omitted, we'll return a Promise.
//-
instanceGroupManager.abandonInstances(vms).then(function(data) {
const operation = data[0];
const apiResponse = data[1];
});
deleteInstances(vms, callback)
Flags the specified instances in the managed instance group for immediate deletion.
Parameters:
Name | Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
vms |
VM | Array.<VM> |
VM instances to delete from this instance group manager. |
||||||||||||||||
callback |
function |
The callback function. Properties
|
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const zone = compute.zone('us-central1-a');
const instanceGroupManager = zone.instanceGroupManager('web-servers');
const vms = [
gce.zone('us-central1-a').vm('http-server'),
gce.zone('us-central1-a').vm('https-server')
];
instanceGroupManager.deleteInstances(vms, function(err, operation, apiResponse) {
// `operation` is an Operation object that can be used to check the status
// of the request.
});
//-
// If the callback is omitted, we'll return a Promise.
//-
instanceGroupManager.deleteInstances(vms).then(function(data) {
const operation = data[0];
const apiResponse = data[1];
});
exists(callback)
Check if the instance group manager exists.
Parameters:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
callback |
function |
The callback function. Properties
|
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const zone = compute.zone('us-central1-a');
const instanceGroupManager = zone.instanceGroupManager('web-servers');
instanceGroupManager.exists(function(err, exists) {});
//-
// If the callback is omitted, we'll return a Promise.
//-
instanceGroupManager.exists().then(function(data) {
const exists = data[0];
});
get(optionsopt)
Get an instance group manager if it exists.
You may optionally use this to "get or create" an object by providing an
object with autoCreate
set to true
. Any extra configuration that is
normally required for the create
method must be contained within this
object as well.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
options |
options |
<optional> |
Configuration object. Properties
|
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const zone = compute.zone('us-central1-a');
const instanceGroupManager = zone.instanceGroupManager('web-servers');
instanceGroupManager.get(function(err, instanceGroupManager, apiResponse) {
// `instanceGroupManager` is an InstanceGroupManager object.
});
//-
// If the callback is omitted, we'll return a Promise.
//-
instanceGroupManager.get().then(function(data) {
const instanceGroupManager = data[0];
const apiResponse = data[1];
});
getManagedInstances(optionsopt, callback)
Get a list of managed VM instances in this instance group manager.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
Instance search options. Properties
|
||||||||||||||||||
callback |
function |
The callback function. Properties
|
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const zone = compute.zone('us-central1-a');
const instanceGroupManager = zone.instanceGroupManager('web-servers');
instanceGroupManager.getManagedInstances(function(err, vms) {
// `vms` is an array of `VM` objects.
});
//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, vms, nextQuery, apiResponse) {
if (nextQuery) {
// More results exist.
instanceGroupManager.getManagedInstances(nextQuery, callback);
}
}
instanceGroupManager.getManagedInstances({
autoPaginate: false
}, callback);
//-
// If the callback is omitted, we'll return a Promise.
//-
instanceGroupManager.getManagedInstances().then(function(data) {
const vms = data[0];
});
getMetadata(callbackopt)
Get the instance group manager's metadata.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
callback |
function |
<optional> |
The callback function. Properties
|
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const zone = compute.zone('us-central1-a');
const instanceGroupManager = zone.instanceGroupManager('web-servers');
instanceGroupManager.getMetadata(function(err, metadata, apiResponse) {});
//-
// If the callback is omitted, we'll return a Promise.
//-
instanceGroupManager.getMetadata().then(function(data) {
const metadata = data[0];
const apiResponse = data[1];
});
resize(size, callback)
Resizes the managed instance group.
Parameters:
Name | Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
size |
number |
The number of running instances that the managed instance group should maintain at any given time. |
||||||||||||||||
callback |
function |
The callback function. Properties
|
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const zone = compute.zone('us-central1-a');
const instanceGroupManager = zone.instanceGroupManager('web-servers');
instanceGroupManager.resize(2, function(err, operation, apiResponse) {
// `operation` is an Operation object that can be used to check the status
// of the request.
});
//-
// If the callback is omitted, we'll return a Promise.
//-
instanceGroupManager.resize(2).then(function(data) {
const operation = data[0];
const apiResponse = data[1];
});