v3.UptimeCheckServiceClient

Parameters

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

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.

createUptimeCheckConfig(request[, options][, callback]) → Promise

Creates a new uptime check configuration.

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

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

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

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.

deleteUptimeCheckConfig(request[, options][, callback]) → 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.

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

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

const formattedName = client.uptimeCheckConfigPath('[PROJECT]', '[UPTIME_CHECK_CONFIG]');
client.deleteUptimeCheckConfig({name: formattedName}).catch(err => {
  console.error(err);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

getProjectId(callback)

Return the project ID used by this class.

getUptimeCheckConfig(request[, options][, callback]) → Promise

Gets a single uptime check configuration.

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

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

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

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.

listUptimeCheckConfigs(request[, options][, callback]) → Promise

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

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

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

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

client.listUptimeCheckConfigs({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.projectPath('[PROJECT]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  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);
  });

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.

listUptimeCheckConfigsStream(request[, options]) → 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.

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

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

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

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing UptimeCheckConfig on 'data' event.

listUptimeCheckIps(request[, options][, callback]) → Promise

Returns the list of IPs that checkers run from

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

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

// Iterate over all elements.
client.listUptimeCheckIps({})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.

const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listUptimeCheckIps(nextRequest, options).then(callback);
  }
}
client.listUptimeCheckIps({}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

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.

listUptimeCheckIpsStream(request[, options]) → 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.

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

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


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

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing UptimeCheckIp on 'data' event.

matchProjectFromProjectName(projectName) → String

Parse the projectName from a project resource.

Returns

String 

• A string representing the project.

matchProjectFromUptimeCheckConfigName(uptimeCheckConfigName) → String

Parse the uptimeCheckConfigName from a uptime_check_config resource.

Returns

String 

• A string representing the project.

matchUptimeCheckConfigFromUptimeCheckConfigName(uptimeCheckConfigName) → String

Parse the uptimeCheckConfigName from a uptime_check_config resource.

Returns

String 

• A string representing the uptime_check_config.

projectPath(project) → String

Return a fully-qualified project resource name string.

Returns

String 

updateUptimeCheckConfig(request[, options][, callback]) → 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.

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

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

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

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.

uptimeCheckConfigPath(project, uptimeCheckConfig) → String

Return a fully-qualified uptime_check_config resource name string.

Returns

String