UptimeCheckServiceClient

UptimeCheckServiceClient

The UptimeCheckService API is used to manage (list, create, delete, edit) Uptime check configurations in the Stackdriver Monitoring product. An Uptime check is a piece of configuration that determines which resources and services to monitor for availability. These configurations can also be configured interactively by navigating to the [Cloud Console] (http://console.cloud.google.com), selecting the appropriate project, clicking on "Monitoring" on the left-hand side to navigate to Stackdriver, and then clicking on "Uptime".

Constructor

new UptimeCheckServiceClient(optionsopt)

Construct an instance of UptimeCheckServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

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

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

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

keyFilename string <optional>

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 below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

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 function <optional>

Custom promise module to use instead of native Promises.

apiEndpoint string <optional>

The domain name of the API remote host.

Source:

Members

(static) apiEndpoint

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

Source:

(static) port

The port for this API service.

Source:

(static) scopes

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

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

createUptimeCheckConfig(request, optionsopt, callbackopt) → {Promise}

Creates a new Uptime check configuration.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
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 Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing UptimeCheckConfig.

Source:
Example
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);
  });

deleteUptimeCheckConfig(request, optionsopt, callbackopt) → {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.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The Uptime check configuration to delete. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

Source:
Example
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);
});

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.

Source:

getUptimeCheckConfig(request, optionsopt, callbackopt) → {Promise}

Gets a single Uptime check configuration.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The Uptime check configuration to retrieve. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing UptimeCheckConfig.

Source:
Example
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);
  });

listUptimeCheckConfigs(request, optionsopt, callbackopt) → {Promise}

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

The project whose Uptime check configurations are listed. The format is projects/[PROJECT_ID].

pageSize number <optional>

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 Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

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.

Source:
Example
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);
  });

listUptimeCheckConfigsStream(request, optionsopt) → {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.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

The project whose Uptime check configurations are listed. The format is projects/[PROJECT_ID].

pageSize number <optional>

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 Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Source:
See:
Example
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);
  });

listUptimeCheckIps(request, optionsopt, callbackopt) → {Promise}

Returns the list of IP addresses that checkers run from

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
pageSize number <optional>

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 Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

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.

Source:
Example
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);
  });

listUptimeCheckIpsStream(request, optionsopt) → {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.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
pageSize number <optional>

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 Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Source:
See:
Example
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);
  });

matchProjectFromProjectName(projectName) → {String}

Parse the projectName from a project resource.

Parameters:
Name Type Description
projectName String

A fully-qualified path representing a project resources.

Source:

matchProjectFromUptimeCheckConfigName(uptimeCheckConfigName) → {String}

Parse the uptimeCheckConfigName from a uptime_check_config resource.

Parameters:
Name Type Description
uptimeCheckConfigName String

A fully-qualified path representing a uptime_check_config resources.

Source:

matchUptimeCheckConfigFromUptimeCheckConfigName(uptimeCheckConfigName) → {String}

Parse the uptimeCheckConfigName from a uptime_check_config resource.

Parameters:
Name Type Description
uptimeCheckConfigName String

A fully-qualified path representing a uptime_check_config resources.

Source:

projectPath(project) → {String}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project String
Source:

updateUptimeCheckConfig(request, optionsopt, callbackopt) → {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.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
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.

The following fields can be updated: display_name, http_check, tcp_check, timeout, content_matchers, and selected_regions.

This object should have the same structure as UptimeCheckConfig

updateMask Object <optional>

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 Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing UptimeCheckConfig.

Source:
Example
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);
  });

uptimeCheckConfigPath(project, uptimeCheckConfig) → {String}

Return a fully-qualified uptime_check_config resource name string.

Parameters:
Name Type Description
project String
uptimeCheckConfig String
Source: