google-cloud-monitoring 0.29.1 → 0.29.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/lib/google/cloud/monitoring.rb +4 -4
  4. data/lib/google/cloud/monitoring/v3.rb +4 -4
  5. data/lib/google/cloud/monitoring/v3/alert_policy_service_client.rb +19 -19
  6. data/lib/google/cloud/monitoring/v3/doc/google/api/distribution.rb +18 -18
  7. data/lib/google/cloud/monitoring/v3/doc/google/api/metric.rb +69 -48
  8. data/lib/google/cloud/monitoring/v3/doc/google/api/monitored_resource.rb +20 -21
  9. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb +42 -42
  10. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert_service.rb +24 -24
  11. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/common.rb +21 -21
  12. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group.rb +9 -9
  13. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb +24 -24
  14. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb +7 -7
  15. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb +41 -41
  16. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb +15 -15
  17. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification_service.rb +30 -30
  18. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb +8 -8
  19. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime_service.rb +21 -21
  20. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/any.rb +8 -8
  21. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/duration.rb +3 -3
  22. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/empty.rb +1 -1
  23. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/field_mask.rb +7 -7
  24. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/struct.rb +11 -11
  25. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/timestamp.rb +7 -7
  26. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/wrappers.rb +18 -18
  27. data/lib/google/cloud/monitoring/v3/doc/google/rpc/status.rb +11 -11
  28. data/lib/google/cloud/monitoring/v3/group_service_client.rb +15 -15
  29. data/lib/google/cloud/monitoring/v3/metric_service_client.rb +20 -20
  30. data/lib/google/cloud/monitoring/v3/notification_channel_service_client.rb +11 -11
  31. data/lib/google/cloud/monitoring/v3/uptime_check_service_client.rb +14 -14
  32. metadata +3 -4
  33. data/lib/google/cloud/monitoring/v3/doc/overview.rb +0 -104
data/lib/google/cloud/monitoring/v3/doc/google/api/monitored_resource.rb CHANGED
@@ -18,31 +18,31 @@ module Google
18
18
  # An object that describes the schema of a {Google::Api::MonitoredResource MonitoredResource} object using a
19
19
  # type name and a set of labels. For example, the monitored resource
20
20
  # descriptor for Google Compute Engine VM instances has a type of
21
- # +"gce_instance"+ and specifies the use of the labels +"instance_id"+ and
22
- # +"zone"+ to identify particular VM instances.
21
+ # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
22
+ # `"zone"` to identify particular VM instances.
23
23
  #
24
24
  # Different APIs can support different monitored resource types. APIs generally
25
- # provide a +list+ method that returns the monitored resource descriptors used
25
+ # provide a `list` method that returns the monitored resource descriptors used
26
26
  # by the API.
27
27
  # @!attribute [rw] name
28
28
  # @return [String]
29
29
  # Optional. The resource name of the monitored resource descriptor:
30
- # +"projects/\\{project_id}/monitoredResourceDescriptors/\\{type}"+ where
31
- # \\{type} is the value of the +type+ field in this object and
30
+ # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
31
+ # \\{type} is the value of the `type` field in this object and
32
32
  # \\{project_id} is a project ID that provides API-specific context for
33
33
  # accessing the type. APIs that do not use project information can use the
34
- # resource name format +"monitoredResourceDescriptors/\\{type}"+.
34
+ # resource name format `"monitoredResourceDescriptors/{type}"`.
35
35
  # @!attribute [rw] type
36
36
  # @return [String]
37
37
  # Required. The monitored resource type. For example, the type
38
- # +"cloudsql_database"+ represents databases in Google Cloud SQL.
38
+ # `"cloudsql_database"` represents databases in Google Cloud SQL.
39
39
  # The maximum length of this value is 256 characters.
40
40
  # @!attribute [rw] display_name
41
41
  # @return [String]
42
42
  # Optional. A concise name for the monitored resource type that might be
43
43
  # displayed in user interfaces. It should be a Title Cased Noun Phrase,
44
44
  # without any article or other determiners. For example,
45
- # +"Google Cloud SQL Database"+.
45
+ # `"Google Cloud SQL Database"`.
46
46
  # @!attribute [rw] description
47
47
  # @return [String]
48
48
  # Optional. A detailed description of the monitored resource type that might
@@ -51,18 +51,18 @@ module Google
51
51
  # @return [Array<Google::Api::LabelDescriptor>]
52
52
  # Required. A set of labels used to describe instances of this monitored
53
53
  # resource type. For example, an individual Google Cloud SQL database is
54
- # identified by values for the labels +"database_id"+ and +"zone"+.
54
+ # identified by values for the labels `"database_id"` and `"zone"`.
55
55
  class MonitoredResourceDescriptor; end
56
56
 
57
57
  # An object representing a resource that can be used for monitoring, logging,
58
58
  # billing, or other purposes. Examples include virtual machine instances,
59
- # databases, and storage devices such as disks. The +type+ field identifies a
59
+ # databases, and storage devices such as disks. The `type` field identifies a
60
60
  # {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object that describes the resource's
61
- # schema. Information in the +labels+ field identifies the actual resource and
61
+ # schema. Information in the `labels` field identifies the actual resource and
62
62
  # its attributes according to the schema. For example, a particular Compute
63
63
  # Engine VM instance could be represented by the following object, because the
64
- # {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} for +"gce_instance"+ has labels
65
- # +"instance_id"+ and +"zone"+:
64
+ # {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} for `"gce_instance"` has labels
65
+ # `"instance_id"` and `"zone"`:
66
66
  #
67
67
  # { "type": "gce_instance",
68
68
  # "labels": { "instance_id": "12345678901234",
@@ -70,27 +70,26 @@ module Google
70
70
  # @!attribute [rw] type
71
71
  # @return [String]
72
72
  # Required. The monitored resource type. This field must match
73
- # the +type+ field of a {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object. For
74
- # example, the type of a Compute Engine VM instance is +gce_instance+.
73
+ # the `type` field of a {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object. For
74
+ # example, the type of a Compute Engine VM instance is `gce_instance`.
75
75
  # @!attribute [rw] labels
76
76
  # @return [Hash{String => String}]
77
77
  # Required. Values for all of the labels listed in the associated monitored
78
78
  # resource descriptor. For example, Compute Engine VM instances use the
79
- # labels +"project_id"+, +"instance_id"+, and +"zone"+.
79
+ # labels `"project_id"`, `"instance_id"`, and `"zone"`.
80
80
  class MonitoredResource; end
81
81
 
82
82
  # Auxiliary metadata for a {Google::Api::MonitoredResource MonitoredResource} object.
83
83
  # {Google::Api::MonitoredResource MonitoredResource} objects contain the minimum set of information to
84
84
  # uniquely identify a monitored resource instance. There is some other useful
85
- # auxiliary metadata. Google Stackdriver Monitoring & Logging uses an ingestion
86
- # pipeline to extract metadata for cloud resources of all types , and stores
85
+ # auxiliary metadata. Monitoring and Logging use an ingestion
86
+ # pipeline to extract metadata for cloud resources of all types, and store
87
87
  # the metadata in this message.
88
88
  # @!attribute [rw] system_labels
89
89
  # @return [Google::Protobuf::Struct]
90
90
  # Output only. Values for predefined system metadata labels.
91
- # System labels are a kind of metadata extracted by Google Stackdriver.
92
- # Stackdriver determines what system labels are useful and how to obtain
93
- # their values. Some examples: "machine_image", "vpc", "subnet_id",
91
+ # System labels are a kind of metadata extracted by Google, including
92
+ # "machine_image", "vpc", "subnet_id",
94
93
  # "security_group", "name", etc.
95
94
  # System label values can be only strings, Boolean values, or a list of
96
95
  # strings. For example:
data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb CHANGED
@@ -27,10 +27,10 @@ module Google
27
27
  #
28
28
  # projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
29
29
  #
30
- # +[ALERT_POLICY_ID]+ is assigned by Stackdriver Monitoring when the policy
30
+ # `[ALERT_POLICY_ID]` is assigned by Stackdriver Monitoring when the policy
31
31
  # is created. When calling the
32
32
  # {Google::Monitoring::V3::AlertPolicyService::CreateAlertPolicy alertPolicies::create}
33
- # method, do not include the +name+ field in the alerting policy passed as
33
+ # method, do not include the `name` field in the alerting policy passed as
34
34
  # part of the request.
35
35
  # @!attribute [rw] display_name
36
36
  # @return [String]
@@ -48,7 +48,7 @@ module Google
48
48
  # @!attribute [rw] user_labels
49
49
  # @return [Hash{String => String}]
50
50
  # User-supplied key/value data to be used for organizing and
51
- # identifying the +AlertPolicy+ objects.
51
+ # identifying the `AlertPolicy` objects.
52
52
  #
53
53
  # The field can contain up to 64 entries. Each key and value is limited to
54
54
  # 63 Unicode characters or 128 bytes, whichever is smaller. Labels and
@@ -57,7 +57,7 @@ module Google
57
57
  # @!attribute [rw] conditions
58
58
  # @return [Array<Google::Monitoring::V3::AlertPolicy::Condition>]
59
59
  # A list of conditions for the policy. The conditions are combined by AND or
60
- # OR according to the +combiner+ field. If the combined conditions evaluate
60
+ # OR according to the `combiner` field. If the combined conditions evaluate
61
61
  # to true, then an incident is created. A policy can have from one to six
62
62
  # conditions.
63
63
  # @!attribute [rw] combiner
@@ -76,9 +76,9 @@ module Google
76
76
  # Identifies the notification channels to which notifications should be sent
77
77
  # when incidents are opened or closed or when new violations occur on
78
78
  # an already opened incident. Each element of this array corresponds to
79
- # the +name+ field in each of the
80
- # {Google::Monitoring::V3::NotificationChannel +NotificationChannel+}
81
- # objects that are returned from the [+ListNotificationChannels+]
79
+ # the `name` field in each of the
80
+ # {Google::Monitoring::V3::NotificationChannel `NotificationChannel`}
81
+ # objects that are returned from the [`ListNotificationChannels`]
82
82
  # [google.monitoring.v3.NotificationChannelService.ListNotificationChannels]
83
83
  # method. The syntax of the entries in this field is:
84
84
  #
@@ -96,14 +96,14 @@ module Google
96
96
  # format.
97
97
  # @!attribute [rw] content
98
98
  # @return [String]
99
- # The text of the documentation, interpreted according to +mime_type+.
99
+ # The text of the documentation, interpreted according to `mime_type`.
100
100
  # The content may not exceed 8,192 Unicode characters and may not exceed
101
101
  # more than 10,240 bytes when encoded in UTF-8 format, whichever is
102
102
  # smaller.
103
103
  # @!attribute [rw] mime_type
104
104
  # @return [String]
105
- # The format of the +content+ field. Presently, only the value
106
- # +"text/markdown"+ is supported. See
105
+ # The format of the `content` field. Presently, only the value
106
+ # `"text/markdown"` is supported. See
107
107
  # [Markdown](https://en.wikipedia.org/wiki/Markdown) for more information.
108
108
  class Documentation; end
109
109
 
@@ -117,23 +117,23 @@ module Google
117
117
  #
118
118
  # projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
119
119
  #
120
- # +[CONDITION_ID]+ is assigned by Stackdriver Monitoring when the
120
+ # `[CONDITION_ID]` is assigned by Stackdriver Monitoring when the
121
121
  # condition is created as part of a new or updated alerting policy.
122
122
  #
123
123
  # When calling the
124
124
  # {Google::Monitoring::V3::AlertPolicyService::CreateAlertPolicy alertPolicies::create}
125
- # method, do not include the +name+ field in the conditions of the
125
+ # method, do not include the `name` field in the conditions of the
126
126
  # requested alerting policy. Stackdriver Monitoring creates the
127
127
  # condition identifiers and includes them in the new policy.
128
128
  #
129
129
  # When calling the
130
130
  # {Google::Monitoring::V3::AlertPolicyService::UpdateAlertPolicy alertPolicies::update}
131
- # method to update a policy, including a condition +name+ causes the
131
+ # method to update a policy, including a condition `name` causes the
132
132
  # existing condition to be updated. Conditions without names are added to
133
133
  # the updated policy. Existing conditions are deleted if they are not
134
134
  # updated.
135
135
  #
136
- # Best practice is to preserve +[CONDITION_ID]+ if you make only small
136
+ # Best practice is to preserve `[CONDITION_ID]` if you make only small
137
137
  # changes, such as those to condition thresholds, durations, or trigger
138
138
  # values. Otherwise, treat the change as a new condition and let the
139
139
  # existing condition be deleted.
@@ -151,7 +151,7 @@ module Google
151
151
  # receive new data points.
152
152
  class Condition
153
153
  # Specifies how many time series must fail a predicate to trigger a
154
- # condition. If not specified, then a +{count: 1}+ trigger is used.
154
+ # condition. If not specified, then a `{count: 1}` trigger is used.
155
155
  # @!attribute [rw] count
156
156
  # @return [Integer]
157
157
  # The absolute number of time series that must fail
@@ -170,7 +170,7 @@ module Google
170
170
  # identifies which time series should be compared with the threshold.
171
171
  #
172
172
  # The filter is similar to the one that is specified in the
173
- # [+MetricService.ListTimeSeries+
173
+ # [`MetricService.ListTimeSeries`
174
174
  # request](/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that
175
175
  # call is useful to verify the time series that will be retrieved /
176
176
  # processed) and must specify the metric type and optionally may contain
@@ -186,18 +186,18 @@ module Google
186
186
  # are applied in the order specified.
187
187
  #
188
188
  # This field is similar to the one in the
189
- # [+MetricService.ListTimeSeries+ request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
190
- # It is advisable to use the +ListTimeSeries+ method when debugging this field.
189
+ # [`MetricService.ListTimeSeries` request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
190
+ # It is advisable to use the `ListTimeSeries` method when debugging this field.
191
191
  # @!attribute [rw] denominator_filter
192
192
  # @return [String]
193
193
  # A [filter](https://cloud.google.com/monitoring/api/v3/filters) that identifies a time
194
194
  # series that should be used as the denominator of a ratio that will be
195
- # compared with the threshold. If a +denominator_filter+ is specified,
196
- # the time series specified by the +filter+ field will be used as the
195
+ # compared with the threshold. If a `denominator_filter` is specified,
196
+ # the time series specified by the `filter` field will be used as the
197
197
  # numerator.
198
198
  #
199
199
  # The filter is similar to the one that is specified in the
200
- # [+MetricService.ListTimeSeries+
200
+ # [`MetricService.ListTimeSeries`
201
201
  # request](/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that
202
202
  # call is useful to verify the time series that will be retrieved /
203
203
  # processed) and must specify the metric type and optionally may contain
@@ -206,29 +206,29 @@ module Google
206
206
  # @!attribute [rw] denominator_aggregations
207
207
  # @return [Array<Google::Monitoring::V3::Aggregation>]
208
208
  # Specifies the alignment of data points in individual time series
209
- # selected by +denominatorFilter+ as
209
+ # selected by `denominatorFilter` as
210
210
  # well as how to combine the retrieved time series together (such as
211
211
  # when aggregating multiple streams on each resource to a single
212
212
  # stream for each resource or when aggregating streams across all
213
213
  # members of a group of resources).
214
214
  #
215
- # When computing ratios, the +aggregations+ and
216
- # +denominator_aggregations+ fields must use the same alignment period
215
+ # When computing ratios, the `aggregations` and
216
+ # `denominator_aggregations` fields must use the same alignment period
217
217
  # and produce time series that have the same periodicity and labels.
218
218
  #
219
219
  # This field is similar to the one in the
220
- # [+MetricService.ListTimeSeries+
220
+ # [`MetricService.ListTimeSeries`
221
221
  # request](/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). It
222
- # is advisable to use the +ListTimeSeries+ method when debugging this
222
+ # is advisable to use the `ListTimeSeries` method when debugging this
223
223
  # field.
224
224
  # @!attribute [rw] comparison
225
225
  # @return [Google::Monitoring::V3::ComparisonType]
226
- # The comparison to apply between the time series (indicated by +filter+
227
- # and +aggregation+) and the threshold (indicated by +threshold_value+).
226
+ # The comparison to apply between the time series (indicated by `filter`
227
+ # and `aggregation`) and the threshold (indicated by `threshold_value`).
228
228
  # The comparison is applied on each time series, with the time series
229
229
  # on the left-hand side and the threshold on the right-hand side.
230
230
  #
231
- # Only +COMPARISON_LT+ and +COMPARISON_GT+ are supported currently.
231
+ # Only `COMPARISON_LT` and `COMPARISON_GT` are supported currently.
232
232
  # @!attribute [rw] threshold_value
233
233
  # @return [Float]
234
234
  # A value against which to compare the time series.
@@ -241,7 +241,7 @@ module Google
241
241
  # error will be returned. When choosing a duration, it is useful to
242
242
  # keep in mind the frequency of the underlying time series data
243
243
  # (which may also be affected by any alignments specified in the
244
- # +aggregations+ field); a good duration is long enough so that a single
244
+ # `aggregations` field); a good duration is long enough so that a single
245
245
  # outlier does not generate spurious alerts, but short enough that
246
246
  # unhealthy states are detected and alerted on quickly.
247
247
  # @!attribute [rw] trigger
@@ -249,8 +249,8 @@ module Google
249
249
  # The number/percent of time series for which the comparison must hold
250
250
  # in order for the condition to trigger. If unspecified, then the
251
251
  # condition will trigger if the comparison is true for any of the
252
- # time series that have been identified by +filter+ and +aggregations+,
253
- # or by the ratio, if +denominator_filter+ and +denominator_aggregations+
252
+ # time series that have been identified by `filter` and `aggregations`,
253
+ # or by the ratio, if `denominator_filter` and `denominator_aggregations`
254
254
  # are specified.
255
255
  class MetricThreshold; end
256
256
 
@@ -258,14 +258,14 @@ module Google
258
258
  # are reporting data. The configuration defines a metric and
259
259
  # a set of monitored resources. The predicate is considered in violation
260
260
  # when a time series for the specified metric of a monitored
261
- # resource does not include any data in the specified +duration+.
261
+ # resource does not include any data in the specified `duration`.
262
262
  # @!attribute [rw] filter
263
263
  # @return [String]
264
264
  # A [filter](https://cloud.google.com/monitoring/api/v3/filters) that
265
265
  # identifies which time series should be compared with the threshold.
266
266
  #
267
267
  # The filter is similar to the one that is specified in the
268
- # [+MetricService.ListTimeSeries+
268
+ # [`MetricService.ListTimeSeries`
269
269
  # request](/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that
270
270
  # call is useful to verify the time series that will be retrieved /
271
271
  # processed) and must specify the metric type and optionally may contain
@@ -281,22 +281,22 @@ module Google
281
281
  # are applied in the order specified.
282
282
  #
283
283
  # This field is similar to the
284
- # one in the [+MetricService.ListTimeSeries+ request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
285
- # It is advisable to use the +ListTimeSeries+ method when debugging this field.
284
+ # one in the [`MetricService.ListTimeSeries` request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
285
+ # It is advisable to use the `ListTimeSeries` method when debugging this field.
286
286
  # @!attribute [rw] duration
287
287
  # @return [Google::Protobuf::Duration]
288
288
  # The amount of time that a time series must fail to report new
289
289
  # data to be considered failing. Currently, only values that
290
290
  # are a multiple of a minute--e.g. 60, 120, or 300
291
291
  # seconds--are supported. If an invalid value is given, an
292
- # error will be returned. The +Duration.nanos+ field is
292
+ # error will be returned. The `Duration.nanos` field is
293
293
  # ignored.
294
294
  # @!attribute [rw] trigger
295
295
  # @return [Google::Monitoring::V3::AlertPolicy::Condition::Trigger]
296
296
  # The number/percent of time series for which the comparison must hold
297
297
  # in order for the condition to trigger. If unspecified, then the
298
298
  # condition will trigger if the comparison is true for any of the
299
- # time series that have been identified by +filter+ and +aggregations+.
299
+ # time series that have been identified by `filter` and `aggregations`.
300
300
  class MetricAbsence; end
301
301
  end
302
302
 
@@ -305,18 +305,18 @@ module Google
305
305
  # An unspecified combiner.
306
306
  COMBINE_UNSPECIFIED = 0
307
307
 
308
- # Combine conditions using the logical +AND+ operator. An
308
+ # Combine conditions using the logical `AND` operator. An
309
309
  # incident is created only if all conditions are met
310
310
  # simultaneously. This combiner is satisfied if all conditions are
311
311
  # met, even if they are met on completely different resources.
312
312
  AND = 1
313
313
 
314
- # Combine conditions using the logical +OR+ operator. An incident
314
+ # Combine conditions using the logical `OR` operator. An incident
315
315
  # is created if any of the listed conditions is met.
316
316
  OR = 2
317
317
 
318
- # Combine conditions using logical +AND+ operator, but unlike the regular
319
- # +AND+ option, an incident is created only if all conditions are met
318
+ # Combine conditions using logical `AND` operator, but unlike the regular
319
+ # `AND` option, an incident is created only if all conditions are met
320
320
  # simultaneously on at least one resource.
321
321
  AND_WITH_MATCHING_RESOURCE = 3
322
322
  end
data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert_service.rb CHANGED
@@ -16,25 +16,25 @@
16
16
  module Google
17
17
  module Monitoring
18
18
  module V3
19
- # The protocol for the +CreateAlertPolicy+ request.
19
+ # The protocol for the `CreateAlertPolicy` request.
20
20
  # @!attribute [rw] name
21
21
  # @return [String]
22
22
  # The project in which to create the alerting policy. The format is
23
- # +projects/[PROJECT_ID]+.
23
+ # `projects/[PROJECT_ID]`.
24
24
  #
25
25
  # Note that this field names the parent container in which the alerting
26
26
  # policy will be written, not the name of the created policy. The alerting
27
27
  # policy that is returned will have a name that contains a normalized
28
28
  # representation of this name as a prefix but adds a suffix of the form
29
- # +/alertPolicies/[POLICY_ID]+, identifying the policy in the container.
29
+ # `/alertPolicies/[POLICY_ID]`, identifying the policy in the container.
30
30
  # @!attribute [rw] alert_policy
31
31
  # @return [Google::Monitoring::V3::AlertPolicy]
32
- # The requested alerting policy. You should omit the +name+ field in this
32
+ # The requested alerting policy. You should omit the `name` field in this
33
33
  # policy. The name will be returned in the new policy, including
34
34
  # a new [ALERT_POLICY_ID] value.
35
35
  class CreateAlertPolicyRequest; end
36
36
 
37
- # The protocol for the +GetAlertPolicy+ request.
37
+ # The protocol for the `GetAlertPolicy` request.
38
38
  # @!attribute [rw] name
39
39
  # @return [String]
40
40
  # The alerting policy to retrieve. The format is
@@ -42,7 +42,7 @@ module Google
42
42
  # projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
43
43
  class GetAlertPolicyRequest; end
44
44
 
45
- # The protocol for the +ListAlertPolicies+ request.
45
+ # The protocol for the `ListAlertPolicies` request.
46
46
  # @!attribute [rw] name
47
47
  # @return [String]
48
48
  # The project whose alert policies are to be listed. The format is
@@ -64,7 +64,7 @@ module Google
64
64
  # @!attribute [rw] order_by
65
65
  # @return [String]
66
66
  # A comma-separated list of fields by which to sort the result. Supports
67
- # the same set of field references as the +filter+ field. Entries can be
67
+ # the same set of field references as the `filter` field. Entries can be
68
68
  # prefixed with a minus sign to sort by the field in descending order.
69
69
  #
70
70
  # For more details, see [sorting and
@@ -74,12 +74,12 @@ module Google
74
74
  # The maximum number of results to return in a single response.
75
75
  # @!attribute [rw] page_token
76
76
  # @return [String]
77
- # If this field is not empty then it must contain the +nextPageToken+ value
77
+ # If this field is not empty then it must contain the `nextPageToken` value
78
78
  # returned by a previous call to this method. Using this field causes the
79
79
  # method to return more results from the previous method call.
80
80
  class ListAlertPoliciesRequest; end
81
81
 
82
- # The protocol for the +ListAlertPolicies+ response.
82
+ # The protocol for the `ListAlertPolicies` response.
83
83
  # @!attribute [rw] alert_policies
84
84
  # @return [Array<Google::Monitoring::V3::AlertPolicy>]
85
85
  # The returned alert policies.
@@ -87,42 +87,42 @@ module Google
87
87
  # @return [String]
88
88
  # If there might be more results than were returned, then this field is set
89
89
  # to a non-empty value. To see the additional results,
90
- # use that value as +pageToken+ in the next call to this method.
90
+ # use that value as `pageToken` in the next call to this method.
91
91
  class ListAlertPoliciesResponse; end
92
92
 
93
- # The protocol for the +UpdateAlertPolicy+ request.
93
+ # The protocol for the `UpdateAlertPolicy` request.
94
94
  # @!attribute [rw] update_mask
95
95
  # @return [Google::Protobuf::FieldMask]
96
96
  # Optional. A list of alerting policy field names. If this field is not
97
97
  # empty, each listed field in the existing alerting policy is set to the
98
- # value of the corresponding field in the supplied policy (+alert_policy+),
98
+ # value of the corresponding field in the supplied policy (`alert_policy`),
99
99
  # or to the field's default value if the field is not in the supplied
100
100
  # alerting policy. Fields not listed retain their previous value.
101
101
  #
102
- # Examples of valid field masks include +display_name+, +documentation+,
103
- # +documentation.content+, +documentation.mime_type+, +user_labels+,
104
- # +user_label.nameofkey+, +enabled+, +conditions+, +combiner+, etc.
102
+ # Examples of valid field masks include `display_name`, `documentation`,
103
+ # `documentation.content`, `documentation.mime_type`, `user_labels`,
104
+ # `user_label.nameofkey`, `enabled`, `conditions`, `combiner`, etc.
105
105
  #
106
106
  # If this field is empty, then the supplied alerting policy replaces the
107
107
  # existing policy. It is the same as deleting the existing policy and
108
108
  # adding the supplied policy, except for the following:
109
109
  #
110
- # * The new policy will have the same +[ALERT_POLICY_ID]+ as the former
110
+ # * The new policy will have the same `[ALERT_POLICY_ID]` as the former
111
111
  # policy. This gives you continuity with the former policy in your
112
112
  # notifications and incidents.
113
- # * Conditions in the new policy will keep their former +[CONDITION_ID]+ if
114
- # the supplied condition includes the +name+ field with that
115
- # +[CONDITION_ID]+. If the supplied condition omits the +name+ field,
116
- # then a new +[CONDITION_ID]+ is created.
113
+ # * Conditions in the new policy will keep their former `[CONDITION_ID]` if
114
+ # the supplied condition includes the `name` field with that
115
+ # `[CONDITION_ID]`. If the supplied condition omits the `name` field,
116
+ # then a new `[CONDITION_ID]` is created.
117
117
  # @!attribute [rw] alert_policy
118
118
  # @return [Google::Monitoring::V3::AlertPolicy]
119
119
  # Required. The updated alerting policy or the updated values for the
120
- # fields listed in +update_mask+.
121
- # If +update_mask+ is not empty, any fields in this policy that are
122
- # not in +update_mask+ are ignored.
120
+ # fields listed in `update_mask`.
121
+ # If `update_mask` is not empty, any fields in this policy that are
122
+ # not in `update_mask` are ignored.
123
123
  class UpdateAlertPolicyRequest; end
124
124
 
125
- # The protocol for the +DeleteAlertPolicy+ request.
125
+ # The protocol for the `DeleteAlertPolicy` request.
126
126
  # @!attribute [rw] name
127
127
  # @return [String]
128
128
  # The alerting policy to delete. The format is: