AlertPolicy (proto-google-cloud-monitoring-v3 3.52.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.monitoring.v3.AlertPolicy

All Implemented Interfaces:: AlertPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class AlertPolicy
extends com.google.protobuf.GeneratedMessageV3
implements AlertPolicyOrBuilder

 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 alert policies, see
 [Introduction to Alerting](https://cloud.google.com/monitoring/alerts/).

Protobuf type google.monitoring.v3.AlertPolicy

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AlertPolicy.AlertStrategy` Control over how the notification channels in `notification_channels` are notified when this alert fires.
`static interface`	`AlertPolicy.AlertStrategyOrBuilder`
`static class`	`AlertPolicy.Builder` 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.
`static class`	`AlertPolicy.Condition` A condition is a true/false test that determines when an alerting policy should open an incident.
`static class`	`AlertPolicy.ConditionCombinerType` Operators for combining conditions.
`static interface`	`AlertPolicy.ConditionOrBuilder`
`static class`	`AlertPolicy.Documentation` Documentation that is included in the notifications and incidents pertaining to this policy.
`static interface`	`AlertPolicy.DocumentationOrBuilder`
`static class`	`AlertPolicy.Severity` An enumeration of possible severity level for an Alert Policy.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALERT_STRATEGY_FIELD_NUMBER`
`static int`	`COMBINER_FIELD_NUMBER`
`static int`	`CONDITIONS_FIELD_NUMBER`
`static int`	`CREATION_RECORD_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`DOCUMENTATION_FIELD_NUMBER`
`static int`	`ENABLED_FIELD_NUMBER`
`static int`	`MUTATION_RECORD_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`NOTIFICATION_CHANNELS_FIELD_NUMBER`
`static int`	`SEVERITY_FIELD_NUMBER`
`static int`	`USER_LABELS_FIELD_NUMBER`
`static int`	`VALIDITY_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsUserLabels(String key)` User-supplied key/value data to be used for organizing and identifying the `AlertPolicy` objects.
`boolean`	`equals(Object obj)`
`AlertPolicy.AlertStrategy`	`getAlertStrategy()` Control over how this alert policy's notification channels are notified.
`AlertPolicy.AlertStrategyOrBuilder`	`getAlertStrategyOrBuilder()` Control over how this alert policy's notification channels are notified.
`AlertPolicy.ConditionCombinerType`	`getCombiner()` How to combine the results of multiple conditions to determine if an incident should be opened.
`int`	`getCombinerValue()` How to combine the results of multiple conditions to determine if an incident should be opened.
`AlertPolicy.Condition`	`getConditions(int index)` A list of conditions for the policy.
`int`	`getConditionsCount()` A list of conditions for the policy.
`List<AlertPolicy.Condition>`	`getConditionsList()` A list of conditions for the policy.
`AlertPolicy.ConditionOrBuilder`	`getConditionsOrBuilder(int index)` A list of conditions for the policy.
`List<? extends AlertPolicy.ConditionOrBuilder>`	`getConditionsOrBuilderList()` A list of conditions for the policy.
`MutationRecord`	`getCreationRecord()` A read-only record of the creation of the alerting policy.
`MutationRecordOrBuilder`	`getCreationRecordOrBuilder()` A read-only record of the creation of the alerting policy.
`static AlertPolicy`	`getDefaultInstance()`
`AlertPolicy`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDisplayName()` A short name or phrase used to identify the policy in dashboards, notifications, and incidents.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` A short name or phrase used to identify the policy in dashboards, notifications, and incidents.
`AlertPolicy.Documentation`	`getDocumentation()` Documentation that is included with notifications and incidents related to this policy.
`AlertPolicy.DocumentationOrBuilder`	`getDocumentationOrBuilder()` Documentation that is included with notifications and incidents related to this policy.
`com.google.protobuf.BoolValue`	`getEnabled()` Whether or not the policy is enabled.
`com.google.protobuf.BoolValueOrBuilder`	`getEnabledOrBuilder()` Whether or not the policy is enabled.
`MutationRecord`	`getMutationRecord()` A read-only record of the most recent change to the alerting policy.
`MutationRecordOrBuilder`	`getMutationRecordOrBuilder()` A read-only record of the most recent change to the alerting policy.
`String`	`getName()` Required if the policy exists.
`com.google.protobuf.ByteString`	`getNameBytes()` Required if the policy exists.
`String`	`getNotificationChannels(int index)` 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.
`com.google.protobuf.ByteString`	`getNotificationChannelsBytes(int index)` 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.
`int`	`getNotificationChannelsCount()` 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.
`com.google.protobuf.ProtocolStringList`	`getNotificationChannelsList()` 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.
`com.google.protobuf.Parser<AlertPolicy>`	`getParserForType()`
`int`	`getSerializedSize()`
`AlertPolicy.Severity`	`getSeverity()` Optional.
`int`	`getSeverityValue()` Optional.
`Map<String,String>`	`getUserLabels()` Deprecated.
`int`	`getUserLabelsCount()` User-supplied key/value data to be used for organizing and identifying the `AlertPolicy` objects.
`Map<String,String>`	`getUserLabelsMap()` User-supplied key/value data to be used for organizing and identifying the `AlertPolicy` objects.
`String`	`getUserLabelsOrDefault(String key, String defaultValue)` User-supplied key/value data to be used for organizing and identifying the `AlertPolicy` objects.
`String`	`getUserLabelsOrThrow(String key)` User-supplied key/value data to be used for organizing and identifying the `AlertPolicy` objects.
`com.google.rpc.Status`	`getValidity()` Read-only description of how the alert policy is invalid.
`com.google.rpc.StatusOrBuilder`	`getValidityOrBuilder()` Read-only description of how the alert policy is invalid.
`boolean`	`hasAlertStrategy()` Control over how this alert policy's notification channels are notified.
`boolean`	`hasCreationRecord()` A read-only record of the creation of the alerting policy.
`boolean`	`hasDocumentation()` Documentation that is included with notifications and incidents related to this policy.
`boolean`	`hasEnabled()` Whether or not the policy is enabled.
`int`	`hashCode()`
`boolean`	`hasMutationRecord()` A read-only record of the most recent change to the alerting policy.
`boolean`	`hasValidity()` Read-only description of how the alert policy is invalid.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static AlertPolicy.Builder`	`newBuilder()`
`static AlertPolicy.Builder`	`newBuilder(AlertPolicy prototype)`
`AlertPolicy.Builder`	`newBuilderForType()`
`protected AlertPolicy.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static AlertPolicy`	`parseDelimitedFrom(InputStream input)`
`static AlertPolicy`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AlertPolicy`	`parseFrom(byte[] data)`
`static AlertPolicy`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AlertPolicy`	`parseFrom(ByteBuffer data)`
`static AlertPolicy`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AlertPolicy`	`parseFrom(com.google.protobuf.ByteString data)`
`static AlertPolicy`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AlertPolicy`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static AlertPolicy`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AlertPolicy`	`parseFrom(InputStream input)`
`static AlertPolicy`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<AlertPolicy>`	`parser()`
`AlertPolicy.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DOCUMENTATION_FIELD_NUMBER
```
public static final int DOCUMENTATION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_LABELS_FIELD_NUMBER
```
public static final int USER_LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONDITIONS_FIELD_NUMBER
```
public static final int CONDITIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- COMBINER_FIELD_NUMBER
```
public static final int COMBINER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ENABLED_FIELD_NUMBER
```
public static final int ENABLED_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- VALIDITY_FIELD_NUMBER
```
public static final int VALIDITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NOTIFICATION_CHANNELS_FIELD_NUMBER
```
public static final int NOTIFICATION_CHANNELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATION_RECORD_FIELD_NUMBER
```
public static final int CREATION_RECORD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MUTATION_RECORD_FIELD_NUMBER
```
public static final int MUTATION_RECORD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ALERT_STRATEGY_FIELD_NUMBER
```
public static final int ALERT_STRATEGY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SEVERITY_FIELD_NUMBER
```
public static final int SEVERITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 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][google.monitoring.v3.AlertPolicyService.CreateAlertPolicy]
 method, do not include the `name` field in the alerting policy passed as
 part of the request.

string name = 1;

Specified by:: getName in interface AlertPolicyOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 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][google.monitoring.v3.AlertPolicyService.CreateAlertPolicy]
 method, do not include the `name` field in the alerting policy passed as
 part of the request.

string name = 1;

Specified by:: getNameBytes in interface AlertPolicyOrBuilder
Returns:: The bytes for name.

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.

string display_name = 2;

Specified by:: getDisplayName in interface AlertPolicyOrBuilder
Returns:: The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 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.

string display_name = 2;

Specified by:: getDisplayNameBytes in interface AlertPolicyOrBuilder
Returns:: The bytes for displayName.

hasDocumentation

public boolean hasDocumentation()

 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.

.google.monitoring.v3.AlertPolicy.Documentation documentation = 13;

Specified by:: hasDocumentation in interface AlertPolicyOrBuilder
Returns:: Whether the documentation field is set.

getDocumentation

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

.google.monitoring.v3.AlertPolicy.Documentation documentation = 13;

Specified by:: getDocumentation in interface AlertPolicyOrBuilder
Returns:: The documentation.

getDocumentationOrBuilder

public AlertPolicy.DocumentationOrBuilder getDocumentationOrBuilder()

 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.

.google.monitoring.v3.AlertPolicy.Documentation documentation = 13;

Specified by:: getDocumentationOrBuilder in interface AlertPolicyOrBuilder