Constructor

UptimeCheckServiceClient

new UptimeCheckServiceClient(options)

Construct an instance of UptimeCheckServiceClient.

Parameter

options

Optional

object

The configuration object. See the subsequent parameters for more details.

Values in options have the following properties:

Parameter

credentials

Optional

object

Credentials object.

credentials.client_email

Optional

string

credentials.private_key

Optional

string

email

Optional

string

Account email address. Required when usaing a .pem or .p12 keyFilename.

keyFilename

Optional

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option above is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

Optional

number

The port on which to connect to the remote host.

projectId

Optional

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

promise

Optional

function()

Custom promise module to use instead of native Promises.

servicePath

Optional

string

The domain name of the API remote host.

Properties

port

static

The port for this API service.

scopes

static

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static

The DNS address for this API service.

Methods

createUptimeCheckConfig

createUptimeCheckConfig(request, options, callback) returns Promise

Creates a new uptime check configuration.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

The project in which to create the uptime check. The format is:

`projects/[PROJECT_ID]`.

uptimeCheckConfig

Object

The new uptime check configuration.

This object should have the same structure as UptimeCheckConfig

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 UptimeCheckConfig.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing UptimeCheckConfig. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const monitoring = require('@google-cloud/monitoring');

var client = new monitoring.v3.UptimeCheckServiceClient({
  // optional auth parameters.
});

var formattedParent = client.projectPath('[PROJECT]');
var uptimeCheckConfig = {};
var request = {
  parent: formattedParent,
  uptimeCheckConfig: uptimeCheckConfig,
};
client.createUptimeCheckConfig(request)
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

deleteUptimeCheckConfig

deleteUptimeCheckConfig(request, options, callback) returns Promise

Deletes an uptime check configuration. Note that this method will fail if the uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The uptime check configuration to delete. The format is

`projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.

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 monitoring = require('@google-cloud/monitoring');

var client = new monitoring.v3.UptimeCheckServiceClient({
  // optional auth parameters.
});

var formattedName = client.uptimeCheckConfigPath('[PROJECT]', '[UPTIME_CHECK_CONFIG]');
client.deleteUptimeCheckConfig({name: formattedName}).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.

getUptimeCheckConfig

getUptimeCheckConfig(request, options, callback) returns Promise

Gets a single uptime check configuration.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The uptime check configuration to retrieve. The format is

`projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.

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 UptimeCheckConfig.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing UptimeCheckConfig. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const monitoring = require('@google-cloud/monitoring');

var client = new monitoring.v3.UptimeCheckServiceClient({
  // optional auth parameters.
});

var formattedName = client.uptimeCheckConfigPath('[PROJECT]', '[UPTIME_CHECK_CONFIG]');
client.getUptimeCheckConfig({name: formattedName})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

listUptimeCheckConfigs

listUptimeCheckConfigs(request, options, callback) returns Promise

Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

The project whose uptime check configurations are listed. The format is

`projects/[PROJECT_ID]`.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

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 UptimeCheckConfig.

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 ListUptimeCheckConfigsResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of UptimeCheckConfig.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of UptimeCheckConfig 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 ListUptimeCheckConfigsResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example

const monitoring = require('@google-cloud/monitoring');

var client = new monitoring.v3.UptimeCheckServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
var formattedParent = client.projectPath('[PROJECT]');

client.listUptimeCheckConfigs({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.projectPath('[PROJECT]');


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.listUptimeCheckConfigs(nextRequest, options).then(callback);
  }
}
client.listUptimeCheckConfigs({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listUptimeCheckConfigsStream

listUptimeCheckConfigsStream(request, options) returns Stream

Equivalent to listUptimeCheckConfigs, but returns a NodeJS Stream object.

This fetches the paged responses for listUptimeCheckConfigs 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 request have the following properties:

Parameter

parent

string

The project whose uptime check configurations are listed. The format is

`projects/[PROJECT_ID]`.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

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 UptimeCheckConfig on 'data' event.

Example

const monitoring = require('@google-cloud/monitoring');

var client = new monitoring.v3.UptimeCheckServiceClient({
  // optional auth parameters.
});

var formattedParent = client.projectPath('[PROJECT]');
client.listUptimeCheckConfigsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

listUptimeCheckIps

listUptimeCheckIps(request, options, callback) returns Promise

Returns the list of IPs that checkers run from

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

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 UptimeCheckIp.

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 ListUptimeCheckIpsResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of UptimeCheckIp.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of UptimeCheckIp 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 ListUptimeCheckIpsResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example

const monitoring = require('@google-cloud/monitoring');

var client = new monitoring.v3.UptimeCheckServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
client.listUptimeCheckIps({})
  .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 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.listUptimeCheckIps(nextRequest, options).then(callback);
  }
}
client.listUptimeCheckIps({}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listUptimeCheckIpsStream

listUptimeCheckIpsStream(request, options) returns Stream

Equivalent to listUptimeCheckIps, but returns a NodeJS Stream object.

This fetches the paged responses for listUptimeCheckIps 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 request have the following properties:

Parameter

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

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 UptimeCheckIp on 'data' event.

Example

const monitoring = require('@google-cloud/monitoring');

var client = new monitoring.v3.UptimeCheckServiceClient({
  // optional auth parameters.
});


client.listUptimeCheckIpsStream({})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

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.

matchProjectFromUptimeCheckConfigName

matchProjectFromUptimeCheckConfigName(uptimeCheckConfigName) returns String

Parse the uptimeCheckConfigName from a uptime_check_config resource.

Parameter

uptimeCheckConfigName

String

A fully-qualified path representing a uptime_check_config resources.

Returns

String 

  • A string representing the project.

matchUptimeCheckConfigFromUptimeCheckConfigName

matchUptimeCheckConfigFromUptimeCheckConfigName(uptimeCheckConfigName) returns String

Parse the uptimeCheckConfigName from a uptime_check_config resource.

Parameter

uptimeCheckConfigName

String

A fully-qualified path representing a uptime_check_config resources.

Returns

String 

  • A string representing the uptime_check_config.

projectPath

projectPath(project) returns String

Return a fully-qualified project resource name string.

Parameter

project

String

Returns

String 

updateUptimeCheckConfig

updateUptimeCheckConfig(request, options, callback) returns Promise

Updates an uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via "updateMask". Returns the updated configuration.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The uptime check configuration to update. The format is

`projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.

uptimeCheckConfig

Object

Required. If an "updateMask" has been specified, this field gives the values for the set of fields mentioned in the "updateMask". If an "updateMask" has not been given, this uptime check configuration replaces the current configuration. If a field is mentioned in "updateMask" but the corresonding field is omitted in this partial uptime check configuration, it has the effect of deleting/clearing the field from the configuration on the server.

This object should have the same structure as UptimeCheckConfig

updateMask

Optional

Object

Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.

This object should have the same structure as FieldMask

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 UptimeCheckConfig.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing UptimeCheckConfig. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const monitoring = require('@google-cloud/monitoring');

var client = new monitoring.v3.UptimeCheckServiceClient({
  // optional auth parameters.
});

var name = '';
var uptimeCheckConfig = {};
var request = {
  name: name,
  uptimeCheckConfig: uptimeCheckConfig,
};
client.updateUptimeCheckConfig(request)
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

uptimeCheckConfigPath

uptimeCheckConfigPath(project, uptimeCheckConfig) returns String

Return a fully-qualified uptime_check_config resource name string.

Parameter

project

String

uptimeCheckConfig

String

Returns

String