public interface AlertPolicyOrBuilder extends MessageOrBuilder
| 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.
|
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.
|
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.
|
java.util.List<java.lang.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.
|
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.
|
boolean |
hasMutationRecord()
A read-only record of the most recent change to the alerting policy.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofisInitializedjava.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;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;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;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;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;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;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;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.
map<string, string> user_labels = 16;boolean containsUserLabels(java.lang.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.
map<string, string> user_labels = 16;@Deprecated java.util.Map<java.lang.String,java.lang.String> getUserLabels()
getUserLabelsMap() instead.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. 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.
map<string, string> user_labels = 16;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. 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.
map<string, string> user_labels = 16;java.lang.String getUserLabelsOrThrow(java.lang.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.
map<string, string> user_labels = 16;java.util.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.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;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.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;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.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;java.util.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.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;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.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;int getCombinerValue()
How to combine the results of multiple conditions to determine if an incident should be opened.
.google.monitoring.v3.AlertPolicy.ConditionCombinerType combiner = 6;AlertPolicy.ConditionCombinerType getCombiner()
How to combine the results of multiple conditions to determine if an incident should be opened.
.google.monitoring.v3.AlertPolicy.ConditionCombinerType combiner = 6;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;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;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;java.util.List<java.lang.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. 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 syntax of the entries in this field is:
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
repeated string notification_channels = 14;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 syntax of the entries in this field is:
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
repeated string notification_channels = 14;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. 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 syntax of the entries in this field is:
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
repeated string notification_channels = 14;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 syntax of the entries in this field is:
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
repeated string notification_channels = 14;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;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;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;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;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;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;