v3.AlertPolicyServiceClient

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.

alertPolicyConditionPath(project, alertPolicy, condition) → String

Return a fully-qualified alert_policy_condition resource name string.

Returns

String 

alertPolicyPath(project, alertPolicy) → String

Return a fully-qualified alert_policy resource name string.

Returns

String 

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

Creates a new alerting policy.

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

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

const formattedName = client.projectPath('[PROJECT]');
const alertPolicy = {};
const request = {
  name: formattedName,
  alertPolicy: alertPolicy,
};
client.createAlertPolicy(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 AlertPolicy. The promise has a method named "cancel" which cancels the ongoing API call.

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

Deletes an alerting policy.

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

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

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

  projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

Returns

Promise 

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

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

Gets a single alerting policy.

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

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

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

  projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

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.

getProjectId(callback)

Return the project ID used by this class.

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

Lists the existing alerting policies for the project.

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

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

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

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

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

  projects/[PROJECT_ID]

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.

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

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

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

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

  projects/[PROJECT_ID]

See also

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

Returns

Stream 

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

matchAlertPolicyFromAlertPolicyConditionName(alertPolicyConditionName) → String

Parse the alertPolicyConditionName from a alert_policy_condition resource.

Returns

String 

• A string representing the alert_policy.

matchAlertPolicyFromAlertPolicyName(alertPolicyName) → String

Parse the alertPolicyName from a alert_policy resource.

Returns

String 

• A string representing the alert_policy.

matchConditionFromAlertPolicyConditionName(alertPolicyConditionName) → String

Parse the alertPolicyConditionName from a alert_policy_condition resource.

Returns

String 

• A string representing the condition.

matchProjectFromAlertPolicyConditionName(alertPolicyConditionName) → String

Parse the alertPolicyConditionName from a alert_policy_condition resource.

Returns

String 

• A string representing the project.

matchProjectFromAlertPolicyName(alertPolicyName) → String

Parse the alertPolicyName from a alert_policy resource.

Returns

String 

• A string representing the project.

matchProjectFromProjectName(projectName) → String

Parse the projectName from a project resource.

Returns

String 

• A string representing the project.

projectPath(project) → String

Return a fully-qualified project resource name string.

Returns

String 

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

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

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

const alertPolicy = {};
client.updateAlertPolicy({alertPolicy: alertPolicy})
  .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 AlertPolicy. The promise has a method named "cancel" which cancels the ongoing API call.