Constructor

HealthCheck

new HealthCheck(compute, name, options)

Health checks ensure that Compute Engine forwards new connections only to instances that are up and ready to receive them. Compute Engine sends health check requests to each instance at the specified frequency; once an instance exceeds its allowed number of health check failures, it is no longer considered an eligible instance for receiving new traffic.

Parameter

compute

Compute

Compute object this health check belongs to.

name

string

Name of the health check.

options

Optional

object

Optional configuration.

Values in options have the following properties:

Parameter

https

boolean

Specify if this is an HTTPS health check resource. Default: false

See also

Health Checks Overview

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const healthCheck = gce.healthCheck('health-check-name');

Properties

compute

Compute

The parent Compute instance of this HealthCheck instance.

id

string

Methods

create

create(options)

Create an HTTP or HTTPS health check.

Parameter

options

object

See Compute#createHealthCheck.

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const healthCheck = gce.healthCheck('health-check-name');

healthCheck.create(function(err, healthCheck, operation, apiResponse) {
  // `healthCheck` is a HealthCheck object.

  // `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.
//-
healthCheck.create().then(function(data) {
  const healthCheck = data[0];
  const operation = data[1];
  const apiResponse = data[2];
});

delete

delete(callback)

Delete the health check.

Parameter

callback

Optional

function()

The callback function.

Values in callback have the following properties:

Parameter

err

error

An error returned while making this request.

Value may be null.

operation

Operation

An operation object that can be used to check the status of the request.

apiResponse

object

The full API response.

See also

HttpHealthCheck: delete API Documentation

HttpsHealthCheck: delete API Documentation

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const healthCheck = gce.healthCheck('health-check-name');

healthCheck.delete(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.
//-
healthCheck.delete().then(function(data) {
  const operation = data[0];
  const apiResponse = data[1];
});

exists

exists(callback)

Check if the health check exists.

Parameter

callback

function()

The callback function.

Values in callback have the following properties:

Parameter

err

error

An error returned while making this request.

Value may be null.

exists

boolean

Whether the health check exists or not.

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const healthCheck = gce.healthCheck('health-check-name');

healthCheck.exists(function(err, exists) {});

//-
// If the callback is omitted, we'll return a Promise.
//-
healthCheck.exists().then(function(data) {
  const exists = data[0];
});

get

get(options)

Get the health check 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.

Parameter

options

Optional

options

Configuration object.

Values in options have the following properties:

Parameter

autoCreate

boolean

Automatically create the object if it does not exist. Default: false

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const healthCheck = gce.healthCheck('health-check-name');

healthCheck.get(function(err, healthCheck, apiResponse) {
  // `healthCheck` is a HealthCheck object.
});

//-
// If the callback is omitted, we'll return a Promise.
//-
healthCheck.get().then(function(data) {
  const healthCheck = data[0];
  const apiResponse = data[1];
});

getMetadata

getMetadata(callback)

Get the health check's metadata.

Parameter

callback

Optional

function()

The callback function.

Values in callback have the following properties:

Parameter

err

error

An error returned while making this request.

Value may be null.

metadata

object

The health check's metadata.

apiResponse

object

The full API response.

See also

HttpHealthChecks: get API Documentation

HttpHealthCheck resource

HttpsHealthChecks: get API Documentation

HttpsHealthCheck resource

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const healthCheck = gce.healthCheck('health-check-name');

healthCheck.getMetadata(function(err, metadata, apiResponse) {});

//-
// If the callback is omitted, we'll return a Promise.
//-
healthCheck.getMetadata().then(function(data) {
  const metadata = data[0];
  const apiResponse = data[1];
});

setMetadata

setMetadata(metadata, callback)

Set the health check's metadata.

Parameter

metadata

object

See a HttpHealthCheck resource and HttpsHealthCheck resource.

callback

Optional

function()

The callback function.

Values in callback have the following properties:

Parameter

err

error

An error returned while making this request.

Value may be null.

operation

Operation

An operation object that can be used to check the status of the request.

apiResponse

object

The full API response.

See also

HttpHealthCheck: insert API Documentation

HttpsHealthCheck: insert API Documentation

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const healthCheck = gce.healthCheck('health-check-name');

const metadata = {
  description: 'New description'
};

healthCheck.setMetadata(metadata, 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.
//-
healthCheck.setMetadata(metadata).then(function(data) {
  const operation = data[0];
  const apiResponse = data[1];
});