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

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

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

keyFilename

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

number

The port on which to connect to the remote host.

projectId

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.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

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.

Methods

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:

Type	Description
Promise	A promise that resolves when the client is closed.

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

Required. The project in which to create the alerting policy. The format is:

  projects/[PROJECT_ID_OR_NUMBER]

Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a workspace, otherwise INVALID_ARGUMENT error will return. 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/[ALERT_POLICY_ID], identifying the policy in the container.

alertPolicy

google.monitoring.v3.AlertPolicy

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

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing AlertPolicy. Please see the documentation for more details and examples.

Example

const [response] = await client.createAlertPolicy(request);

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

Required. The alerting policy to delete. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]

For more information, see AlertPolicy.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

const [response] = await client.deleteAlertPolicy(request);

folderAlertPolicyConditionPath(folder, alert_policy, condition) → {string}

Return a fully-qualified folderAlertPolicyCondition resource name string.

Parameters:

Name	Type	Description
`folder`	string
`alert_policy`	string
`condition`	string

Returns:

Type	Description
string	Resource name string.

folderAlertPolicyPath(folder, alert_policy) → {string}

Return a fully-qualified folderAlertPolicy resource name string.

Parameters:

Name	Type	Description
`folder`	string
`alert_policy`	string

Returns:

Type	Description
string	Resource name string.

folderChannelDescriptorPath(folder, channel_descriptor) → {string}

Return a fully-qualified folderChannelDescriptor resource name string.

Parameters:

Name	Type	Description
`folder`	string
`channel_descriptor`	string

Returns:

Type	Description
string	Resource name string.

folderGroupPath(folder, group) → {string}

Return a fully-qualified folderGroup resource name string.

Parameters:

Name	Type	Description
`folder`	string
`group`	string

Returns:

Type	Description
string	Resource name string.

folderNotificationChannelPath(folder, notification_channel) → {string}

Return a fully-qualified folderNotificationChannel resource name string.

Parameters:

Name	Type	Description
`folder`	string
`notification_channel`	string

Returns:

Type	Description
string	Resource name string.

folderServicePath(folder, service) → {string}

Return a fully-qualified folderService resource name string.

Parameters:

Name	Type	Description
`folder`	string
`service`	string

Returns:

Type	Description
string	Resource name string.

folderServiceServiceLevelObjectivePath(folder, service, service_level_objective) → {string}

Return a fully-qualified folderServiceServiceLevelObjective resource name string.

Parameters:

Name	Type	Description
`folder`	string
`service`	string
`service_level_objective`	string

Returns:

Type	Description
string	Resource name string.

folderUptimeCheckConfigPath(folder, uptime_check_config) → {string}

Return a fully-qualified folderUptimeCheckConfig resource name string.

Parameters:

Name	Type	Description
`folder`	string
`uptime_check_config`	string

Returns:

Type	Description
string	Resource name string.

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

Required. The alerting policy to retrieve. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing AlertPolicy. Please see the documentation for more details and examples.

Example

const [response] = await client.getAlertPolicy(request);

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:

Type	Description
Promise	A promise that resolves to an authenticated service stub.

listAlertPolicies(request, optionsopt) → {Promise}

Lists the existing alerting policies for the workspace.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	Required. The project whose alert policies are to be listed. The format is: `projects/[PROJECT_ID_OR_NUMBER]` 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	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	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	The maximum number of results to return in a single response.
`pageToken`	string	If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Type	Description
Promise	The promise which resolves to an array. The first element of the array is Array of AlertPolicy. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using `listAlertPoliciesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

Promise

The promise which resolves to an array. The first element of the array is Array of AlertPolicy. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAlertPoliciesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAlertPoliciesAsync(request, optionsopt) → {Object}

Equivalent to listAlertPolicies, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	Required. The project whose alert policies are to be listed. The format is: `projects/[PROJECT_ID_OR_NUMBER]` 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	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	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	The maximum number of results to return in a single response.
`pageToken`	string	If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AlertPolicy. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

const iterable = client.listAlertPoliciesAsync(request);
for await (const response of iterable) {
  // process response
}

listAlertPoliciesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	Required. The project whose alert policies are to be listed. The format is: `projects/[PROJECT_ID_OR_NUMBER]` 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	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	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	The maximum number of results to return in a single response.
`pageToken`	string	If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Type	Description
Stream	An object stream which emits an object representing AlertPolicy on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using `listAlertPoliciesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

Stream

An object stream which emits an object representing AlertPolicy on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAlertPoliciesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchAlertPolicyFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName) → {string}

Parse the alert_policy from FolderAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`folderAlertPolicyConditionName`	string	A fully-qualified path representing folder_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the alert_policy.

matchAlertPolicyFromFolderAlertPolicyName(folderAlertPolicyName) → {string}

Parse the alert_policy from FolderAlertPolicy resource.

Parameters:

Name	Type	Description
`folderAlertPolicyName`	string	A fully-qualified path representing folder_alert_policy resource.

Returns:

Type	Description
string	A string representing the alert_policy.

matchAlertPolicyFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName) → {string}

Parse the alert_policy from OrganizationAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`organizationAlertPolicyConditionName`	string	A fully-qualified path representing organization_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the alert_policy.

matchAlertPolicyFromOrganizationAlertPolicyName(organizationAlertPolicyName) → {string}

Parse the alert_policy from OrganizationAlertPolicy resource.

Parameters:

Name	Type	Description
`organizationAlertPolicyName`	string	A fully-qualified path representing organization_alert_policy resource.

Returns:

Type	Description
string	A string representing the alert_policy.

matchAlertPolicyFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName) → {string}

Parse the alert_policy from ProjectAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`projectAlertPolicyConditionName`	string	A fully-qualified path representing project_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the alert_policy.

matchAlertPolicyFromProjectAlertPolicyName(projectAlertPolicyName) → {string}

Parse the alert_policy from ProjectAlertPolicy resource.

Parameters:

Name	Type	Description
`projectAlertPolicyName`	string	A fully-qualified path representing project_alert_policy resource.

Returns:

Type	Description
string	A string representing the alert_policy.

matchChannelDescriptorFromFolderChannelDescriptorName(folderChannelDescriptorName) → {string}

Parse the channel_descriptor from FolderChannelDescriptor resource.

Parameters:

Name	Type	Description
`folderChannelDescriptorName`	string	A fully-qualified path representing folder_channel_descriptor resource.

Returns:

Type	Description
string	A string representing the channel_descriptor.

matchChannelDescriptorFromOrganizationChannelDescriptorName(organizationChannelDescriptorName) → {string}

Parse the channel_descriptor from OrganizationChannelDescriptor resource.

Parameters:

Name	Type	Description
`organizationChannelDescriptorName`	string	A fully-qualified path representing organization_channel_descriptor resource.

Returns:

Type	Description
string	A string representing the channel_descriptor.

matchChannelDescriptorFromProjectChannelDescriptorName(projectChannelDescriptorName) → {string}

Parse the channel_descriptor from ProjectChannelDescriptor resource.

Parameters:

Name	Type	Description
`projectChannelDescriptorName`	string	A fully-qualified path representing project_channel_descriptor resource.

Returns:

Type	Description
string	A string representing the channel_descriptor.

matchConditionFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName) → {string}

Parse the condition from FolderAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`folderAlertPolicyConditionName`	string	A fully-qualified path representing folder_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the condition.

matchConditionFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName) → {string}

Parse the condition from OrganizationAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`organizationAlertPolicyConditionName`	string	A fully-qualified path representing organization_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the condition.

matchConditionFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName) → {string}

Parse the condition from ProjectAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`projectAlertPolicyConditionName`	string	A fully-qualified path representing project_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the condition.

matchFolderFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName) → {string}

Parse the folder from FolderAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`folderAlertPolicyConditionName`	string	A fully-qualified path representing folder_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderAlertPolicyName(folderAlertPolicyName) → {string}

Parse the folder from FolderAlertPolicy resource.

Parameters:

Name	Type	Description
`folderAlertPolicyName`	string	A fully-qualified path representing folder_alert_policy resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderChannelDescriptorName(folderChannelDescriptorName) → {string}

Parse the folder from FolderChannelDescriptor resource.

Parameters:

Name	Type	Description
`folderChannelDescriptorName`	string	A fully-qualified path representing folder_channel_descriptor resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderGroupName(folderGroupName) → {string}

Parse the folder from FolderGroup resource.

Parameters:

Name	Type	Description
`folderGroupName`	string	A fully-qualified path representing folder_group resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderNotificationChannelName(folderNotificationChannelName) → {string}

Parse the folder from FolderNotificationChannel resource.

Parameters:

Name	Type	Description
`folderNotificationChannelName`	string	A fully-qualified path representing folder_notification_channel resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderServiceName(folderServiceName) → {string}

Parse the folder from FolderService resource.

Parameters:

Name	Type	Description
`folderServiceName`	string	A fully-qualified path representing folder_service resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName) → {string}

Parse the folder from FolderServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`folderServiceServiceLevelObjectiveName`	string	A fully-qualified path representing folder_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName) → {string}

Parse the folder from FolderUptimeCheckConfig resource.

Parameters:

Name	Type	Description
`folderUptimeCheckConfigName`	string	A fully-qualified path representing folder_uptime_check_config resource.

Returns:

Type	Description
string	A string representing the folder.

matchGroupFromFolderGroupName(folderGroupName) → {string}

Parse the group from FolderGroup resource.

Parameters:

Name	Type	Description
`folderGroupName`	string	A fully-qualified path representing folder_group resource.

Returns:

Type	Description
string	A string representing the group.

matchGroupFromOrganizationGroupName(organizationGroupName) → {string}

Parse the group from OrganizationGroup resource.

Parameters:

Name	Type	Description
`organizationGroupName`	string	A fully-qualified path representing organization_group resource.

Returns:

Type	Description
string	A string representing the group.

matchGroupFromProjectGroupName(projectGroupName) → {string}

Parse the group from ProjectGroup resource.

Parameters:

Name	Type	Description
`projectGroupName`	string	A fully-qualified path representing project_group resource.

Returns:

Type	Description
string	A string representing the group.

matchNotificationChannelFromFolderNotificationChannelName(folderNotificationChannelName) → {string}

Parse the notification_channel from FolderNotificationChannel resource.

Parameters:

Name	Type	Description
`folderNotificationChannelName`	string	A fully-qualified path representing folder_notification_channel resource.

Returns:

Type	Description
string	A string representing the notification_channel.

matchNotificationChannelFromOrganizationNotificationChannelName(organizationNotificationChannelName) → {string}

Parse the notification_channel from OrganizationNotificationChannel resource.

Parameters:

Name	Type	Description
`organizationNotificationChannelName`	string	A fully-qualified path representing organization_notification_channel resource.

Returns:

Type	Description
string	A string representing the notification_channel.

matchNotificationChannelFromProjectNotificationChannelName(projectNotificationChannelName) → {string}

Parse the notification_channel from ProjectNotificationChannel resource.

Parameters:

Name	Type	Description
`projectNotificationChannelName`	string	A fully-qualified path representing project_notification_channel resource.

Returns:

Type	Description
string	A string representing the notification_channel.

matchOrganizationFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName) → {string}

Parse the organization from OrganizationAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`organizationAlertPolicyConditionName`	string	A fully-qualified path representing organization_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationAlertPolicyName(organizationAlertPolicyName) → {string}

Parse the organization from OrganizationAlertPolicy resource.

Parameters:

Name	Type	Description
`organizationAlertPolicyName`	string	A fully-qualified path representing organization_alert_policy resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationChannelDescriptorName(organizationChannelDescriptorName) → {string}

Parse the organization from OrganizationChannelDescriptor resource.

Parameters:

Name	Type	Description
`organizationChannelDescriptorName`	string	A fully-qualified path representing organization_channel_descriptor resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationGroupName(organizationGroupName) → {string}

Parse the organization from OrganizationGroup resource.

Parameters:

Name	Type	Description
`organizationGroupName`	string	A fully-qualified path representing organization_group resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationNotificationChannelName(organizationNotificationChannelName) → {string}

Parse the organization from OrganizationNotificationChannel resource.

Parameters:

Name	Type	Description
`organizationNotificationChannelName`	string	A fully-qualified path representing organization_notification_channel resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationServiceName(organizationServiceName) → {string}

Parse the organization from OrganizationService resource.

Parameters:

Name	Type	Description
`organizationServiceName`	string	A fully-qualified path representing organization_service resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName) → {string}

Parse the organization from OrganizationServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`organizationServiceServiceLevelObjectiveName`	string	A fully-qualified path representing organization_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName) → {string}

Parse the organization from OrganizationUptimeCheckConfig resource.

Parameters:

Name	Type	Description
`organizationUptimeCheckConfigName`	string	A fully-qualified path representing organization_uptime_check_config resource.

Returns:

Type	Description
string	A string representing the organization.

matchProjectFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName) → {string}

Parse the project from ProjectAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`projectAlertPolicyConditionName`	string	A fully-qualified path representing project_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectAlertPolicyName(projectAlertPolicyName) → {string}

Parse the project from ProjectAlertPolicy resource.

Parameters:

Name	Type	Description
`projectAlertPolicyName`	string	A fully-qualified path representing project_alert_policy resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectChannelDescriptorName(projectChannelDescriptorName) → {string}

Parse the project from ProjectChannelDescriptor resource.

Parameters:

Name	Type	Description
`projectChannelDescriptorName`	string	A fully-qualified path representing project_channel_descriptor resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectGroupName(projectGroupName) → {string}

Parse the project from ProjectGroup resource.

Parameters:

Name	Type	Description
`projectGroupName`	string	A fully-qualified path representing project_group resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:

Name	Type	Description
`projectName`	string	A fully-qualified path representing Project resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectNotificationChannelName(projectNotificationChannelName) → {string}

Parse the project from ProjectNotificationChannel resource.

Parameters:

Name	Type	Description
`projectNotificationChannelName`	string	A fully-qualified path representing project_notification_channel resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectServiceName(projectServiceName) → {string}

Parse the project from ProjectService resource.

Parameters:

Name	Type	Description
`projectServiceName`	string	A fully-qualified path representing project_service resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName) → {string}

Parse the project from ProjectServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`projectServiceServiceLevelObjectiveName`	string	A fully-qualified path representing project_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName) → {string}

Parse the project from ProjectUptimeCheckConfig resource.

Parameters:

Name	Type	Description
`projectUptimeCheckConfigName`	string	A fully-qualified path representing project_uptime_check_config resource.

Returns:

Type	Description
string	A string representing the project.

matchServiceFromFolderServiceName(folderServiceName) → {string}

Parse the service from FolderService resource.

Parameters:

Name	Type	Description
`folderServiceName`	string	A fully-qualified path representing folder_service resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName) → {string}

Parse the service from FolderServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`folderServiceServiceLevelObjectiveName`	string	A fully-qualified path representing folder_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceFromOrganizationServiceName(organizationServiceName) → {string}

Parse the service from OrganizationService resource.

Parameters:

Name	Type	Description
`organizationServiceName`	string	A fully-qualified path representing organization_service resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName) → {string}

Parse the service from OrganizationServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`organizationServiceServiceLevelObjectiveName`	string	A fully-qualified path representing organization_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceFromProjectServiceName(projectServiceName) → {string}

Parse the service from ProjectService resource.

Parameters:

Name	Type	Description
`projectServiceName`	string	A fully-qualified path representing project_service resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName) → {string}

Parse the service from ProjectServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`projectServiceServiceLevelObjectiveName`	string	A fully-qualified path representing project_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceLevelObjectiveFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName) → {string}

Parse the service_level_objective from FolderServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`folderServiceServiceLevelObjectiveName`	string	A fully-qualified path representing folder_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the service_level_objective.

matchServiceLevelObjectiveFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName) → {string}

Parse the service_level_objective from OrganizationServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`organizationServiceServiceLevelObjectiveName`	string	A fully-qualified path representing organization_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the service_level_objective.

matchServiceLevelObjectiveFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName) → {string}

Parse the service_level_objective from ProjectServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`projectServiceServiceLevelObjectiveName`	string	A fully-qualified path representing project_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the service_level_objective.

matchUptimeCheckConfigFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName) → {string}

Parse the uptime_check_config from FolderUptimeCheckConfig resource.

Parameters:

Name	Type	Description
`folderUptimeCheckConfigName`	string	A fully-qualified path representing folder_uptime_check_config resource.

Returns:

Type	Description
string	A string representing the uptime_check_config.

matchUptimeCheckConfigFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName) → {string}

Parse the uptime_check_config from OrganizationUptimeCheckConfig resource.

Parameters:

Name	Type	Description
`organizationUptimeCheckConfigName`	string	A fully-qualified path representing organization_uptime_check_config resource.

Returns:

Type	Description
string	A string representing the uptime_check_config.

matchUptimeCheckConfigFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName) → {string}

Parse the uptime_check_config from ProjectUptimeCheckConfig resource.

Parameters:

Name	Type	Description
`projectUptimeCheckConfigName`	string	A fully-qualified path representing project_uptime_check_config resource.

Returns:

Type	Description
string	A string representing the uptime_check_config.

organizationAlertPolicyConditionPath(organization, alert_policy, condition) → {string}

Return a fully-qualified organizationAlertPolicyCondition resource name string.

Parameters:

Name	Type	Description
`organization`	string
`alert_policy`	string
`condition`	string

Returns:

Type	Description
string	Resource name string.

organizationAlertPolicyPath(organization, alert_policy) → {string}

Return a fully-qualified organizationAlertPolicy resource name string.

Parameters:

Name	Type	Description
`organization`	string
`alert_policy`	string

Returns:

Type	Description
string	Resource name string.

organizationChannelDescriptorPath(organization, channel_descriptor) → {string}

Return a fully-qualified organizationChannelDescriptor resource name string.

Parameters:

Name	Type	Description
`organization`	string
`channel_descriptor`	string

Returns:

Type	Description
string	Resource name string.

organizationGroupPath(organization, group) → {string}

Return a fully-qualified organizationGroup resource name string.

Parameters:

Name	Type	Description
`organization`	string
`group`	string

Returns:

Type	Description
string	Resource name string.

organizationNotificationChannelPath(organization, notification_channel) → {string}

Return a fully-qualified organizationNotificationChannel resource name string.

Parameters:

Name	Type	Description
`organization`	string
`notification_channel`	string

Returns:

Type	Description
string	Resource name string.

organizationServicePath(organization, service) → {string}

Return a fully-qualified organizationService resource name string.

Parameters:

Name	Type	Description
`organization`	string
`service`	string

Returns:

Type	Description
string	Resource name string.

organizationServiceServiceLevelObjectivePath(organization, service, service_level_objective) → {string}

Return a fully-qualified organizationServiceServiceLevelObjective resource name string.

Parameters:

Name	Type	Description
`organization`	string
`service`	string
`service_level_objective`	string

Returns:

Type	Description
string	Resource name string.

organizationUptimeCheckConfigPath(organization, uptime_check_config) → {string}

Return a fully-qualified organizationUptimeCheckConfig resource name string.

Parameters:

Name	Type	Description
`organization`	string
`uptime_check_config`	string

Returns:

Type	Description
string	Resource name string.

projectAlertPolicyConditionPath(project, alert_policy, condition) → {string}

Return a fully-qualified projectAlertPolicyCondition resource name string.

Parameters:

Name	Type	Description
`project`	string
`alert_policy`	string
`condition`	string

Returns:

Type	Description
string	Resource name string.

projectAlertPolicyPath(project, alert_policy) → {string}

Return a fully-qualified projectAlertPolicy resource name string.

Parameters:

Name	Type	Description
`project`	string
`alert_policy`	string

Returns:

Type	Description
string	Resource name string.

projectChannelDescriptorPath(project, channel_descriptor) → {string}

Return a fully-qualified projectChannelDescriptor resource name string.

Parameters:

Name	Type	Description
`project`	string
`channel_descriptor`	string

Returns:

Type	Description
string	Resource name string.

projectGroupPath(project, group) → {string}

Return a fully-qualified projectGroup resource name string.

Parameters:

Name	Type	Description
`project`	string
`group`	string

Returns:

Type	Description
string	Resource name string.

projectNotificationChannelPath(project, notification_channel) → {string}

Return a fully-qualified projectNotificationChannel resource name string.

Parameters:

Name	Type	Description
`project`	string
`notification_channel`	string

Returns:

Type	Description
string	Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

projectServicePath(project, service) → {string}

Return a fully-qualified projectService resource name string.

Parameters:

Name	Type	Description
`project`	string
`service`	string

Returns:

Type	Description
string	Resource name string.

projectServiceServiceLevelObjectivePath(project, service, service_level_objective) → {string}

Return a fully-qualified projectServiceServiceLevelObjective resource name string.

Parameters:

Name	Type	Description
`project`	string
`service`	string
`service_level_objective`	string

Returns:

Type	Description
string	Resource name string.

projectUptimeCheckConfigPath(project, uptime_check_config) → {string}

Return a fully-qualified projectUptimeCheckConfig resource name string.

Parameters:

Name	Type	Description
`project`	string
`uptime_check_config`	string

Returns:

Type	Description
string	Resource name string.

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

updateMask

google.protobuf.FieldMask

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.

alertPolicy

google.monitoring.v3.AlertPolicy

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.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing AlertPolicy. Please see the documentation for more details and examples.

Example

const [response] = await client.updateAlertPolicy(request);