AlertPolicyServiceClient

AlertPolicyServiceClient

The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Stackdriver Monitoring. An alerting policy is a description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. In addition to using this API, alert policies can also be managed through Stackdriver Monitoring, which can be reached by clicking the "Monitoring" tab in Cloud Console.

Constructor

new AlertPolicyServiceClient(optionsopt)

Construct an instance of AlertPolicyServiceClient.

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

alertPolicyConditionPath(project, alertPolicy, condition) → {String}

Return a fully-qualified alert_policy_condition resource name string.

Parameters:
Name Type Description
project String
alertPolicy String
condition String
Source:

alertPolicyPath(project, alertPolicy) → {String}

Return a fully-qualified alert_policy resource name string.

Parameters:
Name Type Description
project String
alertPolicy String
Source:

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

Creates a new alerting policy.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

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

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

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

Deletes an alerting policy.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The alerting policy to delete. The format is:

  projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

For more information, see AlertPolicy.

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

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

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

Gets a single alerting policy.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The alerting policy to retrieve. The format is

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

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

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:

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

Lists the existing alerting policies for the project.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

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

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

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

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

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

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

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

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

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

matchAlertPolicyFromAlertPolicyConditionName(alertPolicyConditionName) → {String}

Parse the alertPolicyConditionName from a alert_policy_condition resource.

Parameters:
Name Type Description
alertPolicyConditionName String

A fully-qualified path representing a alert_policy_condition resources.

Source:

matchAlertPolicyFromAlertPolicyName(alertPolicyName) → {String}

Parse the alertPolicyName from a alert_policy resource.

Parameters:
Name Type Description
alertPolicyName String

A fully-qualified path representing a alert_policy resources.

Source:

matchConditionFromAlertPolicyConditionName(alertPolicyConditionName) → {String}

Parse the alertPolicyConditionName from a alert_policy_condition resource.

Parameters:
Name Type Description
alertPolicyConditionName String

A fully-qualified path representing a alert_policy_condition resources.

Source:

matchProjectFromAlertPolicyConditionName(alertPolicyConditionName) → {String}

Parse the alertPolicyConditionName from a alert_policy_condition resource.

Parameters:
Name Type Description
alertPolicyConditionName String

A fully-qualified path representing a alert_policy_condition resources.

Source:

matchProjectFromAlertPolicyName(alertPolicyName) → {String}

Parse the alertPolicyName from a alert_policy resource.

Parameters:
Name Type Description
alertPolicyName String

A fully-qualified path representing a alert_policy resources.

Source:

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:

projectPath(project) → {String}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project String
Source:

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

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

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

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