Package com.google.monitoring.v3
Class AlertPolicy
- 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 typegoogle.monitoring.v3.AlertPolicy
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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
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
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
-
-
Field Summary
Fields Modifier and Type Field 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
USER_LABELS_FIELD_NUMBER
static int
VALIDITY_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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()
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.MapField
internalGetMapField(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(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 AlertPolicy
parseFrom(ByteBuffer data)
static AlertPolicy
parseFrom(ByteBuffer data, 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, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, 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
-
-
-
-
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
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.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 interfaceAlertPolicyOrBuilder
- 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 interfaceAlertPolicyOrBuilder
- 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 interfaceAlertPolicyOrBuilder
- 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 interfaceAlertPolicyOrBuilder
- 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 interfaceAlertPolicyOrBuilder
- 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 interfaceAlertPolicyOrBuilder
- 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 interfaceAlertPolicyOrBuilder
-
getUserLabelsCount
public int getUserLabelsCount()
Description copied from interface:AlertPolicyOrBuilder
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.
map<string, string> user_labels = 16;
- Specified by:
getUserLabelsCount
in interfaceAlertPolicyOrBuilder
-
containsUserLabels
public boolean containsUserLabels(String key)
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.
map<string, string> user_labels = 16;
- Specified by:
containsUserLabels
in interfaceAlertPolicyOrBuilder
-
getUserLabels
@Deprecated public Map<String,String> getUserLabels()
Deprecated.UsegetUserLabelsMap()
instead.- Specified by:
getUserLabels
in interfaceAlertPolicyOrBuilder
-
getUserLabelsMap
public Map<String,String> getUserLabelsMap()
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.
map<string, string> user_labels = 16;
- Specified by:
getUserLabelsMap
in interfaceAlertPolicyOrBuilder
-
getUserLabelsOrDefault
public String getUserLabelsOrDefault(String key, String defaultValue)
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.
map<string, string> user_labels = 16;
- Specified by:
getUserLabelsOrDefault
in interfaceAlertPolicyOrBuilder
-
getUserLabelsOrThrow
public String getUserLabelsOrThrow(String key)
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.
map<string, string> user_labels = 16;
- Specified by:
getUserLabelsOrThrow
in interfaceAlertPolicyOrBuilder
-
getConditionsList
public List<AlertPolicy.Condition> getConditionsList()
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`.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;
- Specified by:
getConditionsList
in interfaceAlertPolicyOrBuilder
-
getConditionsOrBuilderList
public List<? extends AlertPolicy.ConditionOrBuilder> getConditionsOrBuilderList()
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`.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;
- Specified by:
getConditionsOrBuilderList
in interfaceAlertPolicyOrBuilder
-
getConditionsCount
public int getConditionsCount()
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`.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;
- Specified by:
getConditionsCount
in interfaceAlertPolicyOrBuilder
-
getConditions
public AlertPolicy.Condition getConditions(int index)
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`.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;
- Specified by:
getConditions
in interfaceAlertPolicyOrBuilder
-
getConditionsOrBuilder
public AlertPolicy.ConditionOrBuilder getConditionsOrBuilder(int index)
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`.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;
- Specified by:
getConditionsOrBuilder
in interfaceAlertPolicyOrBuilder
-
getCombinerValue
public int getCombinerValue()
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`.
.google.monitoring.v3.AlertPolicy.ConditionCombinerType combiner = 6;
- Specified by:
getCombinerValue
in interfaceAlertPolicyOrBuilder
- Returns:
- The enum numeric value on the wire for combiner.
-
getCombiner
public AlertPolicy.ConditionCombinerType 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`.
.google.monitoring.v3.AlertPolicy.ConditionCombinerType combiner = 6;
- Specified by:
getCombiner
in interfaceAlertPolicyOrBuilder
- Returns:
- The combiner.
-
hasEnabled
public boolean hasEnabled()
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.
.google.protobuf.BoolValue enabled = 17;
- Specified by:
hasEnabled
in interfaceAlertPolicyOrBuilder
- Returns:
- Whether the enabled field is set.
-
getEnabled
public com.google.protobuf.BoolValue 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.
.google.protobuf.BoolValue enabled = 17;
- Specified by:
getEnabled
in interfaceAlertPolicyOrBuilder
- Returns:
- The enabled.
-
getEnabledOrBuilder
public com.google.protobuf.BoolValueOrBuilder getEnabledOrBuilder()
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.
.google.protobuf.BoolValue enabled = 17;
- Specified by:
getEnabledOrBuilder
in interfaceAlertPolicyOrBuilder
-
hasValidity
public boolean hasValidity()
Read-only description of how the alert policy is invalid. This field is only set when the alert policy is invalid. An invalid alert policy will not generate incidents.
.google.rpc.Status validity = 18;
- Specified by:
hasValidity
in interfaceAlertPolicyOrBuilder
- Returns:
- Whether the validity field is set.
-
getValidity
public com.google.rpc.Status getValidity()
Read-only description of how the alert policy is invalid. This field is only set when the alert policy is invalid. An invalid alert policy will not generate incidents.
.google.rpc.Status validity = 18;
- Specified by:
getValidity
in interfaceAlertPolicyOrBuilder
- Returns:
- The validity.
-
getValidityOrBuilder
public com.google.rpc.StatusOrBuilder getValidityOrBuilder()
Read-only description of how the alert policy is invalid. This field is only set when the alert policy is invalid. An invalid alert policy will not generate incidents.
.google.rpc.Status validity = 18;
- Specified by:
getValidityOrBuilder
in interfaceAlertPolicyOrBuilder
-
getNotificationChannelsList
public 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. Each element of this array corresponds to the `name` field in each of the [`NotificationChannel`][google.monitoring.v3.NotificationChannel] objects that are returned from the [`ListNotificationChannels`] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
repeated string notification_channels = 14;
- Specified by:
getNotificationChannelsList
in interfaceAlertPolicyOrBuilder
- Returns:
- A list containing the notificationChannels.
-
getNotificationChannelsCount
public 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. Each element of this array corresponds to the `name` field in each of the [`NotificationChannel`][google.monitoring.v3.NotificationChannel] objects that are returned from the [`ListNotificationChannels`] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
repeated string notification_channels = 14;
- Specified by:
getNotificationChannelsCount
in interfaceAlertPolicyOrBuilder
- Returns:
- The count of notificationChannels.
-
getNotificationChannels
public 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. Each element of this array corresponds to the `name` field in each of the [`NotificationChannel`][google.monitoring.v3.NotificationChannel] objects that are returned from the [`ListNotificationChannels`] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
repeated string notification_channels = 14;
- Specified by:
getNotificationChannels
in interfaceAlertPolicyOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The notificationChannels at the given index.
-
getNotificationChannelsBytes
public 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. Each element of this array corresponds to the `name` field in each of the [`NotificationChannel`][google.monitoring.v3.NotificationChannel] objects that are returned from the [`ListNotificationChannels`] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
repeated string notification_channels = 14;
- Specified by:
getNotificationChannelsBytes
in interfaceAlertPolicyOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the notificationChannels at the given index.
-
hasCreationRecord
public boolean hasCreationRecord()
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.
.google.monitoring.v3.MutationRecord creation_record = 10;
- Specified by:
hasCreationRecord
in interfaceAlertPolicyOrBuilder
- Returns:
- Whether the creationRecord field is set.
-
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.
.google.monitoring.v3.MutationRecord creation_record = 10;
- Specified by:
getCreationRecord
in interfaceAlertPolicyOrBuilder
- Returns:
- The creationRecord.
-
getCreationRecordOrBuilder
public MutationRecordOrBuilder getCreationRecordOrBuilder()
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.
.google.monitoring.v3.MutationRecord creation_record = 10;
- Specified by:
getCreationRecordOrBuilder
in interfaceAlertPolicyOrBuilder
-
hasMutationRecord
public boolean hasMutationRecord()
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.
.google.monitoring.v3.MutationRecord mutation_record = 11;
- Specified by:
hasMutationRecord
in interfaceAlertPolicyOrBuilder
- Returns:
- Whether the mutationRecord field is set.
-
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.
.google.monitoring.v3.MutationRecord mutation_record = 11;
- Specified by:
getMutationRecord
in interfaceAlertPolicyOrBuilder
- Returns:
- The mutationRecord.
-
getMutationRecordOrBuilder
public MutationRecordOrBuilder getMutationRecordOrBuilder()
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.
.google.monitoring.v3.MutationRecord mutation_record = 11;
- Specified by:
getMutationRecordOrBuilder
in interfaceAlertPolicyOrBuilder
-
hasAlertStrategy
public boolean hasAlertStrategy()
Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
- Specified by:
hasAlertStrategy
in interfaceAlertPolicyOrBuilder
- Returns:
- Whether the alertStrategy field is set.
-
getAlertStrategy
public AlertPolicy.AlertStrategy getAlertStrategy()
Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
- Specified by:
getAlertStrategy
in interfaceAlertPolicyOrBuilder
- Returns:
- The alertStrategy.
-
getAlertStrategyOrBuilder
public AlertPolicy.AlertStrategyOrBuilder getAlertStrategyOrBuilder()
Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
- Specified by:
getAlertStrategyOrBuilder
in interfaceAlertPolicyOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static AlertPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AlertPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AlertPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AlertPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AlertPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AlertPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AlertPolicy parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static AlertPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static AlertPolicy parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static AlertPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static AlertPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static AlertPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public AlertPolicy.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static AlertPolicy.Builder newBuilder()
-
newBuilder
public static AlertPolicy.Builder newBuilder(AlertPolicy prototype)
-
toBuilder
public AlertPolicy.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected AlertPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static AlertPolicy getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<AlertPolicy> parser()
-
getParserForType
public com.google.protobuf.Parser<AlertPolicy> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public AlertPolicy getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-