AlertPolicy (Cloud Monitoring API v3-rev20251006-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.monitoring.v3.model.AlertPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class AlertPolicy
extends com.google.api.client.json.GenericJson
```
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. For an overview of alerting policies, see Introduction to Alerting (https://cloud.google.com/monitoring/alerts/).
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Monitoring API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

AlertPolicy()

Constructors
Constructor and Description
`AlertPolicy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AlertPolicy`	`clone()`
`AlertStrategy`	`getAlertStrategy()` Control over how this alerting policy's notification channels are notified.
`String`	`getCombiner()` How to combine the results of multiple conditions to determine if an incident should be opened.
`List<Condition>`	`getConditions()` A list of conditions for the policy.
`MutationRecord`	`getCreationRecord()` A read-only record of the creation of the alerting policy.
`String`	`getDisplayName()` A short name or phrase used to identify the policy in dashboards, notifications, and incidents.
`Documentation`	`getDocumentation()` Documentation that is included with notifications and incidents related to this policy.
`Boolean`	`getEnabled()` Whether or not the policy is enabled.
`MutationRecord`	`getMutationRecord()` A read-only record of the most recent change to the alerting policy.
`String`	`getName()` Identifier.
`List<String>`	`getNotificationChannels()` Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident.
`String`	`getSeverity()` Optional.
`Map<String,String>`	`getUserLabels()` User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries.
`Status`	`getValidity()` Read-only description of how the alerting policy is invalid.
`AlertPolicy`	`set(String fieldName, Object value)`
`AlertPolicy`	`setAlertStrategy(AlertStrategy alertStrategy)` Control over how this alerting policy's notification channels are notified.
`AlertPolicy`	`setCombiner(String combiner)` How to combine the results of multiple conditions to determine if an incident should be opened.
`AlertPolicy`	`setConditions(List<Condition> conditions)` A list of conditions for the policy.
`AlertPolicy`	`setCreationRecord(MutationRecord creationRecord)` A read-only record of the creation of the alerting policy.
`AlertPolicy`	`setDisplayName(String displayName)` A short name or phrase used to identify the policy in dashboards, notifications, and incidents.
`AlertPolicy`	`setDocumentation(Documentation documentation)` Documentation that is included with notifications and incidents related to this policy.
`AlertPolicy`	`setEnabled(Boolean enabled)` Whether or not the policy is enabled.
`AlertPolicy`	`setMutationRecord(MutationRecord mutationRecord)` A read-only record of the most recent change to the alerting policy.
`AlertPolicy`	`setName(String name)` Identifier.
`AlertPolicy`	`setNotificationChannels(List<String> notificationChannels)` Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident.
`AlertPolicy`	`setSeverity(String severity)` Optional.
`AlertPolicy`	`setUserLabels(Map<String,String> userLabels)` User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries.
`AlertPolicy`	`setValidity(Status validity)` Read-only description of how the alerting policy is invalid.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - AlertPolicy
```
public AlertPolicy()
```
- Method Detail
  - getAlertStrategy
```
public AlertStrategy getAlertStrategy()
```
    Control over how this alerting policy's notification channels are notified.
    
    Returns:
    
    value or null for none
  - setAlertStrategy
```
public AlertPolicy setAlertStrategy(AlertStrategy alertStrategy)
```
    Control over how this alerting policy's notification channels are notified.
    
    Parameters:
    
    alertStrategy - alertStrategy or null for none
  - getCombiner
```
public String getCombiner()
```
    How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.
    
    Returns:
    
    value or null for none
  - setCombiner
```
public AlertPolicy setCombiner(String combiner)
```
    How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.
    
    Parameters:
    
    combiner - combiner or null for none
  - getConditions
```
public List<Condition> getConditions()
```
    A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition. If condition_monitoring_query_language is present, it must be the only condition.
    
    Returns:
    
    value or null for none
  - setConditions
```
public AlertPolicy setConditions(List<Condition> conditions)
```
    A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition. If condition_monitoring_query_language is present, it must be the only condition.
    
    Parameters:
    
    conditions - conditions or null for none
  - getCreationRecord
```
public MutationRecord getCreationRecord()
```
    A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.
    
    Returns:
    
    value or null for none
  - setCreationRecord
```
public AlertPolicy setCreationRecord(MutationRecord creationRecord)
```
    A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.
    
    Parameters:
    
    creationRecord - creationRecord or null for none
  - getDisplayName
```
public String getDisplayName()
```
    A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.The convention for the display_name of a PrometheusQueryLanguageCondition is "{rule group name}/{alert name}", where the {rule group name} and {alert name} should be taken from the corresponding Prometheus configuration file. This convention is not enforced. In any case the display_name is not a unique key of the AlertPolicy.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public AlertPolicy setDisplayName(String displayName)
```
    A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.The convention for the display_name of a PrometheusQueryLanguageCondition is "{rule group name}/{alert name}", where the {rule group name} and {alert name} should be taken from the corresponding Prometheus configuration file. This convention is not enforced. In any case the display_name is not a unique key of the AlertPolicy.
    
    Parameters:
    
    displayName - displayName or null for none
  - getDocumentation
```
public Documentation getDocumentation()
```
    Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.
    
    Returns:
    
    value or null for none
  - setDocumentation
```
public AlertPolicy setDocumentation(Documentation documentation)
```
    Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.
    
    Parameters:
    
    documentation - documentation or null for none
  - getEnabled
```
public Boolean getEnabled()
```
    Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
    
    Returns:
    
    value or null for none
  - setEnabled
```
public AlertPolicy setEnabled(Boolean enabled)
```
    Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
    
    Parameters:
    
    enabled - enabled or null for none
  - getMutationRecord
```
public MutationRecord getMutationRecord()
```
    A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.
    
    Returns:
    
    value or null for none
  - setMutationRecord
```
public AlertPolicy setMutationRecord(MutationRecord mutationRecord)
```
    A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.
    
    Parameters:
    
    mutationRecord - mutationRecord or null for none
  - getName
```
public String getName()
```
    Identifier. Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.
    
    Returns:
    
    value or null for none
  - setName
```
public AlertPolicy setName(String name)
```
    Identifier. Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.
    
    Parameters:
    
    name - name or null for none
  - getNotificationChannels
```
public List<String> getNotificationChannels()
```
    Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
    
    Returns:
    
    value or null for none
  - setNotificationChannels
```
public AlertPolicy setNotificationChannels(List<String> notificationChannels)
```
    Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
    
    Parameters:
    
    notificationChannels - notificationChannels or null for none
  - getSeverity
```
public String getSeverity()
```
    Optional. The severity of an alerting policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications.
    
    Returns:
    
    value or null for none
  - setSeverity
```
public AlertPolicy setSeverity(String severity)
```
    Optional. The severity of an alerting policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications.
    
    Parameters:
    
    severity - severity or null for none
  - getUserLabels
```
public Map<String,String> getUserLabels()
```
    User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.Note that Prometheus {alert name} is a valid Prometheus label names (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels), whereas Prometheus {rule group} is an unrestricted UTF-8 string. This means that they cannot be stored as-is in user labels, because they may contain characters that are not allowed in user-label values.
    
    Returns:
    
    value or null for none
  - setUserLabels
```
public AlertPolicy setUserLabels(Map<String,String> userLabels)
```
    User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.Note that Prometheus {alert name} is a valid Prometheus label names (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels), whereas Prometheus {rule group} is an unrestricted UTF-8 string. This means that they cannot be stored as-is in user labels, because they may contain characters that are not allowed in user-label values.
    
    Parameters:
    
    userLabels - userLabels or null for none
  - getValidity
```
public Status getValidity()
```
    Read-only description of how the alerting policy is invalid. This field is only set when the alerting policy is invalid. An invalid alerting policy will not generate incidents.
    
    Returns:
    
    value or null for none
  - setValidity
```
public AlertPolicy setValidity(Status validity)
```
    Read-only description of how the alerting policy is invalid. This field is only set when the alerting policy is invalid. An invalid alerting policy will not generate incidents.
    
    Parameters:
    
    validity - validity or null for none
  - set
```
public AlertPolicy set(String fieldName,
                       Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public AlertPolicy clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class AlertPolicy

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

AlertPolicy

Method Detail

getAlertStrategy

setAlertStrategy

getCombiner

setCombiner

getConditions

setConditions

getCreationRecord

setCreationRecord

getDisplayName

setDisplayName

getDocumentation

setDocumentation

getEnabled

setEnabled

getMutationRecord

setMutationRecord

getName

setName

getNotificationChannels

setNotificationChannels

getSeverity

setSeverity

getUserLabels

setUserLabels

getValidity

setValidity

set

clone