google-cloud-service_health-v1 0.a → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/service_health/v1/bindings_override.rb +102 -0
  6. data/lib/google/cloud/service_health/v1/rest.rb +38 -0
  7. data/lib/google/cloud/service_health/v1/service_health/client.rb +1084 -0
  8. data/lib/google/cloud/service_health/v1/service_health/credentials.rb +47 -0
  9. data/lib/google/cloud/service_health/v1/service_health/paths.rb +124 -0
  10. data/lib/google/cloud/service_health/v1/service_health/rest/client.rb +1021 -0
  11. data/lib/google/cloud/service_health/v1/service_health/rest/service_stub.rb +423 -0
  12. data/lib/google/cloud/service_health/v1/service_health/rest.rb +53 -0
  13. data/lib/google/cloud/service_health/v1/service_health.rb +55 -0
  14. data/lib/google/cloud/service_health/v1/version.rb +7 -2
  15. data/lib/google/cloud/service_health/v1.rb +45 -0
  16. data/lib/google/cloud/servicehealth/v1/event_resources_pb.rb +74 -0
  17. data/lib/google/cloud/servicehealth/v1/event_service_pb.rb +45 -0
  18. data/lib/google/cloud/servicehealth/v1/event_service_services_pb.rb +58 -0
  19. data/lib/google-cloud-service_health-v1.rb +21 -0
  20. data/proto_docs/README.md +4 -0
  21. data/proto_docs/google/api/client.rb +395 -0
  22. data/proto_docs/google/api/field_behavior.rb +85 -0
  23. data/proto_docs/google/api/launch_stage.rb +71 -0
  24. data/proto_docs/google/api/resource.rb +222 -0
  25. data/proto_docs/google/cloud/servicehealth/v1/event_resources.rb +694 -0
  26. data/proto_docs/google/protobuf/any.rb +145 -0
  27. data/proto_docs/google/protobuf/duration.rb +98 -0
  28. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  29. metadata +202 -10
@@ -0,0 +1,694 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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 ServiceHealth
23
+ module V1
24
+ # Represents service health events that may affect Google Cloud products.
25
+ # Event resource is a read-only view and does not allow any modifications. All
26
+ # fields are output only.
27
+ # @!attribute [r] name
28
+ # @return [::String]
29
+ # Output only. Identifier. Name of the event. Unique name of the event in
30
+ # this scope including project and location using the form
31
+ # `projects/{project_id}/locations/{location}/events/{event_id}`.
32
+ # @!attribute [r] title
33
+ # @return [::String]
34
+ # Output only. Brief description for the event.
35
+ # @!attribute [r] description
36
+ # @return [::String]
37
+ # Output only. Free-form, human-readable description.
38
+ # @!attribute [r] category
39
+ # @return [::Google::Cloud::ServiceHealth::V1::Event::EventCategory]
40
+ # Output only. The category of the event.
41
+ # @!attribute [r] detailed_category
42
+ # @return [::Google::Cloud::ServiceHealth::V1::Event::DetailedCategory]
43
+ # Output only. The detailed category of the event.
44
+ # @!attribute [r] state
45
+ # @return [::Google::Cloud::ServiceHealth::V1::Event::State]
46
+ # Output only. The current state of the event.
47
+ # @!attribute [r] detailed_state
48
+ # @return [::Google::Cloud::ServiceHealth::V1::Event::DetailedState]
49
+ # Output only. The current detailed state of the incident.
50
+ # @!attribute [rw] event_impacts
51
+ # @return [::Array<::Google::Cloud::ServiceHealth::V1::EventImpact>]
52
+ # Google Cloud products and locations impacted by the event.
53
+ # @!attribute [r] relevance
54
+ # @return [::Google::Cloud::ServiceHealth::V1::Event::Relevance]
55
+ # Output only. Communicates why a given event is deemed relevant in the
56
+ # context of a given project.
57
+ # @!attribute [r] updates
58
+ # @return [::Array<::Google::Cloud::ServiceHealth::V1::EventUpdate>]
59
+ # Output only. Event updates are correspondence from Google.
60
+ # @!attribute [r] parent_event
61
+ # @return [::String]
62
+ # Output only. When `detailed_state`=`MERGED`, `parent_event` contains the
63
+ # name of the parent event. All further updates will be published to the
64
+ # parent event.
65
+ # @!attribute [r] update_time
66
+ # @return [::Google::Protobuf::Timestamp]
67
+ # Output only. The time when the event was last modified.
68
+ # @!attribute [r] start_time
69
+ # @return [::Google::Protobuf::Timestamp]
70
+ # Output only. The start time of the event, if applicable.
71
+ # @!attribute [r] end_time
72
+ # @return [::Google::Protobuf::Timestamp]
73
+ # Output only. The end time of the event, if applicable.
74
+ # @!attribute [r] next_update_time
75
+ # @return [::Google::Protobuf::Timestamp]
76
+ # Output only. The time when the next update can be expected.
77
+ class Event
78
+ include ::Google::Protobuf::MessageExts
79
+ extend ::Google::Protobuf::MessageExts::ClassMethods
80
+
81
+ # The category of the event. This enum lists all possible categories of
82
+ # event.
83
+ module EventCategory
84
+ # Unspecified category.
85
+ EVENT_CATEGORY_UNSPECIFIED = 0
86
+
87
+ # Event category for service outage or degradation.
88
+ INCIDENT = 2
89
+ end
90
+
91
+ # The detailed category of an event. Contains all possible states for all
92
+ # event categories.
93
+ module DetailedCategory
94
+ # Unspecified detailed category.
95
+ DETAILED_CATEGORY_UNSPECIFIED = 0
96
+
97
+ # Indicates an event with category INCIDENT has a confirmed impact to at
98
+ # least one Google Cloud product.
99
+ CONFIRMED_INCIDENT = 1
100
+
101
+ # Indicates an event with category INCIDENT is under investigation to
102
+ # determine if it has a confirmed impact on any Google Cloud products.
103
+ EMERGING_INCIDENT = 2
104
+ end
105
+
106
+ # The state of the event. This enum lists all possible states of event.
107
+ module State
108
+ # Unspecified state.
109
+ STATE_UNSPECIFIED = 0
110
+
111
+ # Event is actively affecting a Google Cloud product and will continue to
112
+ # receive updates.
113
+ ACTIVE = 1
114
+
115
+ # Event is no longer affecting the Google Cloud product or has been merged
116
+ # with another event.
117
+ CLOSED = 2
118
+ end
119
+
120
+ # The detailed state of the incident. This enum lists all possible detailed
121
+ # states of an incident.
122
+ module DetailedState
123
+ # Unspecified detail state.
124
+ DETAILED_STATE_UNSPECIFIED = 0
125
+
126
+ # Google engineers are actively investigating the event to determine the
127
+ # impact.
128
+ EMERGING = 1
129
+
130
+ # The incident is confirmed and impacting at least one Google Cloud
131
+ # product. Ongoing status updates will be provided until it is resolved.
132
+ CONFIRMED = 2
133
+
134
+ # The incident is no longer affecting any Google Cloud product, and there
135
+ # will be no further updates.
136
+ RESOLVED = 3
137
+
138
+ # The incident was merged into a parent incident. All further updates will
139
+ # be published to the parent only. The `parent_event` field contains the
140
+ # name of the parent.
141
+ MERGED = 4
142
+
143
+ # The incident was automatically closed because the issues couldn’t be
144
+ # confirmed or is no longer impacting Google Cloud Products and/or
145
+ # Locations.
146
+ AUTO_CLOSED = 9
147
+
148
+ # The incident was verified as non-impactful. No further action required.
149
+ FALSE_POSITIVE = 10
150
+ end
151
+
152
+ # Communicates why a given incident is deemed relevant in the context of a
153
+ # given project. This enum lists all possible detailed states of relevance.
154
+ module Relevance
155
+ # Unspecified relevance.
156
+ RELEVANCE_UNSPECIFIED = 0
157
+
158
+ # The relevance of the incident to the project is unknown.
159
+ UNKNOWN = 2
160
+
161
+ # The incident does not impact the project.
162
+ NOT_IMPACTED = 6
163
+
164
+ # The incident is associated with a Google Cloud product your project uses,
165
+ # but the incident may not be impacting your project. For example, the
166
+ # incident may be impacting a Google Cloud product that your project uses,
167
+ # but in a location that your project does not use.
168
+ PARTIALLY_RELATED = 7
169
+
170
+ # The incident has a direct connection with your project and impacts a
171
+ # Google Cloud product in a location your project uses.
172
+ RELATED = 8
173
+
174
+ # The incident is verified to be impacting your project.
175
+ IMPACTED = 9
176
+ end
177
+ end
178
+
179
+ # Represents service health events that may affect Google Cloud products used
180
+ # across the organization. It is a read-only view and does not allow any
181
+ # modifications.
182
+ # @!attribute [r] name
183
+ # @return [::String]
184
+ # Output only. Identifier. Name of the event. Unique name of the event in
185
+ # this scope including organization ID and location using the form
186
+ # `organizations/{organization_id}/locations/{location}/organizationEvents/{event_id}`.
187
+ #
188
+ # `organization_id` - see [Getting your organization resource
189
+ # ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).<br>
190
+ # `location` - The location to get the service health events from.<br>
191
+ # `event_id` - Organization event ID to retrieve.
192
+ # @!attribute [r] title
193
+ # @return [::String]
194
+ # Output only. Brief description for the event.
195
+ # @!attribute [r] description
196
+ # @return [::String]
197
+ # Output only. Free-form, human-readable description.
198
+ # @!attribute [r] category
199
+ # @return [::Google::Cloud::ServiceHealth::V1::OrganizationEvent::EventCategory]
200
+ # Output only. The category of the event.
201
+ # @!attribute [r] detailed_category
202
+ # @return [::Google::Cloud::ServiceHealth::V1::OrganizationEvent::DetailedCategory]
203
+ # Output only. The detailed category of the event.
204
+ # @!attribute [r] state
205
+ # @return [::Google::Cloud::ServiceHealth::V1::OrganizationEvent::State]
206
+ # Output only. The current state of the event.
207
+ # @!attribute [r] detailed_state
208
+ # @return [::Google::Cloud::ServiceHealth::V1::OrganizationEvent::DetailedState]
209
+ # Output only. The current detailed state of the incident.
210
+ # @!attribute [r] event_impacts
211
+ # @return [::Array<::Google::Cloud::ServiceHealth::V1::EventImpact>]
212
+ # Output only. Represents the Google Cloud products and locations impacted by
213
+ # the event.
214
+ # @!attribute [r] updates
215
+ # @return [::Array<::Google::Cloud::ServiceHealth::V1::EventUpdate>]
216
+ # Output only. Incident-only field. Event updates are correspondence from
217
+ # Google.
218
+ # @!attribute [r] parent_event
219
+ # @return [::String]
220
+ # Output only. When `detailed_state`=`MERGED`, `parent_event` contains the
221
+ # name of the parent event. All further updates will be published to the
222
+ # parent event.
223
+ # @!attribute [r] update_time
224
+ # @return [::Google::Protobuf::Timestamp]
225
+ # Output only. The time the update was posted.
226
+ # @!attribute [r] start_time
227
+ # @return [::Google::Protobuf::Timestamp]
228
+ # Output only. The start time of the event, if applicable.
229
+ # @!attribute [r] end_time
230
+ # @return [::Google::Protobuf::Timestamp]
231
+ # Output only. The end time of the event, if applicable.
232
+ # @!attribute [r] next_update_time
233
+ # @return [::Google::Protobuf::Timestamp]
234
+ # Output only. Incident-only field. The time when the next update can be
235
+ # expected.
236
+ class OrganizationEvent
237
+ include ::Google::Protobuf::MessageExts
238
+ extend ::Google::Protobuf::MessageExts::ClassMethods
239
+
240
+ # The category of the event. This enum lists all possible categories of
241
+ # event.
242
+ module EventCategory
243
+ # Unspecified category.
244
+ EVENT_CATEGORY_UNSPECIFIED = 0
245
+
246
+ # Event category for service outage or degradation.
247
+ INCIDENT = 2
248
+ end
249
+
250
+ # The detailed category of an event. Contains all possible states for all
251
+ # event categories.
252
+ module DetailedCategory
253
+ # Unspecified detailed category.
254
+ DETAILED_CATEGORY_UNSPECIFIED = 0
255
+
256
+ # Indicates an event with category INCIDENT has a confirmed impact to at
257
+ # least one Google Cloud product.
258
+ CONFIRMED_INCIDENT = 1
259
+
260
+ # Indicates an event with category INCIDENT is under investigation to
261
+ # determine if it has a confirmed impact on any Google Cloud products.
262
+ EMERGING_INCIDENT = 2
263
+ end
264
+
265
+ # The state of the organization event. This enum lists all possible states of
266
+ # event.
267
+ module State
268
+ # Unspecified state.
269
+ STATE_UNSPECIFIED = 0
270
+
271
+ # Event is actively affecting a Google Cloud product and will continue to
272
+ # receive updates.
273
+ ACTIVE = 1
274
+
275
+ # Event is no longer affecting the Google Cloud product or has been merged
276
+ # with another event.
277
+ CLOSED = 2
278
+ end
279
+
280
+ # The detailed state of the incident. This enum lists all possible detailed
281
+ # states of an incident.
282
+ module DetailedState
283
+ # Unspecified detail state.
284
+ DETAILED_STATE_UNSPECIFIED = 0
285
+
286
+ # Google engineers are actively investigating the incident to determine the
287
+ # impact.
288
+ EMERGING = 1
289
+
290
+ # The incident is confirmed and impacting at least one Google Cloud
291
+ # product. Ongoing status updates will be provided until it is resolved.
292
+ CONFIRMED = 2
293
+
294
+ # The incident is no longer affecting any Google Cloud product, and there
295
+ # will be no further updates.
296
+ RESOLVED = 3
297
+
298
+ # The incident was merged into a parent event. All further updates will be
299
+ # published to the parent only. The `parent_event` contains the name of the
300
+ # parent.
301
+ MERGED = 4
302
+
303
+ # The incident was automatically closed because the issues couldn’t be
304
+ # confirmed or is no longer impacting Google Cloud Products and/or
305
+ # Locations.
306
+ AUTO_CLOSED = 9
307
+
308
+ # The incident was verified as non-impactful. No further action required.
309
+ FALSE_POSITIVE = 10
310
+ end
311
+ end
312
+
313
+ # Records an update made to the event.
314
+ # @!attribute [r] update_time
315
+ # @return [::Google::Protobuf::Timestamp]
316
+ # Output only. The time the update was posted.
317
+ # @!attribute [r] title
318
+ # @return [::String]
319
+ # Output only. Brief title for the event.
320
+ # @!attribute [r] description
321
+ # @return [::String]
322
+ # Output only. Free-form, human-readable description.
323
+ # @!attribute [r] symptom
324
+ # @return [::String]
325
+ # Output only. Symptoms of the event, if available.
326
+ # @!attribute [r] workaround
327
+ # @return [::String]
328
+ # Output only. Workaround steps to remediate the event impact, if available.
329
+ class EventUpdate
330
+ include ::Google::Protobuf::MessageExts
331
+ extend ::Google::Protobuf::MessageExts::ClassMethods
332
+ end
333
+
334
+ # Represents the locations impacted by the event.
335
+ # @!attribute [rw] location_name
336
+ # @return [::String]
337
+ # Location impacted by the event. Example: `"us-central1"`
338
+ class Location
339
+ include ::Google::Protobuf::MessageExts
340
+ extend ::Google::Protobuf::MessageExts::ClassMethods
341
+ end
342
+
343
+ # Represents the Google Cloud product impacted by the event.
344
+ # @!attribute [rw] product_name
345
+ # @return [::String]
346
+ # Google Cloud product impacted by the event. Example: `"Google Cloud SQL"`
347
+ class Product
348
+ include ::Google::Protobuf::MessageExts
349
+ extend ::Google::Protobuf::MessageExts::ClassMethods
350
+ end
351
+
352
+ # Represents the Google Cloud products and locations impacted by the event.
353
+ # @!attribute [rw] product
354
+ # @return [::Google::Cloud::ServiceHealth::V1::Product]
355
+ # Google Cloud product impacted by the event.
356
+ # @!attribute [rw] location
357
+ # @return [::Google::Cloud::ServiceHealth::V1::Location]
358
+ # Location impacted by the event.
359
+ class EventImpact
360
+ include ::Google::Protobuf::MessageExts
361
+ extend ::Google::Protobuf::MessageExts::ClassMethods
362
+ end
363
+
364
+ # Represents impact to assets at organizational level. It is a read-only view
365
+ # and does not allow any modifications.
366
+ # @!attribute [r] name
367
+ # @return [::String]
368
+ # Output only. Identifier. Unique name of the organization impact in this
369
+ # scope including organization and location using the form
370
+ # `organizations/{organization_id}/locations/{location}/organizationImpacts/{organization_impact_id}`.
371
+ #
372
+ # `organization_id` - ID (number) of the organization that contains the
373
+ # event. To get your `organization_id`, see
374
+ # [Getting your organization resource
375
+ # ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).<br>
376
+ # `organization_impact_id` - ID of the [OrganizationImpact
377
+ # resource](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact).
378
+ # @!attribute [r] events
379
+ # @return [::Array<::String>]
380
+ # Output only. A list of event names impacting the asset.
381
+ # @!attribute [r] asset
382
+ # @return [::Google::Cloud::ServiceHealth::V1::Asset]
383
+ # Output only. Google Cloud asset possibly impacted by the specified events.
384
+ # @!attribute [r] update_time
385
+ # @return [::Google::Protobuf::Timestamp]
386
+ # Output only. The time when the affected project was last modified.
387
+ class OrganizationImpact
388
+ include ::Google::Protobuf::MessageExts
389
+ extend ::Google::Protobuf::MessageExts::ClassMethods
390
+ end
391
+
392
+ # Represents the asset impacted by the events.
393
+ # @!attribute [r] asset_name
394
+ # @return [::String]
395
+ # Output only. Full name of the resource as defined in
396
+ # [Resource
397
+ # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name).
398
+ # @!attribute [r] asset_type
399
+ # @return [::String]
400
+ # Output only. Type of the asset. Example:
401
+ # `"cloudresourcemanager.googleapis.com/Project"`
402
+ class Asset
403
+ include ::Google::Protobuf::MessageExts
404
+ extend ::Google::Protobuf::MessageExts::ClassMethods
405
+ end
406
+
407
+ # @!attribute [rw] parent
408
+ # @return [::String]
409
+ # Required. Parent value using the form
410
+ # `projects/{project_id}/locations/{location}/events`.
411
+ #
412
+ # `project_id` - ID of the project for which to list service health
413
+ # events.
414
+ # `location` - The location to get the service health events from.
415
+ # To retrieve service health events of category = INCIDENT, use `location` =
416
+ # `global`.
417
+ # @!attribute [rw] page_size
418
+ # @return [::Integer]
419
+ # Optional. The maximum number of events that should be returned. Acceptable
420
+ # values are 1 to 100, inclusive. (The default value is 10.) If more results
421
+ # are available, the service returns a next_page_token that you can use to
422
+ # get the next page of results in subsequent list requests. The service may
423
+ # return fewer events than the requested page_size.
424
+ # @!attribute [rw] page_token
425
+ # @return [::String]
426
+ # Optional. A token identifying a page of results the server should return.
427
+ # Provide Page token returned by a previous `ListEvents` call to retrieve the
428
+ # next page of results. When paginating, all other parameters provided to
429
+ # `ListEvents` must match the call that provided the page token.
430
+ # @!attribute [rw] filter
431
+ # @return [::String]
432
+ # Optional. A filter expression that filters resources listed in the
433
+ # response. The expression takes the following forms: <br>
434
+ # * field=value for `category` and `state`<br>
435
+ # * field &lt;, >, &lt;=, or >= value for `update_time` <br>
436
+ # Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00`
437
+ # <br>
438
+ #
439
+ # Multiple filter queries are separated by spaces. Example:
440
+ # `category=INCIDENT state=ACTIVE`.
441
+ #
442
+ # By default, each expression is an AND expression. However, you can include
443
+ # AND and OR expressions explicitly.
444
+ #
445
+ # Filter is supported for the following fields: `category`, `state`,
446
+ # `update_time`
447
+ # @!attribute [rw] view
448
+ # @return [::Google::Cloud::ServiceHealth::V1::EventView]
449
+ # Optional. Event fields to include in response.
450
+ class ListEventsRequest
451
+ include ::Google::Protobuf::MessageExts
452
+ extend ::Google::Protobuf::MessageExts::ClassMethods
453
+ end
454
+
455
+ # @!attribute [r] events
456
+ # @return [::Array<::Google::Cloud::ServiceHealth::V1::Event>]
457
+ # Output only. List of events.
458
+ # @!attribute [r] next_page_token
459
+ # @return [::String]
460
+ # Output only. The continuation token, used to page through large result
461
+ # sets. Provide this value in a subsequent request as page_token to retrieve
462
+ # the next page.
463
+ #
464
+ # If this field is not present, there are no subsequent results.
465
+ # @!attribute [r] unreachable
466
+ # @return [::Array<::String>]
467
+ # Output only. Locations that could not be reached.
468
+ class ListEventsResponse
469
+ include ::Google::Protobuf::MessageExts
470
+ extend ::Google::Protobuf::MessageExts::ClassMethods
471
+ end
472
+
473
+ # Message for getting an event
474
+ # @!attribute [rw] name
475
+ # @return [::String]
476
+ # Required. Unique name of the event in this scope including project
477
+ # and location using the form
478
+ # `projects/{project_id}/locations/{location}/events/{event_id}`.
479
+ #
480
+ # `project_id` - Project ID of the project that contains the event. <br>
481
+ # `location` - The location to get the service health events from. <br>
482
+ # `event_id` - Event ID to retrieve.
483
+ class GetEventRequest
484
+ include ::Google::Protobuf::MessageExts
485
+ extend ::Google::Protobuf::MessageExts::ClassMethods
486
+ end
487
+
488
+ # @!attribute [rw] parent
489
+ # @return [::String]
490
+ # Required. Parent value using the form
491
+ # `organizations/{organization_id}/locations/{location}/organizationEvents`.
492
+ #
493
+ # `organization_id` - ID (number) of the project that contains the event. To
494
+ # get your `organization_id`, see
495
+ # [Getting your organization resource
496
+ # ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).<br>
497
+ # `location` - The location to get the service health events from. To
498
+ # retrieve service health events of category = INCIDENT, use `location` =
499
+ # `global`.
500
+ # @!attribute [rw] page_size
501
+ # @return [::Integer]
502
+ # Optional. The maximum number of events that should be returned. Acceptable
503
+ # values are `1` to `100`, inclusive. (The default value is `10`.) If more
504
+ # results are available, the service returns a `next_page_token` that you can
505
+ # use to get the next page of results in subsequent list requests. The
506
+ # service may return fewer events than the requested `page_size`.
507
+ # @!attribute [rw] page_token
508
+ # @return [::String]
509
+ # Optional. A token identifying a page of results the server should return.
510
+ #
511
+ # Provide Page token returned by a previous `ListOrganizationEvents` call to
512
+ # retrieve the next page of results.
513
+ #
514
+ # When paginating, all other parameters provided to
515
+ # `ListOrganizationEvents` must match the call that provided the page token.
516
+ # @!attribute [rw] filter
517
+ # @return [::String]
518
+ # Optional. A filter expression that filters resources listed in the
519
+ # response. The expression takes the following forms:
520
+ #
521
+ # * field=value for `category` and `state`
522
+ # * field &lt;, >, &lt;=, or >= value for `update_time`
523
+ #
524
+ # Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00`
525
+ #
526
+ # Multiple filter queries are space-separated. Example:
527
+ # `category=INCIDENT state=ACTIVE`.
528
+ #
529
+ # By default, each expression is an AND expression. However, you can include
530
+ # AND and OR expressions explicitly.
531
+ #
532
+ # Filter is supported for the following fields: `category`, `state`,
533
+ # `update_time`
534
+ # @!attribute [rw] view
535
+ # @return [::Google::Cloud::ServiceHealth::V1::OrganizationEventView]
536
+ # Optional. OrganizationEvent fields to include in response.
537
+ class ListOrganizationEventsRequest
538
+ include ::Google::Protobuf::MessageExts
539
+ extend ::Google::Protobuf::MessageExts::ClassMethods
540
+ end
541
+
542
+ # @!attribute [r] organization_events
543
+ # @return [::Array<::Google::Cloud::ServiceHealth::V1::OrganizationEvent>]
544
+ # Output only. List of organization events affecting an organization.
545
+ # @!attribute [r] next_page_token
546
+ # @return [::String]
547
+ # Output only. The continuation token, used to page through large result
548
+ # sets. Provide this value in a subsequent request as `page_token` to
549
+ # retrieve the next page.
550
+ #
551
+ # If this field is not present, there are no subsequent results.
552
+ # @!attribute [r] unreachable
553
+ # @return [::Array<::String>]
554
+ # Output only. Locations that could not be reached.
555
+ class ListOrganizationEventsResponse
556
+ include ::Google::Protobuf::MessageExts
557
+ extend ::Google::Protobuf::MessageExts::ClassMethods
558
+ end
559
+
560
+ # @!attribute [rw] name
561
+ # @return [::String]
562
+ # Required. Unique name of the event in this scope including organization and
563
+ # event ID using the form
564
+ # `organizations/{organization_id}/locations/locations/global/organizationEvents/{event_id}`.
565
+ #
566
+ # `organization_id` - ID (number) of the project that contains the event. To
567
+ # get your `organization_id`, see
568
+ # [Getting your organization resource
569
+ # ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).<br>
570
+ # `event_id` - Organization event ID to retrieve.
571
+ class GetOrganizationEventRequest
572
+ include ::Google::Protobuf::MessageExts
573
+ extend ::Google::Protobuf::MessageExts::ClassMethods
574
+ end
575
+
576
+ # Message for requesting list of OrganizationImpacts
577
+ # @!attribute [rw] parent
578
+ # @return [::String]
579
+ # Required. Parent value using the form
580
+ # `organizations/{organization_id}/locations/{location}/organizationImpacts`.
581
+ #
582
+ # `organization_id` - ID (number) of the project that contains the event. To
583
+ # get your `organization_id`, see
584
+ # [Getting your organization resource
585
+ # ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).
586
+ # @!attribute [rw] page_size
587
+ # @return [::Integer]
588
+ # Optional. The maximum number of events that should be returned. Acceptable
589
+ # values are `1` to `100`, inclusive. The default value is `10`.
590
+ #
591
+ # If more results are available, the service returns a
592
+ # `next_page_token` that can be used to get the next page of results in
593
+ # subsequent list requests. The service may return fewer
594
+ # [impacts](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact)
595
+ # than the requested `page_size`.
596
+ # @!attribute [rw] page_token
597
+ # @return [::String]
598
+ # Optional. A token identifying a page of results the server should return.
599
+ #
600
+ # Provide `page_token` returned by a previous `ListOrganizationImpacts` call
601
+ # to retrieve the next page of results.
602
+ #
603
+ # When paginating, all other parameters provided to `ListOrganizationImpacts`
604
+ # must match the call that provided the page token.
605
+ # @!attribute [rw] filter
606
+ # @return [::String]
607
+ # Optional. A filter expression that filters resources listed in the
608
+ # response. The expression is in the form of `field:value` for checking if a
609
+ # repeated field contains a value.
610
+ #
611
+ # Example:
612
+ # `events:organizations%2F{organization_id}%2Flocations%2Fglobal%2ForganizationEvents%2Fevent-id`
613
+ #
614
+ # To get your `{organization_id}`, see
615
+ # [Getting your organization resource
616
+ # ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).
617
+ #
618
+ # Multiple filter queries are separated by spaces.
619
+ #
620
+ # By default, each expression is an AND expression. However, you can include
621
+ # AND and OR expressions explicitly.
622
+ # Filter is supported for the following fields: `events`.
623
+ class ListOrganizationImpactsRequest
624
+ include ::Google::Protobuf::MessageExts
625
+ extend ::Google::Protobuf::MessageExts::ClassMethods
626
+ end
627
+
628
+ # @!attribute [r] organization_impacts
629
+ # @return [::Array<::Google::Cloud::ServiceHealth::V1::OrganizationImpact>]
630
+ # Output only. List of
631
+ # [impacts](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact)
632
+ # for an organization affected by service health events.
633
+ # @!attribute [r] next_page_token
634
+ # @return [::String]
635
+ # Output only. The continuation token, used to page through large result
636
+ # sets. Provide this value in a subsequent request as `page_token` to
637
+ # retrieve the next page.
638
+ #
639
+ # If this field is not present, there are no subsequent results.
640
+ # @!attribute [r] unreachable
641
+ # @return [::Array<::String>]
642
+ # Output only. Locations that could not be reached.
643
+ class ListOrganizationImpactsResponse
644
+ include ::Google::Protobuf::MessageExts
645
+ extend ::Google::Protobuf::MessageExts::ClassMethods
646
+ end
647
+
648
+ # @!attribute [rw] name
649
+ # @return [::String]
650
+ # Required. Name of the resource using the form
651
+ # `organizations/{organization_id}/locations/global/organizationImpacts/{organization_impact_id}`.
652
+ #
653
+ # `organization_id` - ID (number) of the organization that contains the
654
+ # event. To get your `organization_id`, see
655
+ # [Getting your organization resource
656
+ # ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).<br>
657
+ # `organization_impact_id` - ID of the [OrganizationImpact
658
+ # resource](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact).
659
+ class GetOrganizationImpactRequest
660
+ include ::Google::Protobuf::MessageExts
661
+ extend ::Google::Protobuf::MessageExts::ClassMethods
662
+ end
663
+
664
+ # The event fields to include in ListEvents API response. This enum lists all
665
+ # possible event views.
666
+ module EventView
667
+ # Unspecified event view. Default to `EVENT_VIEW_BASIC`.
668
+ EVENT_VIEW_UNSPECIFIED = 0
669
+
670
+ # Includes all fields except `updates`. This view is the default for
671
+ # ListEvents API.
672
+ EVENT_VIEW_BASIC = 1
673
+
674
+ # Includes all event fields.
675
+ EVENT_VIEW_FULL = 2
676
+ end
677
+
678
+ # The organization event fields to include in ListOrganizationEvents API
679
+ # response. This enum lists all possible organization event views.
680
+ module OrganizationEventView
681
+ # Unspecified event view. Default to `ORGANIZATION_EVENT_VIEW_BASIC`.
682
+ ORGANIZATION_EVENT_VIEW_UNSPECIFIED = 0
683
+
684
+ # Includes all organization event fields except `updates`. This view is the
685
+ # default for ListOrganizationEvents API.
686
+ ORGANIZATION_EVENT_VIEW_BASIC = 1
687
+
688
+ # Includes all organization event fields.
689
+ ORGANIZATION_EVENT_VIEW_FULL = 2
690
+ end
691
+ end
692
+ end
693
+ end
694
+ end