AlertPolicy (java 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, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class AlertPolicy
extends 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](/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.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` A content string and a MIME type that describes the content string's format.
`static interface`	`AlertPolicy.DocumentationOrBuilder`

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

Field Summary

Fields
Modifier and Type	Field and Description
`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`	`USER_LABELS_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(java.lang.String key)` User-supplied key/value data to be used for organizing and identifying the `AlertPolicy` objects.
`boolean`	`equals(java.lang.Object obj)`
`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.
`java.util.List<AlertPolicy.Condition>`	`getConditionsList()` A list of conditions for the policy.
`AlertPolicy.ConditionOrBuilder`	`getConditionsOrBuilder(int index)` A list of conditions for the policy.
`java.util.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 Descriptors.Descriptor`	`getDescriptor()`
`java.lang.String`	`getDisplayName()` A short name or phrase used to identify the policy in dashboards, notifications, and incidents.
`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.
`BoolValue`	`getEnabled()` Whether or not the policy is enabled.
`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.
`java.lang.String`	`getName()` Required if the policy exists.
`ByteString`	`getNameBytes()` Required if the policy exists.
`java.lang.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.
`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.
`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.
`Parser<AlertPolicy>`	`getParserForType()`
`int`	`getSerializedSize()`
`UnknownFieldSet`	`getUnknownFields()`
`java.util.Map<java.lang.String,java.lang.String>`	`getUserLabels()` Deprecated.
`int`	`getUserLabelsCount()` User-supplied key/value data to be used for organizing and identifying the `AlertPolicy` objects.
`java.util.Map<java.lang.String,java.lang.String>`	`getUserLabelsMap()` User-supplied key/value data to be used for organizing and identifying the `AlertPolicy` objects.
`java.lang.String`	`getUserLabelsOrDefault(java.lang.String key, java.lang.String defaultValue)` User-supplied key/value data to be used for organizing and identifying the `AlertPolicy` objects.
`java.lang.String`	`getUserLabelsOrThrow(java.lang.String key)` User-supplied key/value data to be used for organizing and identifying the `AlertPolicy` objects.
`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.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static AlertPolicy.Builder`	`newBuilder()`
`static AlertPolicy.Builder`	`newBuilder(AlertPolicy prototype)`
`AlertPolicy.Builder`	`newBuilderForType()`
`protected AlertPolicy.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`static AlertPolicy`	`parseDelimitedFrom(java.io.InputStream input)`
`static AlertPolicy`	`parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static AlertPolicy`	`parseFrom(byte[] data)`
`static AlertPolicy`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static AlertPolicy`	`parseFrom(java.nio.ByteBuffer data)`
`static AlertPolicy`	`parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static AlertPolicy`	`parseFrom(ByteString data)`
`static AlertPolicy`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static AlertPolicy`	`parseFrom(CodedInputStream input)`
`static AlertPolicy`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static AlertPolicy`	`parseFrom(java.io.InputStream input)`
`static AlertPolicy`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<AlertPolicy>`	`parser()`
`AlertPolicy.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

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

Method Detail

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class GeneratedMessageV3

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getName

public java.lang.String getName()

 Required if the policy exists. The resource name for this policy. The
 syntax is:
     projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
 `[ALERT_POLICY_ID]` is assigned by Stackdriver 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

getNameBytes

public ByteString getNameBytes()

 Required if the policy exists. The resource name for this policy. The
 syntax is:
     projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
 `[ALERT_POLICY_ID]` is assigned by Stackdriver 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

getDisplayName

public java.lang.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.

string display_name = 2;

Specified by:: getDisplayName in interface AlertPolicyOrBuilder

getDisplayNameBytes

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

string display_name = 2;

Specified by:: getDisplayNameBytes in interface AlertPolicyOrBuilder

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

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

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