google-cloud-observability-v1 0.a → 0.1.0

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 (34) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +153 -8
  5. data/lib/google/cloud/observability/v1/bindings_override.rb +107 -0
  6. data/lib/google/cloud/observability/v1/observability/client.rb +2738 -0
  7. data/lib/google/cloud/observability/v1/observability/credentials.rb +47 -0
  8. data/lib/google/cloud/observability/v1/observability/operations.rb +843 -0
  9. data/lib/google/cloud/observability/v1/observability/paths.rb +226 -0
  10. data/lib/google/cloud/observability/v1/observability/rest/client.rb +2549 -0
  11. data/lib/google/cloud/observability/v1/observability/rest/operations.rb +985 -0
  12. data/lib/google/cloud/observability/v1/observability/rest/service_stub.rb +1461 -0
  13. data/lib/google/cloud/observability/v1/observability/rest.rb +54 -0
  14. data/lib/google/cloud/observability/v1/observability.rb +56 -0
  15. data/lib/google/cloud/observability/v1/observability_pb.rb +65 -0
  16. data/lib/google/cloud/observability/v1/observability_services_pb.rb +87 -0
  17. data/lib/google/cloud/observability/v1/rest.rb +38 -0
  18. data/lib/google/cloud/observability/v1/version.rb +7 -2
  19. data/lib/google/cloud/observability/v1.rb +45 -0
  20. data/lib/google-cloud-observability-v1.rb +21 -0
  21. data/proto_docs/README.md +4 -0
  22. data/proto_docs/google/api/client.rb +593 -0
  23. data/proto_docs/google/api/field_behavior.rb +85 -0
  24. data/proto_docs/google/api/launch_stage.rb +71 -0
  25. data/proto_docs/google/api/resource.rb +227 -0
  26. data/proto_docs/google/cloud/observability/v1/observability.rb +709 -0
  27. data/proto_docs/google/longrunning/operations.rb +191 -0
  28. data/proto_docs/google/protobuf/any.rb +145 -0
  29. data/proto_docs/google/protobuf/duration.rb +98 -0
  30. data/proto_docs/google/protobuf/empty.rb +34 -0
  31. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  32. data/proto_docs/google/protobuf/timestamp.rb +128 -0
  33. data/proto_docs/google/rpc/status.rb +48 -0
  34. metadata +82 -9
@@ -0,0 +1,709 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 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 Observability
23
+ module V1
24
+ # Settings for configuring CMEK for a bucket.
25
+ # @!attribute [rw] kms_key
26
+ # @return [::String]
27
+ # Optional. The resource name for the configured Cloud KMS key. The format
28
+ # is:
29
+ #
30
+ # projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]
31
+ #
32
+ # For example:
33
+ #
34
+ # projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key
35
+ # @!attribute [r] kms_key_version
36
+ # @return [::String]
37
+ # Output only. The CryptoKeyVersion resource name for the configured Cloud
38
+ # KMS key. The format is:
39
+ #
40
+ # projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]
41
+ #
42
+ # For example:
43
+ #
44
+ # projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1
45
+ #
46
+ # This read-only field is used to convey the specific configured
47
+ # CryptoKeyVersion of the `kms_key` that has been configured. It is
48
+ # populated when the CMEK settings are bound to a single key version.
49
+ # @!attribute [r] service_account_id
50
+ # @return [::String]
51
+ # Output only. The service account used to access the key.
52
+ class CmekSettings
53
+ include ::Google::Protobuf::MessageExts
54
+ extend ::Google::Protobuf::MessageExts::ClassMethods
55
+ end
56
+
57
+ # Describes the settings associated with a project, organization, or folder.
58
+ # @!attribute [rw] name
59
+ # @return [::String]
60
+ # Identifier. The resource name of the settings.
61
+ # @!attribute [rw] default_storage_location
62
+ # @return [::String]
63
+ # Optional. The location which should be used when any regional resources are
64
+ # provisioned by Google Cloud.
65
+ # @!attribute [r] service_account_id
66
+ # @return [::String]
67
+ # Output only. The service account for the given resource container, such as
68
+ # project or folder. This will be used by Cloud Observability to perform
69
+ # actions in the container's project like access KMS keys or create Links.
70
+ # Always the same service account per resource container regardless of
71
+ # region.
72
+ # @!attribute [rw] kms_key_name
73
+ # @return [::String]
74
+ # Optional. The resource name for the configured Cloud KMS key.
75
+ #
76
+ # KMS key name format:
77
+ #
78
+ # "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"
79
+ #
80
+ # For example:
81
+ #
82
+ # `"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"`
83
+ class Settings
84
+ include ::Google::Protobuf::MessageExts
85
+ extend ::Google::Protobuf::MessageExts::ClassMethods
86
+ end
87
+
88
+ # Bucket configuration for storing observability data.
89
+ # @!attribute [rw] name
90
+ # @return [::String]
91
+ # Identifier. Name of the bucket. The format is:
92
+ #
93
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
94
+ # @!attribute [rw] display_name
95
+ # @return [::String]
96
+ # Optional. User friendly display name.
97
+ # @!attribute [rw] description
98
+ # @return [::String]
99
+ # Optional. Description of the bucket.
100
+ # @!attribute [r] create_time
101
+ # @return [::Google::Protobuf::Timestamp]
102
+ # Output only. Create timestamp.
103
+ # @!attribute [r] update_time
104
+ # @return [::Google::Protobuf::Timestamp]
105
+ # Output only. Update timestamp.
106
+ # @!attribute [r] delete_time
107
+ # @return [::Google::Protobuf::Timestamp]
108
+ # Output only. Delete timestamp.
109
+ # @!attribute [r] purge_time
110
+ # @return [::Google::Protobuf::Timestamp]
111
+ # Output only. Timestamp when the bucket in soft-deleted state is purged.
112
+ # @!attribute [rw] cmek_settings
113
+ # @return [::Google::Cloud::Observability::V1::CmekSettings]
114
+ # Optional. Settings for configuring CMEK on a bucket.
115
+ class Bucket
116
+ include ::Google::Protobuf::MessageExts
117
+ extend ::Google::Protobuf::MessageExts::ClassMethods
118
+ end
119
+
120
+ # Request for creating a bucket.
121
+ # @!attribute [rw] parent
122
+ # @return [::String]
123
+ # Required. Name of the project and location for the bucket. The format is:
124
+ #
125
+ # projects/[PROJECT_ID]/locations/[LOCATION]
126
+ # @!attribute [rw] bucket_id
127
+ # @return [::String]
128
+ # Required. Id of the bucket to create.
129
+ # @!attribute [rw] bucket
130
+ # @return [::Google::Cloud::Observability::V1::Bucket]
131
+ # Required. Bucket to create.
132
+ class CreateBucketRequest
133
+ include ::Google::Protobuf::MessageExts
134
+ extend ::Google::Protobuf::MessageExts::ClassMethods
135
+ end
136
+
137
+ # Request for updating a bucket.
138
+ # @!attribute [rw] bucket
139
+ # @return [::Google::Cloud::Observability::V1::Bucket]
140
+ # Required. The bucket to update.
141
+ #
142
+ # The name field of bucket identifies the resource to update.
143
+ # @!attribute [rw] update_mask
144
+ # @return [::Google::Protobuf::FieldMask]
145
+ # Optional. The list of fields to update.
146
+ class UpdateBucketRequest
147
+ include ::Google::Protobuf::MessageExts
148
+ extend ::Google::Protobuf::MessageExts::ClassMethods
149
+ end
150
+
151
+ # Request for getting a bucket.
152
+ # @!attribute [rw] name
153
+ # @return [::String]
154
+ # Required. Name of the bucket to retrieve. The format is:
155
+ #
156
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
157
+ class GetBucketRequest
158
+ include ::Google::Protobuf::MessageExts
159
+ extend ::Google::Protobuf::MessageExts::ClassMethods
160
+ end
161
+
162
+ # Request for listing buckets.
163
+ # @!attribute [rw] parent
164
+ # @return [::String]
165
+ # Required. The parent, which owns this collection of buckets. The format is:
166
+ #
167
+ # projects/[PROJECT_ID]/locations/[LOCATION]
168
+ # @!attribute [rw] page_size
169
+ # @return [::Integer]
170
+ # Optional. The maximum number of buckets to return. If unspecified, then at
171
+ # most 100 buckets are returned. The maximum value is 1000; values above 1000
172
+ # are coerced to 1000.
173
+ # @!attribute [rw] page_token
174
+ # @return [::String]
175
+ # Optional. A page token, received from a previous `ListBuckets` call.
176
+ # Provide this to retrieve the subsequent page.
177
+ # @!attribute [rw] show_deleted
178
+ # @return [::Boolean]
179
+ # Optional. If true, then the response will include deleted buckets.
180
+ class ListBucketsRequest
181
+ include ::Google::Protobuf::MessageExts
182
+ extend ::Google::Protobuf::MessageExts::ClassMethods
183
+ end
184
+
185
+ # Response for listing buckets.
186
+ # @!attribute [rw] buckets
187
+ # @return [::Array<::Google::Cloud::Observability::V1::Bucket>]
188
+ # Optional. The list of buckets.
189
+ # @!attribute [rw] next_page_token
190
+ # @return [::String]
191
+ # Optional. A token that can be sent as `page_token` to retrieve the next
192
+ # page. When this field is omitted, there are no subsequent pages.
193
+ class ListBucketsResponse
194
+ include ::Google::Protobuf::MessageExts
195
+ extend ::Google::Protobuf::MessageExts::ClassMethods
196
+ end
197
+
198
+ # A dataset is a collection of data that has a specific configuration. A
199
+ # dataset can be backed by multiple tables. One bucket can have multiple
200
+ # datasets.
201
+ # @!attribute [rw] name
202
+ # @return [::String]
203
+ # Identifier. Name of the dataset. The format is:
204
+ #
205
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
206
+ # @!attribute [rw] display_name
207
+ # @return [::String]
208
+ # Optional. User friendly display name.
209
+ # @!attribute [rw] description
210
+ # @return [::String]
211
+ # Optional. Description of the dataset.
212
+ # @!attribute [r] create_time
213
+ # @return [::Google::Protobuf::Timestamp]
214
+ # Output only. Create timestamp.
215
+ # @!attribute [r] delete_time
216
+ # @return [::Google::Protobuf::Timestamp]
217
+ # Output only. Delete timestamp.
218
+ # @!attribute [r] purge_time
219
+ # @return [::Google::Protobuf::Timestamp]
220
+ # Output only. Timestamp when the dataset in soft-deleted state is purged.
221
+ class Dataset
222
+ include ::Google::Protobuf::MessageExts
223
+ extend ::Google::Protobuf::MessageExts::ClassMethods
224
+ end
225
+
226
+ # Request for getting a dataset.
227
+ # @!attribute [rw] name
228
+ # @return [::String]
229
+ # Required. Name of the dataset to retrieve. The format is:
230
+ #
231
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
232
+ class GetDatasetRequest
233
+ include ::Google::Protobuf::MessageExts
234
+ extend ::Google::Protobuf::MessageExts::ClassMethods
235
+ end
236
+
237
+ # Request for listing datasets.
238
+ # @!attribute [rw] parent
239
+ # @return [::String]
240
+ # Required. The parent bucket that owns this collection of datasets. The
241
+ # format is:
242
+ #
243
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
244
+ # @!attribute [rw] page_size
245
+ # @return [::Integer]
246
+ # Optional. The maximum number of datasets to return. If unspecified, then at
247
+ # most 100 datasets are returned. The maximum value is 1000; values above
248
+ # 1000 are coerced to 1000.
249
+ # @!attribute [rw] page_token
250
+ # @return [::String]
251
+ # Optional. A page token, received from a previous `ListDatasets` call.
252
+ # Provide this to retrieve the subsequent page.
253
+ # @!attribute [rw] show_deleted
254
+ # @return [::Boolean]
255
+ # Optional. If true, then the response will include deleted datasets.
256
+ class ListDatasetsRequest
257
+ include ::Google::Protobuf::MessageExts
258
+ extend ::Google::Protobuf::MessageExts::ClassMethods
259
+ end
260
+
261
+ # Response for listing datasets.
262
+ # @!attribute [rw] datasets
263
+ # @return [::Array<::Google::Cloud::Observability::V1::Dataset>]
264
+ # The list of datasets.
265
+ # @!attribute [rw] next_page_token
266
+ # @return [::String]
267
+ # A token that can be sent as `page_token` to retrieve the next page. When
268
+ # this field is omitted, there are no subsequent pages.
269
+ class ListDatasetsResponse
270
+ include ::Google::Protobuf::MessageExts
271
+ extend ::Google::Protobuf::MessageExts::ClassMethods
272
+ end
273
+
274
+ # A view corresponds to a read-only representation of a subset of the data in
275
+ # a dataset.
276
+ # @!attribute [rw] name
277
+ # @return [::String]
278
+ # Identifier. Name of the view. The format is:
279
+ #
280
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]
281
+ # @!attribute [rw] display_name
282
+ # @return [::String]
283
+ # Optional. User friendly display name.
284
+ # @!attribute [rw] description
285
+ # @return [::String]
286
+ # Optional. Description of the view.
287
+ # @!attribute [r] create_time
288
+ # @return [::Google::Protobuf::Timestamp]
289
+ # Output only. Create timestamp.
290
+ # @!attribute [r] update_time
291
+ # @return [::Google::Protobuf::Timestamp]
292
+ # Output only. Update timestamp.
293
+ class View
294
+ include ::Google::Protobuf::MessageExts
295
+ extend ::Google::Protobuf::MessageExts::ClassMethods
296
+ end
297
+
298
+ # Request for getting a view.
299
+ # @!attribute [rw] name
300
+ # @return [::String]
301
+ # Required. Name of the view to retrieve. The format is:
302
+ #
303
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]
304
+ class GetViewRequest
305
+ include ::Google::Protobuf::MessageExts
306
+ extend ::Google::Protobuf::MessageExts::ClassMethods
307
+ end
308
+
309
+ # Request for listing views.
310
+ # @!attribute [rw] parent
311
+ # @return [::String]
312
+ # Required. Dataset whose views are to be listed. The format is:
313
+ #
314
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
315
+ # @!attribute [rw] page_size
316
+ # @return [::Integer]
317
+ # Optional. The maximum number of views to return. If unspecified, then at
318
+ # most 100 views are returned. The maximum value is 1000; values above 1000
319
+ # are coerced to 1000.
320
+ # @!attribute [rw] page_token
321
+ # @return [::String]
322
+ # Optional. A page token, received from a previous `ListViews` call. Provide
323
+ # this to retrieve the subsequent page.
324
+ class ListViewsRequest
325
+ include ::Google::Protobuf::MessageExts
326
+ extend ::Google::Protobuf::MessageExts::ClassMethods
327
+ end
328
+
329
+ # Response for listing views.
330
+ # @!attribute [rw] views
331
+ # @return [::Array<::Google::Cloud::Observability::V1::View>]
332
+ # The list of views.
333
+ # @!attribute [rw] next_page_token
334
+ # @return [::String]
335
+ # Optional. A token that can be sent as `page_token` to retrieve the next
336
+ # page. When this field is omitted, there are no subsequent pages.
337
+ class ListViewsResponse
338
+ include ::Google::Protobuf::MessageExts
339
+ extend ::Google::Protobuf::MessageExts::ClassMethods
340
+ end
341
+
342
+ # A link lets a dataset be accessible to BigQuery via usage of linked datasets.
343
+ # @!attribute [rw] name
344
+ # @return [::String]
345
+ # Identifier. Name of the link. The format is:
346
+ #
347
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
348
+ # @!attribute [rw] display_name
349
+ # @return [::String]
350
+ # Optional. A user friendly display name.
351
+ # @!attribute [rw] description
352
+ # @return [::String]
353
+ # Optional. Description of the link.
354
+ # @!attribute [r] create_time
355
+ # @return [::Google::Protobuf::Timestamp]
356
+ # Output only. Create timestamp.
357
+ class Link
358
+ include ::Google::Protobuf::MessageExts
359
+ extend ::Google::Protobuf::MessageExts::ClassMethods
360
+ end
361
+
362
+ # Request for creating a link.
363
+ # @!attribute [rw] parent
364
+ # @return [::String]
365
+ # Required. Name of the containing dataset for this link. The format is:
366
+ #
367
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
368
+ # @!attribute [rw] link_id
369
+ # @return [::String]
370
+ # Required. Id of the link to create.
371
+ # @!attribute [rw] link
372
+ # @return [::Google::Cloud::Observability::V1::Link]
373
+ # Required. Link to create.
374
+ class CreateLinkRequest
375
+ include ::Google::Protobuf::MessageExts
376
+ extend ::Google::Protobuf::MessageExts::ClassMethods
377
+ end
378
+
379
+ # Request for updating a link.
380
+ # @!attribute [rw] link
381
+ # @return [::Google::Cloud::Observability::V1::Link]
382
+ # Required. Link to update.
383
+ #
384
+ # The name field of link identifies the resource to update.
385
+ # @!attribute [rw] update_mask
386
+ # @return [::Google::Protobuf::FieldMask]
387
+ # Optional. The list of fields to update.
388
+ class UpdateLinkRequest
389
+ include ::Google::Protobuf::MessageExts
390
+ extend ::Google::Protobuf::MessageExts::ClassMethods
391
+ end
392
+
393
+ # Request for getting a link.
394
+ # @!attribute [rw] name
395
+ # @return [::String]
396
+ # Required. Name of the link to retrieve. The format is:
397
+ #
398
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
399
+ class GetLinkRequest
400
+ include ::Google::Protobuf::MessageExts
401
+ extend ::Google::Protobuf::MessageExts::ClassMethods
402
+ end
403
+
404
+ # Request for listing links.
405
+ # @!attribute [rw] parent
406
+ # @return [::String]
407
+ # Required. The parent dataset that owns this collection of links. The format
408
+ # is:
409
+ #
410
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
411
+ # @!attribute [rw] page_size
412
+ # @return [::Integer]
413
+ # Optional. The maximum number of links to return. If unspecified, then at
414
+ # most 100 links are returned. The maximum value is 1000; values above 1000
415
+ # are coerced to 1000.
416
+ # @!attribute [rw] page_token
417
+ # @return [::String]
418
+ # Optional. A page token, received from a previous `ListLinks` call. Provide
419
+ # this to retrieve the subsequent page.
420
+ class ListLinksRequest
421
+ include ::Google::Protobuf::MessageExts
422
+ extend ::Google::Protobuf::MessageExts::ClassMethods
423
+ end
424
+
425
+ # Response for listing links.
426
+ # @!attribute [rw] links
427
+ # @return [::Array<::Google::Cloud::Observability::V1::Link>]
428
+ # The list of links.
429
+ # @!attribute [rw] next_page_token
430
+ # @return [::String]
431
+ # Optional. A token that can be sent as `page_token` to retrieve the next
432
+ # page. When this field is omitted, there are no subsequent pages.
433
+ class ListLinksResponse
434
+ include ::Google::Protobuf::MessageExts
435
+ extend ::Google::Protobuf::MessageExts::ClassMethods
436
+ end
437
+
438
+ # Request for deleting a link.
439
+ # @!attribute [rw] name
440
+ # @return [::String]
441
+ # Required. Name of the link to delete. The format is:
442
+ #
443
+ # projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
444
+ class DeleteLinkRequest
445
+ include ::Google::Protobuf::MessageExts
446
+ extend ::Google::Protobuf::MessageExts::ClassMethods
447
+ end
448
+
449
+ # Message describing Scope object
450
+ # @!attribute [rw] name
451
+ # @return [::String]
452
+ # Identifier. Name of the resource. The format is:
453
+ #
454
+ # projects/\\{project}/locations/\\{location}/scopes/\\{scope}
455
+ #
456
+ # The `{location}` field must be set to `global`. The `{scope}` field must
457
+ # be set to `_Default`.
458
+ # @!attribute [r] update_time
459
+ # @return [::Google::Protobuf::Timestamp]
460
+ # Output only. Update timestamp.
461
+ # Note: The Update timestamp for the default scope is initially unset.
462
+ # @!attribute [rw] log_scope
463
+ # @return [::String]
464
+ # Required. The full resource name of the `logging.googleapis.com/LogScope`.
465
+ # For example:
466
+ #
467
+ # //logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope
468
+ # @!attribute [rw] trace_scope
469
+ # @return [::String]
470
+ # Required. The unqualified resource name of the
471
+ # `cloudtrace.googleapis.com/TraceScope`. For example:
472
+ #
473
+ # projects/myproject/locations/global/traceScopes/my-trace-scope
474
+ class Scope
475
+ include ::Google::Protobuf::MessageExts
476
+ extend ::Google::Protobuf::MessageExts::ClassMethods
477
+ end
478
+
479
+ # Message for getting a Scope.
480
+ # @!attribute [rw] name
481
+ # @return [::String]
482
+ # Required. Name of the resource. The format is:
483
+ #
484
+ # projects/\\{project}/locations/\\{location}/scopes/\\{scope}
485
+ #
486
+ # The `{location}` field must be set to `global`. The `{scope}` field must
487
+ # be set to `_Default`.
488
+ class GetScopeRequest
489
+ include ::Google::Protobuf::MessageExts
490
+ extend ::Google::Protobuf::MessageExts::ClassMethods
491
+ end
492
+
493
+ # Message for updating a Scope.
494
+ # @!attribute [rw] update_mask
495
+ # @return [::Google::Protobuf::FieldMask]
496
+ # Optional. Field mask is used to specify the fields to be overwritten in the
497
+ # Scope resource by the update.
498
+ # The fields specified in the update_mask are relative to the resource, not
499
+ # the full request. A field is overwritten when it is in the mask. If the
500
+ # user does not provide a mask, then all fields present in the request are
501
+ # overwritten.
502
+ # @!attribute [rw] scope
503
+ # @return [::Google::Cloud::Observability::V1::Scope]
504
+ # Required. The resource being updated.
505
+ class UpdateScopeRequest
506
+ include ::Google::Protobuf::MessageExts
507
+ extend ::Google::Protobuf::MessageExts::ClassMethods
508
+ end
509
+
510
+ # Represents the metadata of the long-running operation.
511
+ # @!attribute [r] create_time
512
+ # @return [::Google::Protobuf::Timestamp]
513
+ # Output only. The time the operation was created.
514
+ # @!attribute [r] end_time
515
+ # @return [::Google::Protobuf::Timestamp]
516
+ # Output only. The time the operation finished running.
517
+ # @!attribute [r] target
518
+ # @return [::String]
519
+ # Output only. Server-defined resource path for the target of the operation.
520
+ # @!attribute [r] verb
521
+ # @return [::String]
522
+ # Output only. Name of the verb executed by the operation.
523
+ # @!attribute [r] status_message
524
+ # @return [::String]
525
+ # Output only. Human-readable status of the operation, if any.
526
+ # @!attribute [r] requested_cancellation
527
+ # @return [::Boolean]
528
+ # Output only. Identifies whether the user has requested cancellation
529
+ # of the operation. Operations that have been cancelled successfully
530
+ # have [Operation.error][] value with a
531
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
532
+ # `Code.CANCELLED`.
533
+ # @!attribute [r] api_version
534
+ # @return [::String]
535
+ # Output only. API version used to start the operation.
536
+ class OperationMetadata
537
+ include ::Google::Protobuf::MessageExts
538
+ extend ::Google::Protobuf::MessageExts::ClassMethods
539
+ end
540
+
541
+ # A trace scope is a collection of resources whose traces are queried together.
542
+ # @!attribute [rw] name
543
+ # @return [::String]
544
+ # Identifier. The resource name of the trace scope.
545
+ #
546
+ # For example:
547
+ #
548
+ # projects/my-project/locations/global/traceScopes/my-trace-scope
549
+ # @!attribute [rw] resource_names
550
+ # @return [::Array<::String>]
551
+ # Required. Names of the projects that are included in this trace scope.
552
+ #
553
+ # * `projects/[PROJECT_ID]`
554
+ #
555
+ # A trace scope can include a maximum of 20 projects.
556
+ # @!attribute [rw] description
557
+ # @return [::String]
558
+ # Optional. Describes this trace scope.
559
+ #
560
+ # The maximum length of the description is 8000 characters.
561
+ # @!attribute [r] create_time
562
+ # @return [::Google::Protobuf::Timestamp]
563
+ # Output only. The creation timestamp of the trace scope.
564
+ # @!attribute [r] update_time
565
+ # @return [::Google::Protobuf::Timestamp]
566
+ # Output only. The last update timestamp of the trace scope.
567
+ class TraceScope
568
+ include ::Google::Protobuf::MessageExts
569
+ extend ::Google::Protobuf::MessageExts::ClassMethods
570
+ end
571
+
572
+ # Request for creating a TraceScope.
573
+ # @!attribute [rw] parent
574
+ # @return [::String]
575
+ # Required. The full resource name of the location where the trace scope
576
+ # should be created
577
+ #
578
+ # projects/[PROJECT_ID]/locations/[LOCATION_ID]
579
+ #
580
+ # For example:
581
+ #
582
+ # projects/my-project/locations/global
583
+ # @!attribute [rw] trace_scope_id
584
+ # @return [::String]
585
+ # Required. A client-assigned identifier for the trace scope.
586
+ # @!attribute [rw] trace_scope
587
+ # @return [::Google::Cloud::Observability::V1::TraceScope]
588
+ # Required. The new trace scope.
589
+ class CreateTraceScopeRequest
590
+ include ::Google::Protobuf::MessageExts
591
+ extend ::Google::Protobuf::MessageExts::ClassMethods
592
+ end
593
+
594
+ # Request for getting a TraceScope.
595
+ # @!attribute [rw] name
596
+ # @return [::String]
597
+ # Required. The resource name of the trace scope:
598
+ #
599
+ # projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]
600
+ #
601
+ # For example:
602
+ #
603
+ # projects/my-project/locations/global/traceScopes/my-trace-scope
604
+ class GetTraceScopeRequest
605
+ include ::Google::Protobuf::MessageExts
606
+ extend ::Google::Protobuf::MessageExts::ClassMethods
607
+ end
608
+
609
+ # Request for listing TraceScopes.
610
+ # @!attribute [rw] parent
611
+ # @return [::String]
612
+ # Required. The full resource name of the location to look for trace scopes:
613
+ #
614
+ # projects/[PROJECT_ID]/locations/[LOCATION_ID]
615
+ #
616
+ # For example:
617
+ #
618
+ # projects/my-project/locations/global
619
+ # @!attribute [rw] page_size
620
+ # @return [::Integer]
621
+ # Optional. The maximum number of results to return from this request.
622
+ #
623
+ # Non-positive values are ignored. The presence of `next_page_token` in the
624
+ # response indicates that more results might be available.
625
+ # @!attribute [rw] page_token
626
+ # @return [::String]
627
+ # Optional. If present, then retrieve the next batch of results from the
628
+ # preceding call to this method. `page_token` must be the value of
629
+ # `next_page_token` from the previous response. The values of other method
630
+ # parameters should be identical to those in the previous call.
631
+ class ListTraceScopesRequest
632
+ include ::Google::Protobuf::MessageExts
633
+ extend ::Google::Protobuf::MessageExts::ClassMethods
634
+ end
635
+
636
+ # Response for listing TraceScopes.
637
+ # @!attribute [rw] trace_scopes
638
+ # @return [::Array<::Google::Cloud::Observability::V1::TraceScope>]
639
+ # Optional. A list of trace scopes.
640
+ # @!attribute [rw] next_page_token
641
+ # @return [::String]
642
+ # Optional. If there might be more results than appear in this response, then
643
+ # `next_page_token` is included. To get the next set of results, call the
644
+ # same method again using the value of `next_page_token` as `page_token`.
645
+ class ListTraceScopesResponse
646
+ include ::Google::Protobuf::MessageExts
647
+ extend ::Google::Protobuf::MessageExts::ClassMethods
648
+ end
649
+
650
+ # Request for updating a TraceScope.
651
+ # @!attribute [rw] trace_scope
652
+ # @return [::Google::Cloud::Observability::V1::TraceScope]
653
+ # Required. The updated trace scope.
654
+ # @!attribute [rw] update_mask
655
+ # @return [::Google::Protobuf::FieldMask]
656
+ # Optional. The list of fields to update.
657
+ class UpdateTraceScopeRequest
658
+ include ::Google::Protobuf::MessageExts
659
+ extend ::Google::Protobuf::MessageExts::ClassMethods
660
+ end
661
+
662
+ # Request for deleting a TraceScope.
663
+ # @!attribute [rw] name
664
+ # @return [::String]
665
+ # Required. The full resource name of the trace scope to delete:
666
+ #
667
+ # projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]
668
+ #
669
+ # For example:
670
+ #
671
+ # projects/my-project/locations/global/traceScopes/my-trace-scope
672
+ class DeleteTraceScopeRequest
673
+ include ::Google::Protobuf::MessageExts
674
+ extend ::Google::Protobuf::MessageExts::ClassMethods
675
+ end
676
+
677
+ # Request for getting Settings.
678
+ # @!attribute [rw] name
679
+ # @return [::String]
680
+ # Required. Name of the settings to retrieve.
681
+ #
682
+ # Name format:
683
+ #
684
+ # "projects/[PROJECT_ID]/locations/[LOCATION]/settings"
685
+ # "folders/[FOLDER_ID]/locations/[LOCATION]/settings"
686
+ # "organizations/[ORGANIZATION_ID]/locations/[LOCATION]/settings"
687
+ class GetSettingsRequest
688
+ include ::Google::Protobuf::MessageExts
689
+ extend ::Google::Protobuf::MessageExts::ClassMethods
690
+ end
691
+
692
+ # Request for updating Settings.
693
+ # @!attribute [rw] settings
694
+ # @return [::Google::Cloud::Observability::V1::Settings]
695
+ # Required. The settings to update.
696
+ #
697
+ # The name field of settings is used to identify the resource to be updated.
698
+ # @!attribute [rw] update_mask
699
+ # @return [::Google::Protobuf::FieldMask]
700
+ # Optional. The field mask specifying which fields of the settings are to be
701
+ # updated.
702
+ class UpdateSettingsRequest
703
+ include ::Google::Protobuf::MessageExts
704
+ extend ::Google::Protobuf::MessageExts::ClassMethods
705
+ end
706
+ end
707
+ end
708
+ end
709
+ end