AlertPolicyOrBuilder (proto-google-cloud-monitoring-v3 3.31.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AlertPolicy, AlertPolicy.Builder
```
public interface AlertPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract 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.
`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.
`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.
`List<String>`	`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.
`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.
`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.

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getName

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;

Returns:: The name.

getNameBytes

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;

Returns:: The bytes for name.

getDisplayName

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;

Returns:: The displayName.

getDisplayNameBytes

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;

Returns:: The bytes for displayName.

hasDocumentation

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;

Returns:: Whether the documentation field is set.

getDocumentation

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;

Returns:: The documentation.

getDocumentationOrBuilder

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;