- 3.54.0 (latest)
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.6
- 3.3.6
- 3.2.10
public interface AlertPolicyOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsUserLabels(String key)
public abstract 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.
map<string, string> user_labels = 16;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getAlertStrategy()
public abstract AlertPolicy.AlertStrategy getAlertStrategy()Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.AlertStrategy | The alertStrategy. |
getAlertStrategyOrBuilder()
public abstract AlertPolicy.AlertStrategyOrBuilder getAlertStrategyOrBuilder()Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.AlertStrategyOrBuilder | |
getCombiner()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.ConditionCombinerType | The combiner. |
getCombinerValue()
public abstract 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 abstract 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.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition | |
getConditionsCount()
public abstract 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.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;
| Returns | |
|---|---|
| Type | Description |
int | |
getConditionsList()
public abstract 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.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;
| Returns | |
|---|---|
| Type | Description |
List<Condition> | |
getConditionsOrBuilder(int index)
public abstract 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.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.ConditionOrBuilder | |
getConditionsOrBuilderList()
public abstract 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.
repeated .google.monitoring.v3.AlertPolicy.Condition conditions = 12;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.monitoring.v3.AlertPolicy.ConditionOrBuilder> | |
getCreationRecord()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
MutationRecord | The creationRecord. |
getCreationRecordOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
MutationRecordOrBuilder | |
getDisplayName()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
String | The displayName. |
getDisplayNameBytes()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for displayName. |
getDocumentation()
public abstract 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 | |
|---|---|
| Type | Description |
AlertPolicy.Documentation | The documentation. |
getDocumentationOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.DocumentationOrBuilder | |
getEnabled()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
BoolValue | The enabled. |
getEnabledOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
BoolValueOrBuilder | |
getMutationRecord()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
MutationRecord | The mutationRecord. |
getMutationRecordOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
MutationRecordOrBuilder | |
getName()
public abstract 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
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 abstract 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 abstract 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 | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The notificationChannels at the given index. |
getNotificationChannelsBytes(int index)
public abstract 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 | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the notificationChannels at the given index. |
getNotificationChannelsCount()
public abstract 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 abstract 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. 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 |
List<String> | A list containing the notificationChannels. |
getUserLabels()
public abstract Map<String,String> getUserLabels()Use #getUserLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getUserLabelsCount()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
int | |
getUserLabelsMap()
public abstract 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.
map<string, string> user_labels = 16;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getUserLabelsOrDefault(String key, String defaultValue)
public abstract 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.
map<string, string> user_labels = 16;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getUserLabelsOrThrow(String key)
public abstract 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.
map<string, string> user_labels = 16;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getValidity()
public abstract Status getValidity()Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents.
.google.rpc.Status validity = 18;
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status | The validity. |
getValidityOrBuilder()
public abstract StatusOrBuilder getValidityOrBuilder()Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents.
.google.rpc.Status validity = 18;
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder | |
hasAlertStrategy()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasValidity()Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents.
.google.rpc.Status validity = 18;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the validity field is set. |