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.
Protobuf type google.monitoring.v3.AlertPolicy
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ALERT_STRATEGY_FIELD_NUMBER
public static final int ALERT_STRATEGY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
COMBINER_FIELD_NUMBER
public static final int COMBINER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONDITIONS_FIELD_NUMBER
public static final int CONDITIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATION_RECORD_FIELD_NUMBER
public static final int CREATION_RECORD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DOCUMENTATION_FIELD_NUMBER
public static final int DOCUMENTATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENABLED_FIELD_NUMBER
public static final int ENABLED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MUTATION_RECORD_FIELD_NUMBER
public static final int MUTATION_RECORD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NOTIFICATION_CHANNELS_FIELD_NUMBER
public static final int NOTIFICATION_CHANNELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_LABELS_FIELD_NUMBER
public static final int USER_LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VALIDITY_FIELD_NUMBER
public static final int VALIDITY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static AlertPolicy getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AlertPolicy.Builder newBuilder()
newBuilder(AlertPolicy prototype)
public static AlertPolicy.Builder newBuilder(AlertPolicy prototype)
public static AlertPolicy parseDelimitedFrom(InputStream input)
public static AlertPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AlertPolicy parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AlertPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AlertPolicy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AlertPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AlertPolicy parseFrom(CodedInputStream input)
public static AlertPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AlertPolicy parseFrom(InputStream input)
public static AlertPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AlertPolicy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AlertPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AlertPolicy> parser()
Methods
containsUserLabels(String key)
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,
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;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAlertStrategy()
public AlertPolicy.AlertStrategy getAlertStrategy()
Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
getAlertStrategyOrBuilder()
public AlertPolicy.AlertStrategyOrBuilder getAlertStrategyOrBuilder()
Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
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;
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;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for combiner.
|
getConditions(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
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;
| Returns |
|---|
| Type | Description |
int | |
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;
getConditionsOrBuilder(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
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;
| Returns |
|---|
| Type | Description |
List<? extends com.google.monitoring.v3.AlertPolicy.ConditionOrBuilder> | |
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;
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;
getDefaultInstanceForType()
public AlertPolicy getDefaultInstanceForType()
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;
| Returns |
|---|
| Type | Description |
String | The displayName.
|
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.
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 |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
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;
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;
getEnabled()
public 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;
getEnabledOrBuilder()
public 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;
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;
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;
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
method, do not include the name field in the alerting policy passed as
part of the request.
string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public 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
method, do not include the name field in the alerting policy passed as
part of the request.
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getNotificationChannels(int index)
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
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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The notificationChannels at the given index.
|
getNotificationChannelsBytes(int index)
public 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
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;
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the notificationChannels at the given index.
|
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
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;
| Returns |
|---|
| Type | Description |
int | The count of notificationChannels.
|
getNotificationChannelsList()
public 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
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;
getParserForType()
public Parser<AlertPolicy> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUserLabels() (deprecated)
public Map<String,String> getUserLabels()
getUserLabelsCount()
public int getUserLabelsCount()
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,
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;
| Returns |
|---|
| Type | Description |
int | |
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,
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;
getUserLabelsOrDefault(String key, String defaultValue)
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,
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;
getUserLabelsOrThrow(String key)
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,
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;
| Parameter |
|---|
| Name | Description |
key | String
|
getValidity()
public 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;
| Returns |
|---|
| Type | Description |
com.google.rpc.Status | The validity.
|
getValidityOrBuilder()
public 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;
| Returns |
|---|
| Type | Description |
com.google.rpc.StatusOrBuilder | |
hasAlertStrategy()
public boolean hasAlertStrategy()
Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
| Returns |
|---|
| Type | Description |
boolean | Whether the alertStrategy field is set.
|
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the creationRecord field is set.
|
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the documentation field is set.
|
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the enabled field is set.
|
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the mutationRecord field is set.
|
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the validity field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AlertPolicy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AlertPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public AlertPolicy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
