google-cloud-monitoring-v3 0.9.0 → 0.10.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,318 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # Required information for every language.
23
+ # @!attribute [rw] reference_docs_uri
24
+ # @return [::String]
25
+ # Link to automatically generated reference documentation. Example:
26
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
27
+ # @!attribute [rw] destinations
28
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
29
+ # The destination where API teams want this client library to be published.
30
+ class CommonLanguageSettings
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Details about how and where to publish client libraries.
36
+ # @!attribute [rw] version
37
+ # @return [::String]
38
+ # Version of the API to apply these settings to.
39
+ # @!attribute [rw] launch_stage
40
+ # @return [::Google::Api::LaunchStage]
41
+ # Launch stage of this version of the API.
42
+ # @!attribute [rw] rest_numeric_enums
43
+ # @return [::Boolean]
44
+ # When using transport=rest, the client request will encode enums as
45
+ # numbers rather than strings.
46
+ # @!attribute [rw] java_settings
47
+ # @return [::Google::Api::JavaSettings]
48
+ # Settings for legacy Java features, supported in the Service YAML.
49
+ # @!attribute [rw] cpp_settings
50
+ # @return [::Google::Api::CppSettings]
51
+ # Settings for C++ client libraries.
52
+ # @!attribute [rw] php_settings
53
+ # @return [::Google::Api::PhpSettings]
54
+ # Settings for PHP client libraries.
55
+ # @!attribute [rw] python_settings
56
+ # @return [::Google::Api::PythonSettings]
57
+ # Settings for Python client libraries.
58
+ # @!attribute [rw] node_settings
59
+ # @return [::Google::Api::NodeSettings]
60
+ # Settings for Node client libraries.
61
+ # @!attribute [rw] dotnet_settings
62
+ # @return [::Google::Api::DotnetSettings]
63
+ # Settings for .NET client libraries.
64
+ # @!attribute [rw] ruby_settings
65
+ # @return [::Google::Api::RubySettings]
66
+ # Settings for Ruby client libraries.
67
+ # @!attribute [rw] go_settings
68
+ # @return [::Google::Api::GoSettings]
69
+ # Settings for Go client libraries.
70
+ class ClientLibrarySettings
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # This message configures the settings for publishing [Google Cloud Client
76
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
77
+ # generated from the service config.
78
+ # @!attribute [rw] method_settings
79
+ # @return [::Array<::Google::Api::MethodSettings>]
80
+ # A list of API method settings, e.g. the behavior for methods that use the
81
+ # long-running operation pattern.
82
+ # @!attribute [rw] new_issue_uri
83
+ # @return [::String]
84
+ # Link to a place that API users can report issues. Example:
85
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
+ # @!attribute [rw] documentation_uri
87
+ # @return [::String]
88
+ # Link to product home page. Example:
89
+ # https://cloud.google.com/asset-inventory/docs/overview
90
+ # @!attribute [rw] api_short_name
91
+ # @return [::String]
92
+ # Used as a tracking tag when collecting data about the APIs developer
93
+ # relations artifacts like docs, packages delivered to package managers,
94
+ # etc. Example: "speech".
95
+ # @!attribute [rw] github_label
96
+ # @return [::String]
97
+ # GitHub label to apply to issues and pull requests opened for this API.
98
+ # @!attribute [rw] codeowner_github_teams
99
+ # @return [::Array<::String>]
100
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
101
+ # containing source code for the client libraries for this API.
102
+ # @!attribute [rw] doc_tag_prefix
103
+ # @return [::String]
104
+ # A prefix used in sample code when demarking regions to be included in
105
+ # documentation.
106
+ # @!attribute [rw] organization
107
+ # @return [::Google::Api::ClientLibraryOrganization]
108
+ # For whom the client library is being published.
109
+ # @!attribute [rw] library_settings
110
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
111
+ # Client library settings. If the same version string appears multiple
112
+ # times in this list, then the last one wins. Settings from earlier
113
+ # settings with the same version string are discarded.
114
+ class Publishing
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Settings for Java client libraries.
120
+ # @!attribute [rw] library_package
121
+ # @return [::String]
122
+ # The package name to use in Java. Clobbers the java_package option
123
+ # set in the protobuf. This should be used **only** by APIs
124
+ # who have already set the language_settings.java.package_name" field
125
+ # in gapic.yaml. API teams should use the protobuf java_package option
126
+ # where possible.
127
+ #
128
+ # Example of a YAML configuration::
129
+ #
130
+ # publishing:
131
+ # java_settings:
132
+ # library_package: com.google.cloud.pubsub.v1
133
+ # @!attribute [rw] service_class_names
134
+ # @return [::Google::Protobuf::Map{::String => ::String}]
135
+ # Configure the Java class name to use instead of the service's for its
136
+ # corresponding generated GAPIC client. Keys are fully-qualified
137
+ # service names as they appear in the protobuf (including the full
138
+ # the language_settings.java.interface_names" field in gapic.yaml. API
139
+ # teams should otherwise use the service name as it appears in the
140
+ # protobuf.
141
+ #
142
+ # Example of a YAML configuration::
143
+ #
144
+ # publishing:
145
+ # java_settings:
146
+ # service_class_names:
147
+ # - google.pubsub.v1.Publisher: TopicAdmin
148
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
149
+ # @!attribute [rw] common
150
+ # @return [::Google::Api::CommonLanguageSettings]
151
+ # Some settings.
152
+ class JavaSettings
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # @!attribute [rw] key
157
+ # @return [::String]
158
+ # @!attribute [rw] value
159
+ # @return [::String]
160
+ class ServiceClassNamesEntry
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+ end
165
+
166
+ # Settings for C++ client libraries.
167
+ # @!attribute [rw] common
168
+ # @return [::Google::Api::CommonLanguageSettings]
169
+ # Some settings.
170
+ class CppSettings
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Settings for Php client libraries.
176
+ # @!attribute [rw] common
177
+ # @return [::Google::Api::CommonLanguageSettings]
178
+ # Some settings.
179
+ class PhpSettings
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Settings for Python client libraries.
185
+ # @!attribute [rw] common
186
+ # @return [::Google::Api::CommonLanguageSettings]
187
+ # Some settings.
188
+ class PythonSettings
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+
193
+ # Settings for Node client libraries.
194
+ # @!attribute [rw] common
195
+ # @return [::Google::Api::CommonLanguageSettings]
196
+ # Some settings.
197
+ class NodeSettings
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Settings for Dotnet client libraries.
203
+ # @!attribute [rw] common
204
+ # @return [::Google::Api::CommonLanguageSettings]
205
+ # Some settings.
206
+ class DotnetSettings
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Settings for Ruby client libraries.
212
+ # @!attribute [rw] common
213
+ # @return [::Google::Api::CommonLanguageSettings]
214
+ # Some settings.
215
+ class RubySettings
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Settings for Go client libraries.
221
+ # @!attribute [rw] common
222
+ # @return [::Google::Api::CommonLanguageSettings]
223
+ # Some settings.
224
+ class GoSettings
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Describes the generator configuration for a method.
230
+ # @!attribute [rw] selector
231
+ # @return [::String]
232
+ # The fully qualified name of the method, for which the options below apply.
233
+ # This is used to find the method to apply the options.
234
+ # @!attribute [rw] long_running
235
+ # @return [::Google::Api::MethodSettings::LongRunning]
236
+ # Describes settings to use for long-running operations when generating
237
+ # API methods for RPCs. Complements RPCs that use the annotations in
238
+ # google/longrunning/operations.proto.
239
+ #
240
+ # Example of a YAML configuration::
241
+ #
242
+ # publishing:
243
+ # method_behavior:
244
+ # - selector: CreateAdDomain
245
+ # long_running:
246
+ # initial_poll_delay:
247
+ # seconds: 60 # 1 minute
248
+ # poll_delay_multiplier: 1.5
249
+ # max_poll_delay:
250
+ # seconds: 360 # 6 minutes
251
+ # total_poll_timeout:
252
+ # seconds: 54000 # 90 minutes
253
+ class MethodSettings
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+
257
+ # Describes settings to use when generating API methods that use the
258
+ # long-running operation pattern.
259
+ # All default values below are from those used in the client library
260
+ # generators (e.g.
261
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
262
+ # @!attribute [rw] initial_poll_delay
263
+ # @return [::Google::Protobuf::Duration]
264
+ # Initial delay after which the first poll request will be made.
265
+ # Default value: 5 seconds.
266
+ # @!attribute [rw] poll_delay_multiplier
267
+ # @return [::Float]
268
+ # Multiplier to gradually increase delay between subsequent polls until it
269
+ # reaches max_poll_delay.
270
+ # Default value: 1.5.
271
+ # @!attribute [rw] max_poll_delay
272
+ # @return [::Google::Protobuf::Duration]
273
+ # Maximum time between two subsequent poll requests.
274
+ # Default value: 45 seconds.
275
+ # @!attribute [rw] total_poll_timeout
276
+ # @return [::Google::Protobuf::Duration]
277
+ # Total polling timeout.
278
+ # Default value: 5 minutes.
279
+ class LongRunning
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+ end
284
+
285
+ # The organization for which the client libraries are being published.
286
+ # Affects the url where generated docs are published, etc.
287
+ module ClientLibraryOrganization
288
+ # Not useful.
289
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
290
+
291
+ # Google Cloud Platform Org.
292
+ CLOUD = 1
293
+
294
+ # Ads (Advertising) Org.
295
+ ADS = 2
296
+
297
+ # Photos Org.
298
+ PHOTOS = 3
299
+
300
+ # Street View Org.
301
+ STREET_VIEW = 4
302
+ end
303
+
304
+ # To where should client libraries be published?
305
+ module ClientLibraryDestination
306
+ # Client libraries will neither be generated nor published to package
307
+ # managers.
308
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
309
+
310
+ # Generate the client library in a repo under github.com/googleapis,
311
+ # but don't publish it to package managers.
312
+ GITHUB = 10
313
+
314
+ # Publish the library to package managers like nuget.org and npmjs.com.
315
+ PACKAGE_MANAGER = 20
316
+ end
317
+ end
318
+ end
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Api
22
22
  # The launch stage as defined by [Google Cloud Platform
23
- # Launch Stages](http://cloud.google.com/terms/launch-stages).
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
24
  module LaunchStage
25
25
  # Do not use this default value.
26
26
  LAUNCH_STAGE_UNSPECIFIED = 0
@@ -42,7 +42,7 @@ module Google
42
42
  # for widespread use. By Alpha, all significant design issues are resolved
43
43
  # and we are in the process of verifying functionality. Alpha customers
44
44
  # need to apply for access, agree to applicable terms, and have their
45
- # projects allowlisted. Alpha releases dont have to be feature complete,
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
46
  # no SLAs are provided, and there are no technical support obligations, but
47
47
  # they will be far enough along that customers can actually use them in
48
48
  # test environments or for limited-use tests -- just like they would in
@@ -61,7 +61,7 @@ module Google
61
61
  GA = 4
62
62
 
63
63
  # Deprecated features are scheduled to be shut down and removed. For more
64
- # information, see the Deprecation Policy section of our [Terms of
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
65
  # Service](https://cloud.google.com/terms/)
66
66
  # and the [Google Cloud Platform Subject to the Deprecation
67
67
  # Policy](https://cloud.google.com/terms/deprecation) documentation.
@@ -40,6 +40,10 @@ module Google
40
40
  # @return [::String]
41
41
  # Required. The monitored resource type. For example, the type
42
42
  # `"cloudsql_database"` represents databases in Google Cloud SQL.
43
+ # For a list of types, see [Monitoring resource
44
+ # types](https://cloud.google.com/monitoring/api/resources)
45
+ # and [Logging resource
46
+ # types](https://cloud.google.com/logging/docs/api/v2/resource-list).
43
47
  # @!attribute [rw] display_name
44
48
  # @return [::String]
45
49
  # Optional. A concise name for the monitored resource type that might be
@@ -71,16 +75,19 @@ module Google
71
75
  # its attributes according to the schema. For example, a particular Compute
72
76
  # Engine VM instance could be represented by the following object, because the
73
77
  # {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} for `"gce_instance"` has labels
74
- # `"instance_id"` and `"zone"`:
78
+ # `"project_id"`, `"instance_id"` and `"zone"`:
75
79
  #
76
80
  # { "type": "gce_instance",
77
- # "labels": { "instance_id": "12345678901234",
81
+ # "labels": { "project_id": "my-project",
82
+ # "instance_id": "12345678901234",
78
83
  # "zone": "us-central1-a" }}
79
84
  # @!attribute [rw] type
80
85
  # @return [::String]
81
86
  # Required. The monitored resource type. This field must match
82
87
  # the `type` field of a {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object. For
83
88
  # example, the type of a Compute Engine VM instance is `gce_instance`.
89
+ # Some descriptors include the service name in the type; for example,
90
+ # the type of a Datastream stream is `datastream.googleapis.com/Stream`.
84
91
  # @!attribute [rw] labels
85
92
  # @return [::Google::Protobuf::Map{::String => ::String}]
86
93
  # Required. Values for all of the labels listed in the associated monitored
@@ -0,0 +1,74 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Monitoring
23
+ module V3
24
+ # A `Snooze` will prevent any alerts from being opened, and close any that
25
+ # are already open. The `Snooze` will work on alerts that match the
26
+ # criteria defined in the `Snooze`. The `Snooze` will be active from
27
+ # `interval.start_time` through `interval.end_time`.
28
+ # @!attribute [rw] name
29
+ # @return [::String]
30
+ # Required. The name of the `Snooze`. The format is:
31
+ #
32
+ # projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
33
+ #
34
+ # The ID of the `Snooze` will be generated by the system.
35
+ # @!attribute [rw] criteria
36
+ # @return [::Google::Cloud::Monitoring::V3::Snooze::Criteria]
37
+ # Required. This defines the criteria for applying the `Snooze`. See
38
+ # `Criteria` for more information.
39
+ # @!attribute [rw] interval
40
+ # @return [::Google::Cloud::Monitoring::V3::TimeInterval]
41
+ # Required. The `Snooze` will be active from `interval.start_time` through
42
+ # `interval.end_time`.
43
+ # `interval.start_time` cannot be in the past. There is a 15 second clock
44
+ # skew to account for the time it takes for a request to reach the API from
45
+ # the UI.
46
+ # @!attribute [rw] display_name
47
+ # @return [::String]
48
+ # Required. A display name for the `Snooze`. This can be, at most, 512
49
+ # unicode characters.
50
+ class Snooze
51
+ include ::Google::Protobuf::MessageExts
52
+ extend ::Google::Protobuf::MessageExts::ClassMethods
53
+
54
+ # Criteria specific to the `AlertPolicy`s that this `Snooze` applies to. The
55
+ # `Snooze` will suppress alerts that come from one of the `AlertPolicy`s
56
+ # whose names are supplied.
57
+ # @!attribute [rw] policies
58
+ # @return [::Array<::String>]
59
+ # The specific `AlertPolicy` names for the alert that should be snoozed.
60
+ # The format is:
61
+ #
62
+ # projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]
63
+ #
64
+ # There is a limit of 10 policies per snooze. This limit is checked during
65
+ # snooze creation.
66
+ class Criteria
67
+ include ::Google::Protobuf::MessageExts
68
+ extend ::Google::Protobuf::MessageExts::ClassMethods
69
+ end
70
+ end
71
+ end
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,154 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Monitoring
23
+ module V3
24
+ # The message definition for creating a `Snooze`. Users must provide the body
25
+ # of the `Snooze` to be created but must omit the `Snooze` field, `name`.
26
+ # @!attribute [rw] parent
27
+ # @return [::String]
28
+ # Required. The
29
+ # [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
30
+ # a `Snooze` should be created. The format is:
31
+ #
32
+ # projects/[PROJECT_ID_OR_NUMBER]
33
+ # @!attribute [rw] snooze
34
+ # @return [::Google::Cloud::Monitoring::V3::Snooze]
35
+ # Required. The `Snooze` to create. Omit the `name` field, as it will be
36
+ # filled in by the API.
37
+ class CreateSnoozeRequest
38
+ include ::Google::Protobuf::MessageExts
39
+ extend ::Google::Protobuf::MessageExts::ClassMethods
40
+ end
41
+
42
+ # The message definition for listing `Snooze`s associated with the given
43
+ # `parent`, satisfying the optional `filter`.
44
+ # @!attribute [rw] parent
45
+ # @return [::String]
46
+ # Required. The
47
+ # [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
48
+ # `Snooze`s should be listed. The format is:
49
+ #
50
+ # projects/[PROJECT_ID_OR_NUMBER]
51
+ # @!attribute [rw] filter
52
+ # @return [::String]
53
+ # Optional. Optional filter to restrict results to the given criteria. The
54
+ # following fields are supported.
55
+ #
56
+ # * `interval.start_time`
57
+ # * `interval.end_time`
58
+ #
59
+ # For example:
60
+ #
61
+ # ```
62
+ # interval.start_time > "2022-03-11T00:00:00-08:00" AND
63
+ # interval.end_time < "2022-03-12T00:00:00-08:00"
64
+ # ```
65
+ # @!attribute [rw] page_size
66
+ # @return [::Integer]
67
+ # Optional. The maximum number of results to return for a single query. The
68
+ # server may further constrain the maximum number of results returned in a
69
+ # single page. The value should be in the range [1, 1000]. If the value given
70
+ # is outside this range, the server will decide the number of results to be
71
+ # returned.
72
+ # @!attribute [rw] page_token
73
+ # @return [::String]
74
+ # Optional. The `next_page_token` from a previous call to
75
+ # `ListSnoozesRequest` to get the next page of results.
76
+ class ListSnoozesRequest
77
+ include ::Google::Protobuf::MessageExts
78
+ extend ::Google::Protobuf::MessageExts::ClassMethods
79
+ end
80
+
81
+ # The results of a successful `ListSnoozes` call, containing the matching
82
+ # `Snooze`s.
83
+ # @!attribute [rw] snoozes
84
+ # @return [::Array<::Google::Cloud::Monitoring::V3::Snooze>]
85
+ # `Snooze`s matching this list call.
86
+ # @!attribute [rw] next_page_token
87
+ # @return [::String]
88
+ # Page token for repeated calls to `ListSnoozes`, to fetch additional pages
89
+ # of results. If this is empty or missing, there are no more pages.
90
+ class ListSnoozesResponse
91
+ include ::Google::Protobuf::MessageExts
92
+ extend ::Google::Protobuf::MessageExts::ClassMethods
93
+ end
94
+
95
+ # The message definition for retrieving a `Snooze`. Users must specify the
96
+ # field, `name`, which identifies the `Snooze`.
97
+ # @!attribute [rw] name
98
+ # @return [::String]
99
+ # Required. The ID of the `Snooze` to retrieve. The format is:
100
+ #
101
+ # projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
102
+ class GetSnoozeRequest
103
+ include ::Google::Protobuf::MessageExts
104
+ extend ::Google::Protobuf::MessageExts::ClassMethods
105
+ end
106
+
107
+ # The message definition for updating a `Snooze`. The field, `snooze.name`
108
+ # identifies the `Snooze` to be updated. The remainder of `snooze` gives the
109
+ # content the `Snooze` in question will be assigned.
110
+ #
111
+ # What fields can be updated depends on the start time and end time of the
112
+ # `Snooze`.
113
+ #
114
+ # * end time is in the past: These `Snooze`s are considered
115
+ # read-only and cannot be updated.
116
+ # * start time is in the past and end time is in the future: `display_name`
117
+ # and `interval.end_time` can be updated.
118
+ # * start time is in the future: `display_name`, `interval.start_time` and
119
+ # `interval.end_time` can be updated.
120
+ # @!attribute [rw] snooze
121
+ # @return [::Google::Cloud::Monitoring::V3::Snooze]
122
+ # Required. The `Snooze` to update. Must have the name field present.
123
+ # @!attribute [rw] update_mask
124
+ # @return [::Google::Protobuf::FieldMask]
125
+ # Required. The fields to update.
126
+ #
127
+ # For each field listed in `update_mask`:
128
+ #
129
+ # * If the `Snooze` object supplied in the `UpdateSnoozeRequest` has a
130
+ # value for that field, the value of the field in the existing `Snooze`
131
+ # will be set to the value of the field in the supplied `Snooze`.
132
+ # * If the field does not have a value in the supplied `Snooze`, the field
133
+ # in the existing `Snooze` is set to its default value.
134
+ #
135
+ # Fields not listed retain their existing value.
136
+ #
137
+ # The following are the field names that are accepted in `update_mask`:
138
+ #
139
+ # * `display_name`
140
+ # * `interval.start_time`
141
+ # * `interval.end_time`
142
+ #
143
+ # That said, the start time and end time of the `Snooze` determines which
144
+ # fields can legally be updated. Before attempting an update, users should
145
+ # consult the documentation for `UpdateSnoozeRequest`, which talks about
146
+ # which fields can be updated.
147
+ class UpdateSnoozeRequest
148
+ include ::Google::Protobuf::MessageExts
149
+ extend ::Google::Protobuf::MessageExts::ClassMethods
150
+ end
151
+ end
152
+ end
153
+ end
154
+ end
@@ -28,12 +28,14 @@ module Google
28
28
  # [API Design Guide](https://cloud.google.com/apis/design/errors).
29
29
  # @!attribute [rw] code
30
30
  # @return [::Integer]
31
- # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
31
+ # The status code, which should be an enum value of
32
+ # [google.rpc.Code][google.rpc.Code].
32
33
  # @!attribute [rw] message
33
34
  # @return [::String]
34
35
  # A developer-facing error message, which should be in English. Any
35
36
  # user-facing error message should be localized and sent in the
36
- # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
37
+ # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
38
+ # by the client.
37
39
  # @!attribute [rw] details
38
40
  # @return [::Array<::Google::Protobuf::Any>]
39
41
  # A list of messages that carry the error details. There is a common set of