google-cloud-gdc_hardware_management-v1alpha 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 (43) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +144 -0
  6. data/lib/google/cloud/gdc_hardware_management/v1alpha/bindings_override.rb +102 -0
  7. data/lib/google/cloud/gdc_hardware_management/v1alpha/gdc_hardware_management/client.rb +3998 -0
  8. data/lib/google/cloud/gdc_hardware_management/v1alpha/gdc_hardware_management/credentials.rb +47 -0
  9. data/lib/google/cloud/gdc_hardware_management/v1alpha/gdc_hardware_management/operations.rb +809 -0
  10. data/lib/google/cloud/gdc_hardware_management/v1alpha/gdc_hardware_management/paths.rb +208 -0
  11. data/lib/google/cloud/gdc_hardware_management/v1alpha/gdc_hardware_management/rest/client.rb +3741 -0
  12. data/lib/google/cloud/gdc_hardware_management/v1alpha/gdc_hardware_management/rest/operations.rb +902 -0
  13. data/lib/google/cloud/gdc_hardware_management/v1alpha/gdc_hardware_management/rest/service_stub.rb +2029 -0
  14. data/lib/google/cloud/gdc_hardware_management/v1alpha/gdc_hardware_management/rest.rb +54 -0
  15. data/lib/google/cloud/gdc_hardware_management/v1alpha/gdc_hardware_management.rb +56 -0
  16. data/lib/google/cloud/gdc_hardware_management/v1alpha/rest.rb +38 -0
  17. data/lib/google/cloud/gdc_hardware_management/v1alpha/version.rb +28 -0
  18. data/lib/google/cloud/gdc_hardware_management/v1alpha.rb +45 -0
  19. data/lib/google/cloud/gdchardwaremanagement/v1alpha/resources_pb.rb +89 -0
  20. data/lib/google/cloud/gdchardwaremanagement/v1alpha/service_pb.rb +98 -0
  21. data/lib/google/cloud/gdchardwaremanagement/v1alpha/service_services_pb.rb +109 -0
  22. data/lib/google-cloud-gdc_hardware_management-v1alpha.rb +21 -0
  23. data/proto_docs/README.md +4 -0
  24. data/proto_docs/google/api/client.rb +399 -0
  25. data/proto_docs/google/api/field_behavior.rb +85 -0
  26. data/proto_docs/google/api/field_info.rb +65 -0
  27. data/proto_docs/google/api/launch_stage.rb +71 -0
  28. data/proto_docs/google/api/resource.rb +222 -0
  29. data/proto_docs/google/cloud/gdchardwaremanagement/v1alpha/resources.rb +917 -0
  30. data/proto_docs/google/cloud/gdchardwaremanagement/v1alpha/service.rb +803 -0
  31. data/proto_docs/google/longrunning/operations.rb +164 -0
  32. data/proto_docs/google/protobuf/any.rb +145 -0
  33. data/proto_docs/google/protobuf/duration.rb +98 -0
  34. data/proto_docs/google/protobuf/empty.rb +34 -0
  35. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  36. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  37. data/proto_docs/google/rpc/status.rb +48 -0
  38. data/proto_docs/google/type/date.rb +53 -0
  39. data/proto_docs/google/type/datetime.rb +99 -0
  40. data/proto_docs/google/type/dayofweek.rb +49 -0
  41. data/proto_docs/google/type/postal_address.rb +135 -0
  42. data/proto_docs/google/type/timeofday.rb +45 -0
  43. metadata +141 -0
@@ -0,0 +1,803 @@
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 GDCHardwareManagement
23
+ module V1alpha
24
+ # A request to list orders.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The project and location to list orders in.
28
+ # Format: `projects/{project}/locations/{location}`
29
+ # @!attribute [rw] page_size
30
+ # @return [::Integer]
31
+ # Optional. Requested page size. Server may return fewer items than
32
+ # requested. If unspecified, server will pick an appropriate default.
33
+ # @!attribute [rw] page_token
34
+ # @return [::String]
35
+ # Optional. A token identifying a page of results the server should return.
36
+ # @!attribute [rw] filter
37
+ # @return [::String]
38
+ # Optional. Filtering condition. See [AIP-160](https://google.aip.dev/160).
39
+ # @!attribute [rw] order_by
40
+ # @return [::String]
41
+ # Optional. Hint for how to order the results.
42
+ class ListOrdersRequest
43
+ include ::Google::Protobuf::MessageExts
44
+ extend ::Google::Protobuf::MessageExts::ClassMethods
45
+ end
46
+
47
+ # A list of orders.
48
+ # @!attribute [rw] orders
49
+ # @return [::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::Order>]
50
+ # The list of orders.
51
+ # @!attribute [rw] next_page_token
52
+ # @return [::String]
53
+ # A token identifying a page of results the server should return.
54
+ # @!attribute [rw] unreachable
55
+ # @return [::Array<::String>]
56
+ # Locations that could not be reached.
57
+ class ListOrdersResponse
58
+ include ::Google::Protobuf::MessageExts
59
+ extend ::Google::Protobuf::MessageExts::ClassMethods
60
+ end
61
+
62
+ # A request to get an order.
63
+ # @!attribute [rw] name
64
+ # @return [::String]
65
+ # Required. Name of the resource
66
+ class GetOrderRequest
67
+ include ::Google::Protobuf::MessageExts
68
+ extend ::Google::Protobuf::MessageExts::ClassMethods
69
+ end
70
+
71
+ # A request to create an order.
72
+ # @!attribute [rw] parent
73
+ # @return [::String]
74
+ # Required. The project and location to create the order in.
75
+ # Format: `projects/{project}/locations/{location}`
76
+ # @!attribute [rw] order_id
77
+ # @return [::String]
78
+ # Optional. ID used to uniquely identify the Order within its parent scope.
79
+ # This field should contain at most 63 characters and must start with
80
+ # lowercase characters.
81
+ # Only lowercase characters, numbers and `-` are accepted.
82
+ # The `-` character cannot be the first or the last one.
83
+ # A system generated ID will be used if the field is not set.
84
+ #
85
+ # The order.name field in the request will be ignored.
86
+ # @!attribute [rw] order
87
+ # @return [::Google::Cloud::GDCHardwareManagement::V1alpha::Order]
88
+ # Required. The order to create.
89
+ # @!attribute [rw] request_id
90
+ # @return [::String]
91
+ # Optional. An optional unique identifier for this request. See
92
+ # [AIP-155](https://google.aip.dev/155).
93
+ class CreateOrderRequest
94
+ include ::Google::Protobuf::MessageExts
95
+ extend ::Google::Protobuf::MessageExts::ClassMethods
96
+ end
97
+
98
+ # A request to update an order.
99
+ # @!attribute [rw] update_mask
100
+ # @return [::Google::Protobuf::FieldMask]
101
+ # Required. A mask to specify the fields in the Order to overwrite with this
102
+ # update. The fields specified in the update_mask are relative to the order,
103
+ # not the full request. A field will be overwritten if it is in the mask. If
104
+ # you don't provide a mask then all fields will be overwritten.
105
+ # @!attribute [rw] order
106
+ # @return [::Google::Cloud::GDCHardwareManagement::V1alpha::Order]
107
+ # Required. The order to update.
108
+ # @!attribute [rw] request_id
109
+ # @return [::String]
110
+ # Optional. An optional unique identifier for this request. See
111
+ # [AIP-155](https://google.aip.dev/155).
112
+ class UpdateOrderRequest
113
+ include ::Google::Protobuf::MessageExts
114
+ extend ::Google::Protobuf::MessageExts::ClassMethods
115
+ end
116
+
117
+ # A request to delete an order.
118
+ # @!attribute [rw] name
119
+ # @return [::String]
120
+ # Required. The name of the order.
121
+ # Format: `projects/{project}/locations/{location}/orders/{order}`
122
+ # @!attribute [rw] request_id
123
+ # @return [::String]
124
+ # Optional. An optional unique identifier for this request. See
125
+ # [AIP-155](https://google.aip.dev/155).
126
+ # @!attribute [rw] force
127
+ # @return [::Boolean]
128
+ # Optional. An option to delete any nested resources in the Order, such as a
129
+ # HardwareGroup. If true, any nested resources for this Order will also be
130
+ # deleted. Otherwise, the request will only succeed if the Order has no
131
+ # nested resources.
132
+ class DeleteOrderRequest
133
+ include ::Google::Protobuf::MessageExts
134
+ extend ::Google::Protobuf::MessageExts::ClassMethods
135
+ end
136
+
137
+ # A request to submit an order.
138
+ # @!attribute [rw] name
139
+ # @return [::String]
140
+ # Required. The name of the order.
141
+ # Format: `projects/{project}/locations/{location}/orders/{order}`
142
+ # @!attribute [rw] request_id
143
+ # @return [::String]
144
+ # Optional. An optional unique identifier for this request. See
145
+ # [AIP-155](https://google.aip.dev/155).
146
+ class SubmitOrderRequest
147
+ include ::Google::Protobuf::MessageExts
148
+ extend ::Google::Protobuf::MessageExts::ClassMethods
149
+ end
150
+
151
+ # A request to list sites.
152
+ # @!attribute [rw] parent
153
+ # @return [::String]
154
+ # Required. The project and location to list sites in.
155
+ # Format: `projects/{project}/locations/{location}`
156
+ # @!attribute [rw] page_size
157
+ # @return [::Integer]
158
+ # Optional. Requested page size. Server may return fewer items than
159
+ # requested. If unspecified, server will pick an appropriate default.
160
+ # @!attribute [rw] page_token
161
+ # @return [::String]
162
+ # Optional. A token identifying a page of results the server should return.
163
+ # @!attribute [rw] filter
164
+ # @return [::String]
165
+ # Optional. Filtering condition. See [AIP-160](https://google.aip.dev/160).
166
+ # @!attribute [rw] order_by
167
+ # @return [::String]
168
+ # Optional. Hint for how to order the results.
169
+ class ListSitesRequest
170
+ include ::Google::Protobuf::MessageExts
171
+ extend ::Google::Protobuf::MessageExts::ClassMethods
172
+ end
173
+
174
+ # A list of sites.
175
+ # @!attribute [rw] sites
176
+ # @return [::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::Site>]
177
+ # The list of sites.
178
+ # @!attribute [rw] next_page_token
179
+ # @return [::String]
180
+ # A token identifying a page of results the server should return.
181
+ # @!attribute [rw] unreachable
182
+ # @return [::Array<::String>]
183
+ # Locations that could not be reached.
184
+ class ListSitesResponse
185
+ include ::Google::Protobuf::MessageExts
186
+ extend ::Google::Protobuf::MessageExts::ClassMethods
187
+ end
188
+
189
+ # A request to get a site.
190
+ # @!attribute [rw] name
191
+ # @return [::String]
192
+ # Required. The name of the site.
193
+ # Format: `projects/{project}/locations/{location}/sites/{site}`
194
+ class GetSiteRequest
195
+ include ::Google::Protobuf::MessageExts
196
+ extend ::Google::Protobuf::MessageExts::ClassMethods
197
+ end
198
+
199
+ # A request to create a site.
200
+ # @!attribute [rw] parent
201
+ # @return [::String]
202
+ # Required. The project and location to create the site in.
203
+ # Format: `projects/{project}/locations/{location}`
204
+ # @!attribute [rw] site_id
205
+ # @return [::String]
206
+ # Optional. ID used to uniquely identify the Site within its parent scope.
207
+ # This field should contain at most 63 characters and must start with
208
+ # lowercase characters.
209
+ # Only lowercase characters, numbers and `-` are accepted.
210
+ # The `-` character cannot be the first or the last one.
211
+ # A system generated ID will be used if the field is not set.
212
+ #
213
+ # The site.name field in the request will be ignored.
214
+ # @!attribute [rw] site
215
+ # @return [::Google::Cloud::GDCHardwareManagement::V1alpha::Site]
216
+ # Required. The site to create.
217
+ # @!attribute [rw] request_id
218
+ # @return [::String]
219
+ # Optional. An optional unique identifier for this request. See
220
+ # [AIP-155](https://google.aip.dev/155).
221
+ class CreateSiteRequest
222
+ include ::Google::Protobuf::MessageExts
223
+ extend ::Google::Protobuf::MessageExts::ClassMethods
224
+ end
225
+
226
+ # A request to update a site.
227
+ # @!attribute [rw] update_mask
228
+ # @return [::Google::Protobuf::FieldMask]
229
+ # Required. A mask to specify the fields in the Site to overwrite with this
230
+ # update. The fields specified in the update_mask are relative to the site,
231
+ # not the full request. A field will be overwritten if it is in the mask. If
232
+ # you don't provide a mask then all fields will be overwritten.
233
+ # @!attribute [rw] site
234
+ # @return [::Google::Cloud::GDCHardwareManagement::V1alpha::Site]
235
+ # Required. The site to update.
236
+ # @!attribute [rw] request_id
237
+ # @return [::String]
238
+ # Optional. An optional unique identifier for this request. See
239
+ # [AIP-155](https://google.aip.dev/155).
240
+ class UpdateSiteRequest
241
+ include ::Google::Protobuf::MessageExts
242
+ extend ::Google::Protobuf::MessageExts::ClassMethods
243
+ end
244
+
245
+ # A request to list hardware groups.
246
+ # @!attribute [rw] parent
247
+ # @return [::String]
248
+ # Required. The order to list hardware groups in.
249
+ # Format: `projects/{project}/locations/{location}/orders/{order}`
250
+ # @!attribute [rw] page_size
251
+ # @return [::Integer]
252
+ # Optional. Requested page size. Server may return fewer items than
253
+ # requested. If unspecified, server will pick an appropriate default.
254
+ # @!attribute [rw] page_token
255
+ # @return [::String]
256
+ # Optional. A token identifying a page of results the server should return.
257
+ # @!attribute [rw] filter
258
+ # @return [::String]
259
+ # Optional. Filtering condition. See [AIP-160](https://google.aip.dev/160).
260
+ # @!attribute [rw] order_by
261
+ # @return [::String]
262
+ # Optional. Hint for how to order the results.
263
+ class ListHardwareGroupsRequest
264
+ include ::Google::Protobuf::MessageExts
265
+ extend ::Google::Protobuf::MessageExts::ClassMethods
266
+ end
267
+
268
+ # A list of hardware groups.
269
+ # @!attribute [rw] hardware_groups
270
+ # @return [::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::HardwareGroup>]
271
+ # The list of hardware groups.
272
+ # @!attribute [rw] next_page_token
273
+ # @return [::String]
274
+ # A token identifying a page of results the server should return.
275
+ # @!attribute [rw] unreachable
276
+ # @return [::Array<::String>]
277
+ # Locations that could not be reached.
278
+ class ListHardwareGroupsResponse
279
+ include ::Google::Protobuf::MessageExts
280
+ extend ::Google::Protobuf::MessageExts::ClassMethods
281
+ end
282
+
283
+ # A request to get a hardware group.
284
+ # @!attribute [rw] name
285
+ # @return [::String]
286
+ # Required. The name of the hardware group.
287
+ # Format:
288
+ # `projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}`
289
+ class GetHardwareGroupRequest
290
+ include ::Google::Protobuf::MessageExts
291
+ extend ::Google::Protobuf::MessageExts::ClassMethods
292
+ end
293
+
294
+ # A request to create a hardware group.
295
+ # @!attribute [rw] parent
296
+ # @return [::String]
297
+ # Required. The order to create the hardware group in.
298
+ # Format: `projects/{project}/locations/{location}/orders/{order}`
299
+ # @!attribute [rw] hardware_group_id
300
+ # @return [::String]
301
+ # Optional. ID used to uniquely identify the HardwareGroup within its parent
302
+ # scope. This field should contain at most 63 characters and must start with
303
+ # lowercase characters.
304
+ # Only lowercase characters, numbers and `-` are accepted.
305
+ # The `-` character cannot be the first or the last one.
306
+ # A system generated ID will be used if the field is not set.
307
+ #
308
+ # The hardware_group.name field in the request will be ignored.
309
+ # @!attribute [rw] hardware_group
310
+ # @return [::Google::Cloud::GDCHardwareManagement::V1alpha::HardwareGroup]
311
+ # Required. The hardware group to create.
312
+ # @!attribute [rw] request_id
313
+ # @return [::String]
314
+ # Optional. An optional unique identifier for this request. See
315
+ # [AIP-155](https://google.aip.dev/155).
316
+ class CreateHardwareGroupRequest
317
+ include ::Google::Protobuf::MessageExts
318
+ extend ::Google::Protobuf::MessageExts::ClassMethods
319
+ end
320
+
321
+ # A request to update a hardware group.
322
+ # @!attribute [rw] update_mask
323
+ # @return [::Google::Protobuf::FieldMask]
324
+ # Required. A mask to specify the fields in the HardwareGroup to overwrite
325
+ # with this update. The fields specified in the update_mask are relative to
326
+ # the hardware group, not the full request. A field will be overwritten if it
327
+ # is in the mask. If you don't provide a mask then all fields will be
328
+ # overwritten.
329
+ # @!attribute [rw] hardware_group
330
+ # @return [::Google::Cloud::GDCHardwareManagement::V1alpha::HardwareGroup]
331
+ # Required. The hardware group to update.
332
+ # @!attribute [rw] request_id
333
+ # @return [::String]
334
+ # Optional. An optional unique identifier for this request. See
335
+ # [AIP-155](https://google.aip.dev/155).
336
+ class UpdateHardwareGroupRequest
337
+ include ::Google::Protobuf::MessageExts
338
+ extend ::Google::Protobuf::MessageExts::ClassMethods
339
+ end
340
+
341
+ # A request to delete a hardware group.
342
+ # @!attribute [rw] name
343
+ # @return [::String]
344
+ # Required. The name of the hardware group.
345
+ # Format:
346
+ # `projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardware_group}`
347
+ # @!attribute [rw] request_id
348
+ # @return [::String]
349
+ # Optional. An optional unique identifier for this request. See
350
+ # [AIP-155](https://google.aip.dev/155).
351
+ class DeleteHardwareGroupRequest
352
+ include ::Google::Protobuf::MessageExts
353
+ extend ::Google::Protobuf::MessageExts::ClassMethods
354
+ end
355
+
356
+ # A request to list hardware.
357
+ # @!attribute [rw] parent
358
+ # @return [::String]
359
+ # Required. The project and location to list hardware in.
360
+ # Format: `projects/{project}/locations/{location}`
361
+ # @!attribute [rw] page_size
362
+ # @return [::Integer]
363
+ # Optional. Requested page size. Server may return fewer items than
364
+ # requested. If unspecified, server will pick an appropriate default.
365
+ # @!attribute [rw] page_token
366
+ # @return [::String]
367
+ # Optional. A token identifying a page of results the server should return.
368
+ # @!attribute [rw] filter
369
+ # @return [::String]
370
+ # Optional. Filtering condition. See [AIP-160](https://google.aip.dev/160).
371
+ # @!attribute [rw] order_by
372
+ # @return [::String]
373
+ # Optional. Hint for how to order the results.
374
+ class ListHardwareRequest
375
+ include ::Google::Protobuf::MessageExts
376
+ extend ::Google::Protobuf::MessageExts::ClassMethods
377
+ end
378
+
379
+ # A list of hardware.
380
+ # @!attribute [rw] hardware
381
+ # @return [::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::Hardware>]
382
+ # The list of hardware.
383
+ # @!attribute [rw] next_page_token
384
+ # @return [::String]
385
+ # A token identifying a page of results the server should return.
386
+ # @!attribute [rw] unreachable
387
+ # @return [::Array<::String>]
388
+ # Locations that could not be reached.
389
+ class ListHardwareResponse
390
+ include ::Google::Protobuf::MessageExts
391
+ extend ::Google::Protobuf::MessageExts::ClassMethods
392
+ end
393
+
394
+ # A request to get hardware.
395
+ # @!attribute [rw] name
396
+ # @return [::String]
397
+ # Required. The name of the hardware.
398
+ # Format: `projects/{project}/locations/{location}/hardware/{hardware}`
399
+ class GetHardwareRequest
400
+ include ::Google::Protobuf::MessageExts
401
+ extend ::Google::Protobuf::MessageExts::ClassMethods
402
+ end
403
+
404
+ # A request to create hardware.
405
+ # @!attribute [rw] parent
406
+ # @return [::String]
407
+ # Required. The project and location to create hardware in.
408
+ # Format: `projects/{project}/locations/{location}`
409
+ # @!attribute [rw] hardware_id
410
+ # @return [::String]
411
+ # Optional. ID used to uniquely identify the Hardware within its parent
412
+ # scope. This field should contain at most 63 characters and must start with
413
+ # lowercase characters.
414
+ # Only lowercase characters, numbers and `-` are accepted.
415
+ # The `-` character cannot be the first or the last one.
416
+ # A system generated ID will be used if the field is not set.
417
+ #
418
+ # The hardware.name field in the request will be ignored.
419
+ # @!attribute [rw] hardware
420
+ # @return [::Google::Cloud::GDCHardwareManagement::V1alpha::Hardware]
421
+ # Required. The resource to create.
422
+ class CreateHardwareRequest
423
+ include ::Google::Protobuf::MessageExts
424
+ extend ::Google::Protobuf::MessageExts::ClassMethods
425
+ end
426
+
427
+ # A request to update hardware.
428
+ # @!attribute [rw] update_mask
429
+ # @return [::Google::Protobuf::FieldMask]
430
+ # Required. A mask to specify the fields in the Hardware to overwrite with
431
+ # this update. The fields specified in the update_mask are relative to the
432
+ # hardware, not the full request. A field will be overwritten if it is in the
433
+ # mask. If you don't provide a mask then all fields will be overwritten.
434
+ # @!attribute [rw] hardware
435
+ # @return [::Google::Cloud::GDCHardwareManagement::V1alpha::Hardware]
436
+ # Required. The hardware to update.
437
+ # @!attribute [rw] request_id
438
+ # @return [::String]
439
+ # Optional. An optional unique identifier for this request. See
440
+ # [AIP-155](https://google.aip.dev/155).
441
+ class UpdateHardwareRequest
442
+ include ::Google::Protobuf::MessageExts
443
+ extend ::Google::Protobuf::MessageExts::ClassMethods
444
+ end
445
+
446
+ # A request to delete hardware.
447
+ # @!attribute [rw] name
448
+ # @return [::String]
449
+ # Required. The name of the hardware.
450
+ # Format: `projects/{project}/locations/{location}/hardware/{hardware}`
451
+ # @!attribute [rw] request_id
452
+ # @return [::String]
453
+ # Optional. An optional unique identifier for this request. See
454
+ # [AIP-155](https://google.aip.dev/155).
455
+ class DeleteHardwareRequest
456
+ include ::Google::Protobuf::MessageExts
457
+ extend ::Google::Protobuf::MessageExts::ClassMethods
458
+ end
459
+
460
+ # A request to list comments.
461
+ # @!attribute [rw] parent
462
+ # @return [::String]
463
+ # Required. The order to list comments on.
464
+ # Format: `projects/{project}/locations/{location}/orders/{order}`
465
+ # @!attribute [rw] page_size
466
+ # @return [::Integer]
467
+ # Optional. Requested page size. Server may return fewer items than
468
+ # requested. If unspecified, server will pick an appropriate default.
469
+ # @!attribute [rw] page_token
470
+ # @return [::String]
471
+ # Optional. A token identifying a page of results the server should return.
472
+ # @!attribute [rw] filter
473
+ # @return [::String]
474
+ # Optional. Filtering condition. See [AIP-160](https://google.aip.dev/160).
475
+ # @!attribute [rw] order_by
476
+ # @return [::String]
477
+ # Optional. Hint for how to order the results.
478
+ class ListCommentsRequest
479
+ include ::Google::Protobuf::MessageExts
480
+ extend ::Google::Protobuf::MessageExts::ClassMethods
481
+ end
482
+
483
+ # A request to list comments.
484
+ # @!attribute [rw] comments
485
+ # @return [::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::Comment>]
486
+ # The list of comments.
487
+ # @!attribute [rw] next_page_token
488
+ # @return [::String]
489
+ # A token identifying a page of results the server should return.
490
+ # @!attribute [rw] unreachable
491
+ # @return [::Array<::String>]
492
+ # Locations that could not be reached.
493
+ class ListCommentsResponse
494
+ include ::Google::Protobuf::MessageExts
495
+ extend ::Google::Protobuf::MessageExts::ClassMethods
496
+ end
497
+
498
+ # A request to get a comment.
499
+ # @!attribute [rw] name
500
+ # @return [::String]
501
+ # Required. The name of the comment.
502
+ # Format:
503
+ # `projects/{project}/locations/{location}/orders/{order}/comments/{comment}`
504
+ class GetCommentRequest
505
+ include ::Google::Protobuf::MessageExts
506
+ extend ::Google::Protobuf::MessageExts::ClassMethods
507
+ end
508
+
509
+ # A request to create a comment.
510
+ # @!attribute [rw] parent
511
+ # @return [::String]
512
+ # Required. The order to create the comment on.
513
+ # Format: `projects/{project}/locations/{location}/orders/{order}`
514
+ # @!attribute [rw] comment_id
515
+ # @return [::String]
516
+ # Optional. ID used to uniquely identify the Comment within its parent scope.
517
+ # This field should contain at most 63 characters and must start with
518
+ # lowercase characters.
519
+ # Only lowercase characters, numbers and `-` are accepted.
520
+ # The `-` character cannot be the first or the last one.
521
+ # A system generated ID will be used if the field is not set.
522
+ #
523
+ # The comment.name field in the request will be ignored.
524
+ # @!attribute [rw] comment
525
+ # @return [::Google::Cloud::GDCHardwareManagement::V1alpha::Comment]
526
+ # Required. The comment to create.
527
+ # @!attribute [rw] request_id
528
+ # @return [::String]
529
+ # Optional. An optional unique identifier for this request. See
530
+ # [AIP-155](https://google.aip.dev/155).
531
+ class CreateCommentRequest
532
+ include ::Google::Protobuf::MessageExts
533
+ extend ::Google::Protobuf::MessageExts::ClassMethods
534
+ end
535
+
536
+ # A request to list change log entries.
537
+ # @!attribute [rw] parent
538
+ # @return [::String]
539
+ # Required. The order to list change log entries for.
540
+ # Format: `projects/{project}/locations/{location}/orders/{order}`
541
+ # @!attribute [rw] page_size
542
+ # @return [::Integer]
543
+ # Optional. Requested page size. Server may return fewer items than
544
+ # requested. If unspecified, server will pick an appropriate default.
545
+ # @!attribute [rw] page_token
546
+ # @return [::String]
547
+ # Optional. A token identifying a page of results the server should return.
548
+ # @!attribute [rw] filter
549
+ # @return [::String]
550
+ # Optional. Filtering condition. See [AIP-160](https://google.aip.dev/160).
551
+ # @!attribute [rw] order_by
552
+ # @return [::String]
553
+ # Optional. Hint for how to order the results.
554
+ class ListChangeLogEntriesRequest
555
+ include ::Google::Protobuf::MessageExts
556
+ extend ::Google::Protobuf::MessageExts::ClassMethods
557
+ end
558
+
559
+ # A list of change log entries.
560
+ # @!attribute [rw] change_log_entries
561
+ # @return [::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::ChangeLogEntry>]
562
+ # The list of change log entries.
563
+ # @!attribute [rw] next_page_token
564
+ # @return [::String]
565
+ # A token identifying a page of results the server should return.
566
+ # @!attribute [rw] unreachable
567
+ # @return [::Array<::String>]
568
+ # Locations that could not be reached.
569
+ class ListChangeLogEntriesResponse
570
+ include ::Google::Protobuf::MessageExts
571
+ extend ::Google::Protobuf::MessageExts::ClassMethods
572
+ end
573
+
574
+ # A request to get a change log entry.
575
+ # @!attribute [rw] name
576
+ # @return [::String]
577
+ # Required. The name of the change log entry.
578
+ # Format:
579
+ # `projects/{project}/locations/{location}/orders/{order}/changeLogEntries/{change_log_entry}`
580
+ class GetChangeLogEntryRequest
581
+ include ::Google::Protobuf::MessageExts
582
+ extend ::Google::Protobuf::MessageExts::ClassMethods
583
+ end
584
+
585
+ # A request to list SKUs.
586
+ # @!attribute [rw] parent
587
+ # @return [::String]
588
+ # Required. The project and location to list SKUs in.
589
+ # Format: `projects/{project}/locations/{location}`
590
+ # @!attribute [rw] page_size
591
+ # @return [::Integer]
592
+ # Optional. Requested page size. Server may return fewer items than
593
+ # requested. If unspecified, server will pick an appropriate default.
594
+ # @!attribute [rw] page_token
595
+ # @return [::String]
596
+ # Optional. A token identifying a page of results the server should return.
597
+ # @!attribute [rw] filter
598
+ # @return [::String]
599
+ # Optional. Filtering condition. See [AIP-160](https://google.aip.dev/160).
600
+ # @!attribute [rw] order_by
601
+ # @return [::String]
602
+ # Optional. Hint for how to order the results.
603
+ class ListSkusRequest
604
+ include ::Google::Protobuf::MessageExts
605
+ extend ::Google::Protobuf::MessageExts::ClassMethods
606
+ end
607
+
608
+ # A list of SKUs.
609
+ # @!attribute [rw] skus
610
+ # @return [::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::Sku>]
611
+ # The list of SKUs.
612
+ # @!attribute [rw] next_page_token
613
+ # @return [::String]
614
+ # A token identifying a page of results the server should return.
615
+ # @!attribute [rw] unreachable
616
+ # @return [::Array<::String>]
617
+ # Locations that could not be reached.
618
+ class ListSkusResponse
619
+ include ::Google::Protobuf::MessageExts
620
+ extend ::Google::Protobuf::MessageExts::ClassMethods
621
+ end
622
+
623
+ # A request to get an SKU.
624
+ # @!attribute [rw] name
625
+ # @return [::String]
626
+ # Required. The name of the SKU.
627
+ # Format: `projects/{project}/locations/{location}/skus/{sku}`
628
+ class GetSkuRequest
629
+ include ::Google::Protobuf::MessageExts
630
+ extend ::Google::Protobuf::MessageExts::ClassMethods
631
+ end
632
+
633
+ # A request to list zones.
634
+ # @!attribute [rw] parent
635
+ # @return [::String]
636
+ # Required. The project and location to list zones in.
637
+ # Format: `projects/{project}/locations/{location}`
638
+ # @!attribute [rw] page_size
639
+ # @return [::Integer]
640
+ # Optional. Requested page size. Server may return fewer items than
641
+ # requested. If unspecified, server will pick an appropriate default.
642
+ # @!attribute [rw] page_token
643
+ # @return [::String]
644
+ # Optional. A token identifying a page of results the server should return.
645
+ # @!attribute [rw] filter
646
+ # @return [::String]
647
+ # Optional. Filtering condition. See [AIP-160](https://google.aip.dev/160).
648
+ # @!attribute [rw] order_by
649
+ # @return [::String]
650
+ # Optional. Hint for how to order the results.
651
+ class ListZonesRequest
652
+ include ::Google::Protobuf::MessageExts
653
+ extend ::Google::Protobuf::MessageExts::ClassMethods
654
+ end
655
+
656
+ # A list of zones.
657
+ # @!attribute [rw] zones
658
+ # @return [::Array<::Google::Cloud::GDCHardwareManagement::V1alpha::Zone>]
659
+ # The list of zones.
660
+ # @!attribute [rw] next_page_token
661
+ # @return [::String]
662
+ # A token identifying a page of results the server should return.
663
+ # @!attribute [rw] unreachable
664
+ # @return [::Array<::String>]
665
+ # Locations that could not be reached.
666
+ class ListZonesResponse
667
+ include ::Google::Protobuf::MessageExts
668
+ extend ::Google::Protobuf::MessageExts::ClassMethods
669
+ end
670
+
671
+ # A request to get a zone.
672
+ # @!attribute [rw] name
673
+ # @return [::String]
674
+ # Required. The name of the zone.
675
+ # Format: `projects/{project}/locations/{location}/zones/{zone}`
676
+ class GetZoneRequest
677
+ include ::Google::Protobuf::MessageExts
678
+ extend ::Google::Protobuf::MessageExts::ClassMethods
679
+ end
680
+
681
+ # A request to create a zone.
682
+ # @!attribute [rw] parent
683
+ # @return [::String]
684
+ # Required. The project and location to create the zone in.
685
+ # Format: `projects/{project}/locations/{location}`
686
+ # @!attribute [rw] zone_id
687
+ # @return [::String]
688
+ # Optional. ID used to uniquely identify the Zone within its parent scope.
689
+ # This field should contain at most 63 characters and must start with
690
+ # lowercase characters.
691
+ # Only lowercase characters, numbers and `-` are accepted.
692
+ # The `-` character cannot be the first or the last one.
693
+ # A system generated ID will be used if the field is not set.
694
+ #
695
+ # The zone.name field in the request will be ignored.
696
+ # @!attribute [rw] zone
697
+ # @return [::Google::Cloud::GDCHardwareManagement::V1alpha::Zone]
698
+ # Required. The zone to create.
699
+ # @!attribute [rw] request_id
700
+ # @return [::String]
701
+ # Optional. An optional unique identifier for this request. See
702
+ # [AIP-155](https://google.aip.dev/155).
703
+ class CreateZoneRequest
704
+ include ::Google::Protobuf::MessageExts
705
+ extend ::Google::Protobuf::MessageExts::ClassMethods
706
+ end
707
+
708
+ # A request to update a zone.
709
+ # @!attribute [rw] update_mask
710
+ # @return [::Google::Protobuf::FieldMask]
711
+ # Required. A mask to specify the fields in the Zone to overwrite with this
712
+ # update. The fields specified in the update_mask are relative to the zone,
713
+ # not the full request. A field will be overwritten if it is in the mask. If
714
+ # you don't provide a mask then all fields will be overwritten.
715
+ # @!attribute [rw] zone
716
+ # @return [::Google::Cloud::GDCHardwareManagement::V1alpha::Zone]
717
+ # Required. The zone to update.
718
+ # @!attribute [rw] request_id
719
+ # @return [::String]
720
+ # Optional. An optional unique identifier for this request. See
721
+ # [AIP-155](https://google.aip.dev/155).
722
+ class UpdateZoneRequest
723
+ include ::Google::Protobuf::MessageExts
724
+ extend ::Google::Protobuf::MessageExts::ClassMethods
725
+ end
726
+
727
+ # A request to delete a zone.
728
+ # @!attribute [rw] name
729
+ # @return [::String]
730
+ # Required. The name of the zone.
731
+ # Format: `projects/{project}/locations/{location}/zones/{zone}`
732
+ # @!attribute [rw] request_id
733
+ # @return [::String]
734
+ # Optional. An optional unique identifier for this request. See
735
+ # [AIP-155](https://google.aip.dev/155).
736
+ class DeleteZoneRequest
737
+ include ::Google::Protobuf::MessageExts
738
+ extend ::Google::Protobuf::MessageExts::ClassMethods
739
+ end
740
+
741
+ # A request to signal the state of a zone.
742
+ # @!attribute [rw] name
743
+ # @return [::String]
744
+ # Required. The name of the zone.
745
+ # Format: `projects/{project}/locations/{location}/zones/{zone}`
746
+ # @!attribute [rw] request_id
747
+ # @return [::String]
748
+ # Optional. An optional unique identifier for this request. See
749
+ # [AIP-155](https://google.aip.dev/155).
750
+ # @!attribute [rw] state_signal
751
+ # @return [::Google::Cloud::GDCHardwareManagement::V1alpha::SignalZoneStateRequest::StateSignal]
752
+ # Required. The state signal to send for this zone.
753
+ class SignalZoneStateRequest
754
+ include ::Google::Protobuf::MessageExts
755
+ extend ::Google::Protobuf::MessageExts::ClassMethods
756
+
757
+ # Valid state signals for a zone.
758
+ module StateSignal
759
+ # State signal of the zone is unspecified.
760
+ STATE_SIGNAL_UNSPECIFIED = 0
761
+
762
+ # The Zone is ready for site turnup.
763
+ READY_FOR_SITE_TURNUP = 1
764
+
765
+ # The Zone failed in factory turnup checks.
766
+ FACTORY_TURNUP_CHECKS_FAILED = 2
767
+ end
768
+ end
769
+
770
+ # Represents the metadata of a long-running operation.
771
+ # @!attribute [r] create_time
772
+ # @return [::Google::Protobuf::Timestamp]
773
+ # Output only. The time the operation was created.
774
+ # @!attribute [r] end_time
775
+ # @return [::Google::Protobuf::Timestamp]
776
+ # Output only. The time the operation finished running.
777
+ # @!attribute [r] target
778
+ # @return [::String]
779
+ # Output only. Server-defined resource path for the target of the operation.
780
+ # @!attribute [r] verb
781
+ # @return [::String]
782
+ # Output only. The verb executed by the operation.
783
+ # @!attribute [r] status_message
784
+ # @return [::String]
785
+ # Output only. Human-readable status of the operation, if any.
786
+ # @!attribute [r] requested_cancellation
787
+ # @return [::Boolean]
788
+ # Output only. Identifies whether the user has requested cancellation
789
+ # of the operation. Operations that have been cancelled successfully
790
+ # have [Operation.error][] value with a
791
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
792
+ # `Code.CANCELLED`.
793
+ # @!attribute [r] api_version
794
+ # @return [::String]
795
+ # Output only. API version used to start the operation.
796
+ class OperationMetadata
797
+ include ::Google::Protobuf::MessageExts
798
+ extend ::Google::Protobuf::MessageExts::ClassMethods
799
+ end
800
+ end
801
+ end
802
+ end
803
+ end