Constructor

AlertPolicyServiceClient

new AlertPolicyServiceClient(options)

Construct an instance of AlertPolicyServiceClient.

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 using 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 below 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

alertPolicyConditionPath

alertPolicyConditionPath(project, alertPolicy, condition) returns String

Return a fully-qualified alert_policy_condition resource name string.

Parameter

project

String

alertPolicy

String

condition

String

Returns

String 

alertPolicyPath

alertPolicyPath(project, alertPolicy) returns String

Return a fully-qualified alert_policy resource name string.

Parameter

project

String

alertPolicy

String

Returns

String 

createAlertPolicy

createAlertPolicy(request, options, callback) returns Promise

Creates a new alerting policy.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The project in which to create the alerting policy. The format is projects/[PROJECT_ID].

Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in the container.

alertPolicy

Object

The requested alerting policy. You should omit the name field in this policy. The name will be returned in the new policy, including a new [ALERT_POLICY_ID] value.

This object should have the same structure as AlertPolicy

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

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing AlertPolicy. 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.AlertPolicyServiceClient({
  // optional auth parameters.
});

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

deleteAlertPolicy

deleteAlertPolicy(request, options, callback) returns Promise

Deletes an alerting policy.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The alerting policy to delete. The format is:

  projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

For more information, see AlertPolicy.

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.AlertPolicyServiceClient({
  // optional auth parameters.
});

var formattedName = client.alertPolicyPath('[PROJECT]', '[ALERT_POLICY]');
client.deleteAlertPolicy({name: formattedName}).catch(err => {
  console.error(err);
});

getAlertPolicy

getAlertPolicy(request, options, callback) returns Promise

Gets a single alerting policy.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The alerting policy to retrieve. The format is

  projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_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 AlertPolicy.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing AlertPolicy. 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.AlertPolicyServiceClient({
  // optional auth parameters.
});

var formattedName = client.alertPolicyPath('[PROJECT]', '[ALERT_POLICY]');
client.getAlertPolicy({name: formattedName})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .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.

listAlertPolicies

listAlertPolicies(request, options, callback) returns Promise

Lists the existing alerting policies for the project.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The project whose alert policies are to be listed. The format is

  projects/[PROJECT_ID]

Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.

filter

Optional

string

If provided, this field specifies the criteria that must be met by alert policies to be included in the response.

For more details, see sorting and filtering.

orderBy

Optional

string

A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.

For more details, see sorting and filtering.

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

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

Returns

Promise 

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

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

    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.AlertPolicyServiceClient({
  // optional auth parameters.
});

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

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

listAlertPoliciesStream

listAlertPoliciesStream(request, options) returns Stream

Equivalent to listAlertPolicies, but returns a NodeJS Stream object.

This fetches the paged responses for listAlertPolicies 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

name

string

The project whose alert policies are to be listed. The format is

  projects/[PROJECT_ID]

Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.

filter

Optional

string

If provided, this field specifies the criteria that must be met by alert policies to be included in the response.

For more details, see sorting and filtering.

orderBy

Optional

string

A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.

For more details, see sorting and filtering.

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

Example

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

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

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

matchAlertPolicyFromAlertPolicyConditionName

matchAlertPolicyFromAlertPolicyConditionName(alertPolicyConditionName) returns String

Parse the alertPolicyConditionName from a alert_policy_condition resource.

Parameter

alertPolicyConditionName

String

A fully-qualified path representing a alert_policy_condition resources.

Returns

String 

  • A string representing the alert_policy.

matchAlertPolicyFromAlertPolicyName

matchAlertPolicyFromAlertPolicyName(alertPolicyName) returns String

Parse the alertPolicyName from a alert_policy resource.

Parameter

alertPolicyName

String

A fully-qualified path representing a alert_policy resources.

Returns

String 

  • A string representing the alert_policy.

matchConditionFromAlertPolicyConditionName

matchConditionFromAlertPolicyConditionName(alertPolicyConditionName) returns String

Parse the alertPolicyConditionName from a alert_policy_condition resource.

Parameter

alertPolicyConditionName

String

A fully-qualified path representing a alert_policy_condition resources.

Returns

String 

  • A string representing the condition.

matchProjectFromAlertPolicyConditionName

matchProjectFromAlertPolicyConditionName(alertPolicyConditionName) returns String

Parse the alertPolicyConditionName from a alert_policy_condition resource.

Parameter

alertPolicyConditionName

String

A fully-qualified path representing a alert_policy_condition resources.

Returns

String 

  • A string representing the project.

matchProjectFromAlertPolicyName

matchProjectFromAlertPolicyName(alertPolicyName) returns String

Parse the alertPolicyName from a alert_policy resource.

Parameter

alertPolicyName

String

A fully-qualified path representing a alert_policy resources.

Returns

String 

  • A string representing the project.

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.

projectPath

projectPath(project) returns String

Return a fully-qualified project resource name string.

Parameter

project

String

Returns

String 

updateAlertPolicy

updateAlertPolicy(request, options, callback) returns Promise

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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

alertPolicy

Object

Required. The updated alerting policy or the updated values for the fields listed in update_mask. If update_mask is not empty, any fields in this policy that are not in update_mask are ignored.

This object should have the same structure as AlertPolicy

updateMask

Optional

Object

Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.

Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.

If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following:

  • The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents.
  • Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created.

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

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing AlertPolicy. 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.AlertPolicyServiceClient({
  // optional auth parameters.
});

var alertPolicy = {};
client.updateAlertPolicy({alertPolicy: alertPolicy})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });