- 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 static final class AlertPolicy.Builder extends GeneratedMessageV3.Builder<AlertPolicy.Builder> implements AlertPolicyOrBuilderA 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AlertPolicy.BuilderImplements
AlertPolicyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllConditions(Iterable<? extends AlertPolicy.Condition> values)
public AlertPolicy.Builder addAllConditions(Iterable<? extends AlertPolicy.Condition> values) 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 |
values | Iterable<? extends com.google.monitoring.v3.AlertPolicy.Condition> |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
addAllNotificationChannels(Iterable<String> values)
public AlertPolicy.Builder addAllNotificationChannels(Iterable<String> values) 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 |
values | Iterable<String>The notificationChannels to add. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | This builder for chaining. |
addConditions(AlertPolicy.Condition value)
public AlertPolicy.Builder addConditions(AlertPolicy.Condition value) 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 |
value | AlertPolicy.Condition |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
addConditions(AlertPolicy.Condition.Builder builderForValue)
public AlertPolicy.Builder addConditions(AlertPolicy.Condition.Builder builderForValue) 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 |
builderForValue | AlertPolicy.Condition.Builder |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
addConditions(int index, AlertPolicy.Condition value)
public AlertPolicy.Builder addConditions(int index, AlertPolicy.Condition value) 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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | AlertPolicy.Condition |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
addConditions(int index, AlertPolicy.Condition.Builder builderForValue)
public AlertPolicy.Builder addConditions(int index, AlertPolicy.Condition.Builder builderForValue) 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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | AlertPolicy.Condition.Builder |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
addConditionsBuilder()
public AlertPolicy.Condition.Builder addConditionsBuilder() 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 |
AlertPolicy.Condition.Builder | |
addConditionsBuilder(int index)
public AlertPolicy.Condition.Builder addConditionsBuilder(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 |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.Builder | |
addNotificationChannels(String value)
public AlertPolicy.Builder addNotificationChannels(String value) 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 |
value | StringThe notificationChannels to add. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | This builder for chaining. |
addNotificationChannelsBytes(ByteString value)
public AlertPolicy.Builder addNotificationChannelsBytes(ByteString value) 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 |
value | ByteStringThe bytes of the notificationChannels to add. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AlertPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
build()
public AlertPolicy build()| Returns | |
|---|---|
| Type | Description |
AlertPolicy | |
buildPartial()
public AlertPolicy buildPartial()| Returns | |
|---|---|
| Type | Description |
AlertPolicy | |
clear()
public AlertPolicy.Builder clear()| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
clearAlertStrategy()
public AlertPolicy.Builder clearAlertStrategy()Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
clearCombiner()
public AlertPolicy.Builder clearCombiner() 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.Builder | This builder for chaining. |
clearConditions()
public AlertPolicy.Builder clearConditions() 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 |
AlertPolicy.Builder | |
clearCreationRecord()
public AlertPolicy.Builder clearCreationRecord()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 |
AlertPolicy.Builder | |
clearDisplayName()
public AlertPolicy.Builder clearDisplayName()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 |
AlertPolicy.Builder | This builder for chaining. |
clearDocumentation()
public AlertPolicy.Builder clearDocumentation()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.Builder | |
clearEnabled()
public AlertPolicy.Builder clearEnabled()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 |
AlertPolicy.Builder | |
clearField(Descriptors.FieldDescriptor field)
public AlertPolicy.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
clearMutationRecord()
public AlertPolicy.Builder clearMutationRecord()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 |
AlertPolicy.Builder | |
clearName()
public AlertPolicy.Builder clearName()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 |
AlertPolicy.Builder | This builder for chaining. |
clearNotificationChannels()
public AlertPolicy.Builder clearNotificationChannels() 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 |
AlertPolicy.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public AlertPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
clearUserLabels()
public AlertPolicy.Builder clearUserLabels()| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
clearValidity()
public AlertPolicy.Builder clearValidity()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 |
AlertPolicy.Builder | |
clone()
public AlertPolicy.Builder clone()| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
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 |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getAlertStrategy()
public 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. |
getAlertStrategyBuilder()
public AlertPolicy.AlertStrategy.Builder getAlertStrategyBuilder()Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.AlertStrategy.Builder | |
getAlertStrategyOrBuilder()
public 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 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 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 |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition | |
getConditionsBuilder(int index)
public AlertPolicy.Condition.Builder getConditionsBuilder(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 |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.Builder | |
getConditionsBuilderList()
public List<AlertPolicy.Condition.Builder> getConditionsBuilderList() 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<Builder> | |
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;
| Returns | |
|---|---|
| Type | Description |
List<Condition> | |
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 |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.ConditionOrBuilder | |
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;
| Returns | |
|---|---|
| Type | Description |
MutationRecord | The creationRecord. |
getCreationRecordBuilder()
public MutationRecord.Builder getCreationRecordBuilder()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.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
MutationRecordOrBuilder | |
getDefaultInstanceForType()
public AlertPolicy getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AlertPolicy | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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;
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Documentation | The documentation. |
getDocumentationBuilder()
public AlertPolicy.Documentation.Builder getDocumentationBuilder()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.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.DocumentationOrBuilder | |
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;
| Returns | |
|---|---|
| Type | Description |
BoolValue | The enabled. |
getEnabledBuilder()
public BoolValue.Builder getEnabledBuilder()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 |
Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
BoolValueOrBuilder | |
getMutableUserLabels() (deprecated)
public Map<String,String> getMutableUserLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
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;
| Returns | |
|---|---|
| Type | Description |
MutationRecord | The mutationRecord. |
getMutationRecordBuilder()
public MutationRecord.Builder getMutationRecordBuilder()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.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
MutationRecordOrBuilder | |
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
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 | intThe 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 | intThe 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList | A list containing the notificationChannels. |
getUserLabels() (deprecated)
public Map<String,String> getUserLabels()Use #getUserLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
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;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
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;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
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 |
| Returns | |
|---|---|
| Type | Description |
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. |
getValidityBuilder()
public Status.Builder getValidityBuilder()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.Builder | |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeAlertStrategy(AlertPolicy.AlertStrategy value)
public AlertPolicy.Builder mergeAlertStrategy(AlertPolicy.AlertStrategy value)Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
| Parameter | |
|---|---|
| Name | Description |
value | AlertPolicy.AlertStrategy |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
mergeCreationRecord(MutationRecord value)
public AlertPolicy.Builder mergeCreationRecord(MutationRecord value)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;
| Parameter | |
|---|---|
| Name | Description |
value | MutationRecord |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
mergeDocumentation(AlertPolicy.Documentation value)
public AlertPolicy.Builder mergeDocumentation(AlertPolicy.Documentation value)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;
| Parameter | |
|---|---|
| Name | Description |
value | AlertPolicy.Documentation |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
mergeEnabled(BoolValue value)
public AlertPolicy.Builder mergeEnabled(BoolValue value)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;
| Parameter | |
|---|---|
| Name | Description |
value | BoolValue |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
mergeFrom(AlertPolicy other)
public AlertPolicy.Builder mergeFrom(AlertPolicy other)| Parameter | |
|---|---|
| Name | Description |
other | AlertPolicy |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AlertPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public AlertPolicy.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
mergeMutationRecord(MutationRecord value)
public AlertPolicy.Builder mergeMutationRecord(MutationRecord value)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;
| Parameter | |
|---|---|
| Name | Description |
value | MutationRecord |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AlertPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
mergeValidity(Status value)
public AlertPolicy.Builder mergeValidity(Status value)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;
| Parameter | |
|---|---|
| Name | Description |
value | com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
putAllUserLabels(Map<String,String> values)
public AlertPolicy.Builder putAllUserLabels(Map<String,String> values) 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 |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
putUserLabels(String key, String value)
public AlertPolicy.Builder putUserLabels(String key, String value) 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;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
removeConditions(int index)
public AlertPolicy.Builder removeConditions(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 |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
removeUserLabels(String key)
public AlertPolicy.Builder removeUserLabels(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 |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setAlertStrategy(AlertPolicy.AlertStrategy value)
public AlertPolicy.Builder setAlertStrategy(AlertPolicy.AlertStrategy value)Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
| Parameter | |
|---|---|
| Name | Description |
value | AlertPolicy.AlertStrategy |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setAlertStrategy(AlertPolicy.AlertStrategy.Builder builderForValue)
public AlertPolicy.Builder setAlertStrategy(AlertPolicy.AlertStrategy.Builder builderForValue)Control over how this alert policy's notification channels are notified.
.google.monitoring.v3.AlertPolicy.AlertStrategy alert_strategy = 21;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | AlertPolicy.AlertStrategy.Builder |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setCombiner(AlertPolicy.ConditionCombinerType value)
public AlertPolicy.Builder setCombiner(AlertPolicy.ConditionCombinerType value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | AlertPolicy.ConditionCombinerTypeThe combiner to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | This builder for chaining. |
setCombinerValue(int value)
public AlertPolicy.Builder setCombinerValue(int value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for combiner to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | This builder for chaining. |
setConditions(int index, AlertPolicy.Condition value)
public AlertPolicy.Builder setConditions(int index, AlertPolicy.Condition value) 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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | AlertPolicy.Condition |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setConditions(int index, AlertPolicy.Condition.Builder builderForValue)
public AlertPolicy.Builder setConditions(int index, AlertPolicy.Condition.Builder builderForValue) 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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | AlertPolicy.Condition.Builder |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setCreationRecord(MutationRecord value)
public AlertPolicy.Builder setCreationRecord(MutationRecord value)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;
| Parameter | |
|---|---|
| Name | Description |
value | MutationRecord |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setCreationRecord(MutationRecord.Builder builderForValue)
public AlertPolicy.Builder setCreationRecord(MutationRecord.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | MutationRecord.Builder |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setDisplayName(String value)
public AlertPolicy.Builder setDisplayName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public AlertPolicy.Builder setDisplayNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | This builder for chaining. |
setDocumentation(AlertPolicy.Documentation value)
public AlertPolicy.Builder setDocumentation(AlertPolicy.Documentation value)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;
| Parameter | |
|---|---|
| Name | Description |
value | AlertPolicy.Documentation |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setDocumentation(AlertPolicy.Documentation.Builder builderForValue)
public AlertPolicy.Builder setDocumentation(AlertPolicy.Documentation.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | AlertPolicy.Documentation.Builder |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setEnabled(BoolValue value)
public AlertPolicy.Builder setEnabled(BoolValue value)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;
| Parameter | |
|---|---|
| Name | Description |
value | BoolValue |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setEnabled(BoolValue.Builder builderForValue)
public AlertPolicy.Builder setEnabled(BoolValue.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public AlertPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setMutationRecord(MutationRecord value)
public AlertPolicy.Builder setMutationRecord(MutationRecord value)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;
| Parameter | |
|---|---|
| Name | Description |
value | MutationRecord |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setMutationRecord(MutationRecord.Builder builderForValue)
public AlertPolicy.Builder setMutationRecord(MutationRecord.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | MutationRecord.Builder |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setName(String value)
public AlertPolicy.Builder setName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public AlertPolicy.Builder setNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | This builder for chaining. |
setNotificationChannels(int index, String value)
public AlertPolicy.Builder setNotificationChannels(int index, String value) 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;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe notificationChannels to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AlertPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final AlertPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setValidity(Status value)
public AlertPolicy.Builder setValidity(Status value)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;
| Parameter | |
|---|---|
| Name | Description |
value | com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |
setValidity(Status.Builder builderForValue)
public AlertPolicy.Builder setValidity(Status.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Builder | |