google-cloud-alloy_db-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 (35) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +144 -0
  6. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_admin/client.rb +3986 -0
  7. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_admin/credentials.rb +47 -0
  8. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_admin/operations.rb +770 -0
  9. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_admin/paths.rb +170 -0
  10. data/lib/google/cloud/alloy_db/v1alpha/alloy_db_admin.rb +50 -0
  11. data/lib/google/cloud/alloy_db/v1alpha/version.rb +28 -0
  12. data/lib/google/cloud/alloy_db/v1alpha.rb +40 -0
  13. data/lib/google/cloud/alloydb/v1alpha/resources_pb.rb +100 -0
  14. data/lib/google/cloud/alloydb/v1alpha/service_pb.rb +102 -0
  15. data/lib/google/cloud/alloydb/v1alpha/service_services_pb.rb +128 -0
  16. data/lib/google-cloud-alloy_db-v1alpha.rb +21 -0
  17. data/proto_docs/README.md +4 -0
  18. data/proto_docs/google/api/client.rb +381 -0
  19. data/proto_docs/google/api/field_behavior.rb +71 -0
  20. data/proto_docs/google/api/launch_stage.rb +71 -0
  21. data/proto_docs/google/api/resource.rb +222 -0
  22. data/proto_docs/google/cloud/alloydb/v1alpha/resources.rb +1227 -0
  23. data/proto_docs/google/cloud/alloydb/v1alpha/service.rb +1206 -0
  24. data/proto_docs/google/longrunning/operations.rb +164 -0
  25. data/proto_docs/google/protobuf/any.rb +144 -0
  26. data/proto_docs/google/protobuf/duration.rb +98 -0
  27. data/proto_docs/google/protobuf/empty.rb +34 -0
  28. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  29. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  30. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  31. data/proto_docs/google/rpc/status.rb +48 -0
  32. data/proto_docs/google/type/dayofweek.rb +49 -0
  33. data/proto_docs/google/type/expr.rb +75 -0
  34. data/proto_docs/google/type/timeofday.rb +45 -0
  35. metadata +281 -0
@@ -0,0 +1,1206 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module AlloyDB
23
+ module V1alpha
24
+ # Message for requesting list of Clusters
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The name of the parent resource. For the required format, see the
28
+ # comment on the Cluster.name field. Additionally, you can perform an
29
+ # aggregated list operation by specifying a value with the following format:
30
+ # * projects/\\{project}/locations/-
31
+ # @!attribute [rw] page_size
32
+ # @return [::Integer]
33
+ # Optional. Requested page size. Server may return fewer items than
34
+ # requested. If unspecified, server will pick an appropriate default.
35
+ # @!attribute [rw] page_token
36
+ # @return [::String]
37
+ # A token identifying a page of results the server should return.
38
+ # @!attribute [rw] filter
39
+ # @return [::String]
40
+ # Optional. Filtering results
41
+ # @!attribute [rw] order_by
42
+ # @return [::String]
43
+ # Optional. Hint for how to order the results
44
+ class ListClustersRequest
45
+ include ::Google::Protobuf::MessageExts
46
+ extend ::Google::Protobuf::MessageExts::ClassMethods
47
+ end
48
+
49
+ # Message for response to listing Clusters
50
+ # @!attribute [rw] clusters
51
+ # @return [::Array<::Google::Cloud::AlloyDB::V1alpha::Cluster>]
52
+ # The list of Cluster
53
+ # @!attribute [rw] next_page_token
54
+ # @return [::String]
55
+ # A token identifying a page of results the server should return.
56
+ # @!attribute [rw] unreachable
57
+ # @return [::Array<::String>]
58
+ # Locations that could not be reached.
59
+ class ListClustersResponse
60
+ include ::Google::Protobuf::MessageExts
61
+ extend ::Google::Protobuf::MessageExts::ClassMethods
62
+ end
63
+
64
+ # Message for getting a Cluster
65
+ # @!attribute [rw] name
66
+ # @return [::String]
67
+ # Required. The name of the resource. For the required format, see the
68
+ # comment on the Cluster.name field.
69
+ # @!attribute [rw] view
70
+ # @return [::Google::Cloud::AlloyDB::V1alpha::ClusterView]
71
+ # Optional. The view of the cluster to return. Returns all default fields if
72
+ # not set.
73
+ class GetClusterRequest
74
+ include ::Google::Protobuf::MessageExts
75
+ extend ::Google::Protobuf::MessageExts::ClassMethods
76
+ end
77
+
78
+ # @!attribute [rw] parent
79
+ # @return [::String]
80
+ # Required. The location of the new cluster. For the required
81
+ # format, see the comment on the Cluster.name field.
82
+ # @!attribute [rw] cluster_id
83
+ # @return [::String]
84
+ # Required. ID of the requesting object (the secondary cluster).
85
+ # @!attribute [rw] cluster
86
+ # @return [::Google::Cloud::AlloyDB::V1alpha::Cluster]
87
+ # Required. Configuration of the requesting object (the secondary cluster).
88
+ # @!attribute [rw] request_id
89
+ # @return [::String]
90
+ # Optional. An optional request ID to identify requests. Specify a unique
91
+ # request ID so that if you must retry your request, the server will know to
92
+ # ignore the request if it has already been completed. The server will
93
+ # guarantee that for at least 60 minutes since the first request.
94
+ #
95
+ # For example, consider a situation where you make an initial request and
96
+ # the request times out. If you make the request again with the same request
97
+ # ID, the server can check if original operation with the same request ID
98
+ # was received, and if so, will ignore the second request. This prevents
99
+ # clients from accidentally creating duplicate commitments.
100
+ #
101
+ # The request ID must be a valid UUID with the exception that zero UUID is
102
+ # not supported (00000000-0000-0000-0000-000000000000).
103
+ # @!attribute [rw] validate_only
104
+ # @return [::Boolean]
105
+ # Optional. If set, performs request validation (e.g. permission checks and
106
+ # any other type of validation), but do not actually execute the create
107
+ # request.
108
+ class CreateSecondaryClusterRequest
109
+ include ::Google::Protobuf::MessageExts
110
+ extend ::Google::Protobuf::MessageExts::ClassMethods
111
+ end
112
+
113
+ # Message for creating a Cluster
114
+ # @!attribute [rw] parent
115
+ # @return [::String]
116
+ # Required. The location of the new cluster. For the required format, see the
117
+ # comment on the Cluster.name field.
118
+ # @!attribute [rw] cluster_id
119
+ # @return [::String]
120
+ # Required. ID of the requesting object.
121
+ # @!attribute [rw] cluster
122
+ # @return [::Google::Cloud::AlloyDB::V1alpha::Cluster]
123
+ # Required. The resource being created
124
+ # @!attribute [rw] request_id
125
+ # @return [::String]
126
+ # Optional. An optional request ID to identify requests. Specify a unique
127
+ # request ID so that if you must retry your request, the server will know to
128
+ # ignore the request if it has already been completed. The server will
129
+ # guarantee that for at least 60 minutes since the first request.
130
+ #
131
+ # For example, consider a situation where you make an initial request and
132
+ # the request times out. If you make the request again with the same request
133
+ # ID, the server can check if original operation with the same request ID
134
+ # was received, and if so, will ignore the second request. This prevents
135
+ # clients from accidentally creating duplicate commitments.
136
+ #
137
+ # The request ID must be a valid UUID with the exception that zero UUID is
138
+ # not supported (00000000-0000-0000-0000-000000000000).
139
+ # @!attribute [rw] validate_only
140
+ # @return [::Boolean]
141
+ # Optional. If set, performs request validation (e.g. permission checks and
142
+ # any other type of validation), but do not actually execute the create
143
+ # request.
144
+ class CreateClusterRequest
145
+ include ::Google::Protobuf::MessageExts
146
+ extend ::Google::Protobuf::MessageExts::ClassMethods
147
+ end
148
+
149
+ # Message for updating a Cluster
150
+ # @!attribute [rw] update_mask
151
+ # @return [::Google::Protobuf::FieldMask]
152
+ # Optional. Field mask is used to specify the fields to be overwritten in the
153
+ # Cluster resource by the update.
154
+ # The fields specified in the update_mask are relative to the resource, not
155
+ # the full request. A field will be overwritten if it is in the mask. If the
156
+ # user does not provide a mask then all fields will be overwritten.
157
+ # @!attribute [rw] cluster
158
+ # @return [::Google::Cloud::AlloyDB::V1alpha::Cluster]
159
+ # Required. The resource being updated
160
+ # @!attribute [rw] request_id
161
+ # @return [::String]
162
+ # Optional. An optional request ID to identify requests. Specify a unique
163
+ # request ID so that if you must retry your request, the server will know to
164
+ # ignore the request if it has already been completed. The server will
165
+ # guarantee that for at least 60 minutes since the first request.
166
+ #
167
+ # For example, consider a situation where you make an initial request and
168
+ # the request times out. If you make the request again with the same request
169
+ # ID, the server can check if original operation with the same request ID
170
+ # was received, and if so, will ignore the second request. This prevents
171
+ # clients from accidentally creating duplicate commitments.
172
+ #
173
+ # The request ID must be a valid UUID with the exception that zero UUID is
174
+ # not supported (00000000-0000-0000-0000-000000000000).
175
+ # @!attribute [rw] validate_only
176
+ # @return [::Boolean]
177
+ # Optional. If set, performs request validation (e.g. permission checks and
178
+ # any other type of validation), but do not actually execute the update
179
+ # request.
180
+ # @!attribute [rw] allow_missing
181
+ # @return [::Boolean]
182
+ # Optional. If set to true, update succeeds even if cluster is not found. In
183
+ # that case, a new cluster is created and `update_mask` is ignored.
184
+ class UpdateClusterRequest
185
+ include ::Google::Protobuf::MessageExts
186
+ extend ::Google::Protobuf::MessageExts::ClassMethods
187
+ end
188
+
189
+ # Message for deleting a Cluster
190
+ # @!attribute [rw] name
191
+ # @return [::String]
192
+ # Required. The name of the resource. For the required format, see the
193
+ # comment on the Cluster.name field.
194
+ # @!attribute [rw] request_id
195
+ # @return [::String]
196
+ # Optional. An optional request ID to identify requests. Specify a unique
197
+ # request ID so that if you must retry your request, the server will know to
198
+ # ignore the request if it has already been completed. The server will
199
+ # guarantee that for at least 60 minutes after the first request.
200
+ #
201
+ # For example, consider a situation where you make an initial request and
202
+ # the request times out. If you make the request again with the same request
203
+ # ID, the server can check if original operation with the same request ID
204
+ # was received, and if so, will ignore the second request. This prevents
205
+ # clients from accidentally creating duplicate commitments.
206
+ #
207
+ # The request ID must be a valid UUID with the exception that zero UUID is
208
+ # not supported (00000000-0000-0000-0000-000000000000).
209
+ # @!attribute [rw] etag
210
+ # @return [::String]
211
+ # Optional. The current etag of the Cluster.
212
+ # If an etag is provided and does not match the current etag of the Cluster,
213
+ # deletion will be blocked and an ABORTED error will be returned.
214
+ # @!attribute [rw] validate_only
215
+ # @return [::Boolean]
216
+ # Optional. If set, performs request validation (e.g. permission checks and
217
+ # any other type of validation), but do not actually execute the delete.
218
+ # @!attribute [rw] force
219
+ # @return [::Boolean]
220
+ # Optional. Whether to cascade delete child instances for given cluster.
221
+ class DeleteClusterRequest
222
+ include ::Google::Protobuf::MessageExts
223
+ extend ::Google::Protobuf::MessageExts::ClassMethods
224
+ end
225
+
226
+ # Message for promoting a Cluster
227
+ # @!attribute [rw] name
228
+ # @return [::String]
229
+ # Required. The name of the resource. For the required format, see the
230
+ # comment on the Cluster.name field
231
+ # @!attribute [rw] request_id
232
+ # @return [::String]
233
+ # Optional. An optional request ID to identify requests. Specify a unique
234
+ # request ID so that if you must retry your request, the server will know to
235
+ # ignore the request if it has already been completed. The server will
236
+ # guarantee that for at least 60 minutes after the first request.
237
+ #
238
+ # For example, consider a situation where you make an initial request and
239
+ # the request times out. If you make the request again with the same request
240
+ # ID, the server can check if original operation with the same request ID
241
+ # was received, and if so, will ignore the second request. This prevents
242
+ # clients from accidentally creating duplicate commitments.
243
+ #
244
+ # The request ID must be a valid UUID with the exception that zero UUID is
245
+ # not supported (00000000-0000-0000-0000-000000000000).
246
+ # @!attribute [rw] etag
247
+ # @return [::String]
248
+ # Optional. The current etag of the Cluster.
249
+ # If an etag is provided and does not match the current etag of the Cluster,
250
+ # deletion will be blocked and an ABORTED error will be returned.
251
+ # @!attribute [rw] validate_only
252
+ # @return [::Boolean]
253
+ # Optional. If set, performs request validation (e.g. permission checks and
254
+ # any other type of validation), but do not actually execute the delete.
255
+ class PromoteClusterRequest
256
+ include ::Google::Protobuf::MessageExts
257
+ extend ::Google::Protobuf::MessageExts::ClassMethods
258
+ end
259
+
260
+ # Message for restoring a Cluster from a backup or another cluster at a given
261
+ # point in time.
262
+ # @!attribute [rw] backup_source
263
+ # @return [::Google::Cloud::AlloyDB::V1alpha::BackupSource]
264
+ # Backup source.
265
+ # @!attribute [rw] continuous_backup_source
266
+ # @return [::Google::Cloud::AlloyDB::V1alpha::ContinuousBackupSource]
267
+ # ContinuousBackup source. Continuous backup needs to be enabled in the
268
+ # source cluster for this operation to succeed.
269
+ # @!attribute [rw] parent
270
+ # @return [::String]
271
+ # Required. The name of the parent resource. For the required format, see the
272
+ # comment on the Cluster.name field.
273
+ # @!attribute [rw] cluster_id
274
+ # @return [::String]
275
+ # Required. ID of the requesting object.
276
+ # @!attribute [rw] cluster
277
+ # @return [::Google::Cloud::AlloyDB::V1alpha::Cluster]
278
+ # Required. The resource being created
279
+ # @!attribute [rw] request_id
280
+ # @return [::String]
281
+ # Optional. An optional request ID to identify requests. Specify a unique
282
+ # request ID so that if you must retry your request, the server will know to
283
+ # ignore the request if it has already been completed. The server will
284
+ # guarantee that for at least 60 minutes since the first request.
285
+ #
286
+ # For example, consider a situation where you make an initial request and
287
+ # the request times out. If you make the request again with the same request
288
+ # ID, the server can check if original operation with the same request ID
289
+ # was received, and if so, will ignore the second request. This prevents
290
+ # clients from accidentally creating duplicate commitments.
291
+ #
292
+ # The request ID must be a valid UUID with the exception that zero UUID is
293
+ # not supported (00000000-0000-0000-0000-000000000000).
294
+ # @!attribute [rw] validate_only
295
+ # @return [::Boolean]
296
+ # Optional. If set, performs request validation (e.g. permission checks and
297
+ # any other type of validation), but do not actually execute the import
298
+ # request.
299
+ class RestoreClusterRequest
300
+ include ::Google::Protobuf::MessageExts
301
+ extend ::Google::Protobuf::MessageExts::ClassMethods
302
+ end
303
+
304
+ # Message for requesting list of Instances
305
+ # @!attribute [rw] parent
306
+ # @return [::String]
307
+ # Required. The name of the parent resource. For the required format, see the
308
+ # comment on the Instance.name field. Additionally, you can perform an
309
+ # aggregated list operation by specifying a value with one of the following
310
+ # formats:
311
+ # * projects/\\{project}/locations/-/clusters/-
312
+ # * projects/\\{project}/locations/\\{region}/clusters/-
313
+ # @!attribute [rw] page_size
314
+ # @return [::Integer]
315
+ # Optional. Requested page size. Server may return fewer items than
316
+ # requested. If unspecified, server will pick an appropriate default.
317
+ # @!attribute [rw] page_token
318
+ # @return [::String]
319
+ # A token identifying a page of results the server should return.
320
+ # @!attribute [rw] filter
321
+ # @return [::String]
322
+ # Optional. Filtering results
323
+ # @!attribute [rw] order_by
324
+ # @return [::String]
325
+ # Optional. Hint for how to order the results
326
+ class ListInstancesRequest
327
+ include ::Google::Protobuf::MessageExts
328
+ extend ::Google::Protobuf::MessageExts::ClassMethods
329
+ end
330
+
331
+ # Message for response to listing Instances
332
+ # @!attribute [rw] instances
333
+ # @return [::Array<::Google::Cloud::AlloyDB::V1alpha::Instance>]
334
+ # The list of Instance
335
+ # @!attribute [rw] next_page_token
336
+ # @return [::String]
337
+ # A token identifying a page of results the server should return.
338
+ # @!attribute [rw] unreachable
339
+ # @return [::Array<::String>]
340
+ # Locations that could not be reached.
341
+ class ListInstancesResponse
342
+ include ::Google::Protobuf::MessageExts
343
+ extend ::Google::Protobuf::MessageExts::ClassMethods
344
+ end
345
+
346
+ # Message for getting a Instance
347
+ # @!attribute [rw] name
348
+ # @return [::String]
349
+ # Required. The name of the resource. For the required format, see the
350
+ # comment on the Instance.name field.
351
+ # @!attribute [rw] view
352
+ # @return [::Google::Cloud::AlloyDB::V1alpha::InstanceView]
353
+ # The view of the instance to return.
354
+ class GetInstanceRequest
355
+ include ::Google::Protobuf::MessageExts
356
+ extend ::Google::Protobuf::MessageExts::ClassMethods
357
+ end
358
+
359
+ # Message for creating a Instance
360
+ # @!attribute [rw] parent
361
+ # @return [::String]
362
+ # Required. The name of the parent resource. For the required format, see the
363
+ # comment on the Instance.name field.
364
+ # @!attribute [rw] instance_id
365
+ # @return [::String]
366
+ # Required. ID of the requesting object.
367
+ # @!attribute [rw] instance
368
+ # @return [::Google::Cloud::AlloyDB::V1alpha::Instance]
369
+ # Required. The resource being created
370
+ # @!attribute [rw] request_id
371
+ # @return [::String]
372
+ # Optional. An optional request ID to identify requests. Specify a unique
373
+ # request ID so that if you must retry your request, the server will know to
374
+ # ignore the request if it has already been completed. The server will
375
+ # guarantee that for at least 60 minutes since the first request.
376
+ #
377
+ # For example, consider a situation where you make an initial request and
378
+ # the request times out. If you make the request again with the same request
379
+ # ID, the server can check if original operation with the same request ID
380
+ # was received, and if so, will ignore the second request. This prevents
381
+ # clients from accidentally creating duplicate commitments.
382
+ #
383
+ # The request ID must be a valid UUID with the exception that zero UUID is
384
+ # not supported (00000000-0000-0000-0000-000000000000).
385
+ # @!attribute [rw] validate_only
386
+ # @return [::Boolean]
387
+ # Optional. If set, performs request validation (e.g. permission checks and
388
+ # any other type of validation), but do not actually execute the create
389
+ # request.
390
+ class CreateInstanceRequest
391
+ include ::Google::Protobuf::MessageExts
392
+ extend ::Google::Protobuf::MessageExts::ClassMethods
393
+ end
394
+
395
+ # Message for creating a Secondary Instance
396
+ # @!attribute [rw] parent
397
+ # @return [::String]
398
+ # Required. The name of the parent resource. For the required format, see the
399
+ # comment on the Instance.name field.
400
+ # @!attribute [rw] instance_id
401
+ # @return [::String]
402
+ # Required. ID of the requesting object.
403
+ # @!attribute [rw] instance
404
+ # @return [::Google::Cloud::AlloyDB::V1alpha::Instance]
405
+ # Required. The resource being created
406
+ # @!attribute [rw] request_id
407
+ # @return [::String]
408
+ # Optional. An optional request ID to identify requests. Specify a unique
409
+ # request ID so that if you must retry your request, the server will know to
410
+ # ignore the request if it has already been completed. The server will
411
+ # guarantee that for at least 60 minutes since the first request.
412
+ #
413
+ # For example, consider a situation where you make an initial request and
414
+ # the request times out. If you make the request again with the same request
415
+ # ID, the server can check if original operation with the same request ID
416
+ # was received, and if so, will ignore the second request. This prevents
417
+ # clients from accidentally creating duplicate commitments.
418
+ #
419
+ # The request ID must be a valid UUID with the exception that zero UUID is
420
+ # not supported (00000000-0000-0000-0000-000000000000).
421
+ # @!attribute [rw] validate_only
422
+ # @return [::Boolean]
423
+ # Optional. If set, performs request validation (e.g. permission checks and
424
+ # any other type of validation), but do not actually execute the create
425
+ # request.
426
+ class CreateSecondaryInstanceRequest
427
+ include ::Google::Protobuf::MessageExts
428
+ extend ::Google::Protobuf::MessageExts::ClassMethods
429
+ end
430
+
431
+ # See usage below for notes.
432
+ # @!attribute [rw] create_instance_requests
433
+ # @return [::Array<::Google::Cloud::AlloyDB::V1alpha::CreateInstanceRequest>]
434
+ # Required. Primary and read replica instances to be created. This list
435
+ # should not be empty.
436
+ class CreateInstanceRequests
437
+ include ::Google::Protobuf::MessageExts
438
+ extend ::Google::Protobuf::MessageExts::ClassMethods
439
+ end
440
+
441
+ # Message for creating a batch of instances under the specified cluster.
442
+ # @!attribute [rw] parent
443
+ # @return [::String]
444
+ # Required. The name of the parent resource.
445
+ # @!attribute [rw] requests
446
+ # @return [::Google::Cloud::AlloyDB::V1alpha::CreateInstanceRequests]
447
+ # Required. Resources being created.
448
+ # @!attribute [rw] request_id
449
+ # @return [::String]
450
+ # Optional. An optional request ID to identify requests. Specify a unique
451
+ # request ID so that if you must retry your request, the server will know to
452
+ # ignore the request if it has already been completed. The server will
453
+ # guarantee that for at least 60 minutes since the first request.
454
+ #
455
+ # For example, consider a situation where you make an initial request and
456
+ # the request times out. If you make the request again with the same request
457
+ # ID, the server can check if original operation with the same request ID
458
+ # was received, and if so, will ignore the second request. This prevents
459
+ # clients from accidentally creating duplicate commitments.
460
+ #
461
+ # The request ID must be a valid UUID with the exception that zero UUID is
462
+ # not supported (00000000-0000-0000-0000-000000000000).
463
+ class BatchCreateInstancesRequest
464
+ include ::Google::Protobuf::MessageExts
465
+ extend ::Google::Protobuf::MessageExts::ClassMethods
466
+ end
467
+
468
+ # Message for creating batches of instances in a cluster.
469
+ # @!attribute [rw] instances
470
+ # @return [::Array<::Google::Cloud::AlloyDB::V1alpha::Instance>]
471
+ # Created instances.
472
+ class BatchCreateInstancesResponse
473
+ include ::Google::Protobuf::MessageExts
474
+ extend ::Google::Protobuf::MessageExts::ClassMethods
475
+ end
476
+
477
+ # Message for metadata that is specific to BatchCreateInstances API.
478
+ # NEXT_ID: 3
479
+ # @!attribute [rw] instance_targets
480
+ # @return [::Array<::String>]
481
+ # The instances being created in the API call. Each string in this list
482
+ # is the server defined resource path for target instances in the request
483
+ # and for the format of each string, see the comment on the Instance.name
484
+ # field.
485
+ # @!attribute [rw] instance_statuses
486
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AlloyDB::V1alpha::BatchCreateInstanceStatus}]
487
+ # A map representing state of the instances involved in the
488
+ # BatchCreateInstances operation during the operation execution.
489
+ # The instance state will be in STATE_UNSPECIFIED state if the instance has
490
+ # not yet been picked up for processing.
491
+ # The key of the map is the name of the instance resource.
492
+ # For the format, see the comment on the Instance.name field.
493
+ class BatchCreateInstancesMetadata
494
+ include ::Google::Protobuf::MessageExts
495
+ extend ::Google::Protobuf::MessageExts::ClassMethods
496
+
497
+ # @!attribute [rw] key
498
+ # @return [::String]
499
+ # @!attribute [rw] value
500
+ # @return [::Google::Cloud::AlloyDB::V1alpha::BatchCreateInstanceStatus]
501
+ class InstanceStatusesEntry
502
+ include ::Google::Protobuf::MessageExts
503
+ extend ::Google::Protobuf::MessageExts::ClassMethods
504
+ end
505
+ end
506
+
507
+ # Message for current status of an instance in the BatchCreateInstances
508
+ # operation.
509
+ # For example, lets say a BatchCreateInstances workflow has 4 instances,
510
+ # Instance1 through Instance4. Lets also assume that 2 instances succeeded
511
+ # but the third failed to create and the 4th was never picked up for creation
512
+ # because of failure of the previous one. Then, resulting states would look
513
+ # something like:
514
+ # 1. Instance1 = ROLLED_BACK
515
+ # 2. Instance2 = ROLLED_BACK
516
+ # 3. Instance3 = FAILED
517
+ # 4. Instance4 = FAILED
518
+ #
519
+ # However, while the operation is running, the instance might be in other
520
+ # states including PENDING_CREATE, ACTIVE, DELETING and CREATING. The states
521
+ # / do not get further updated once the operation is done.
522
+ # @!attribute [rw] state
523
+ # @return [::Google::Cloud::AlloyDB::V1alpha::BatchCreateInstanceStatus::State]
524
+ # The current state of an instance involved in the batch create operation.
525
+ # Once the operation is complete, the final state of the instances in the
526
+ # LRO can be one of:
527
+ # 1. ACTIVE, indicating that instances were created successfully
528
+ # 2. FAILED, indicating that a particular instance failed creation
529
+ # 3. ROLLED_BACK indicating that although the instance was created
530
+ # successfully, it had to be rolled back and deleted due to failure in
531
+ # other steps of the workflow.
532
+ # @!attribute [rw] error_msg
533
+ # @return [::String]
534
+ # DEPRECATED - Use the error field instead.
535
+ # Error, if any error occurred and is available, during instance creation.
536
+ # @!attribute [rw] error
537
+ # @return [::Google::Rpc::Status]
538
+ # The RPC status of the instance creation operation. This field will be
539
+ # present if an error happened during the instance creation.
540
+ # @!attribute [rw] type
541
+ # @return [::Google::Cloud::AlloyDB::V1alpha::Instance::InstanceType]
542
+ class BatchCreateInstanceStatus
543
+ include ::Google::Protobuf::MessageExts
544
+ extend ::Google::Protobuf::MessageExts::ClassMethods
545
+
546
+ # State contains all valid instance states for the BatchCreateInstances
547
+ # operation. This is mainly used for status reporting through the LRO
548
+ # metadata.
549
+ module State
550
+ # The state of the instance is unknown.
551
+ STATE_UNSPECIFIED = 0
552
+
553
+ # Instance is pending creation and has not yet been picked up for
554
+ # processsing in the backend.
555
+ PENDING_CREATE = 1
556
+
557
+ # The instance is active and running.
558
+ READY = 2
559
+
560
+ # The instance is being created.
561
+ CREATING = 3
562
+
563
+ # The instance is being deleted.
564
+ DELETING = 4
565
+
566
+ # The creation of the instance failed or a fatal error occurred during
567
+ # an operation on the instance or a batch of instances.
568
+ FAILED = 5
569
+
570
+ # The instance was created successfully, but was rolled back and deleted
571
+ # due to some other failure during BatchCreateInstances operation.
572
+ ROLLED_BACK = 6
573
+ end
574
+ end
575
+
576
+ # Message for updating a Instance
577
+ # @!attribute [rw] update_mask
578
+ # @return [::Google::Protobuf::FieldMask]
579
+ # Optional. Field mask is used to specify the fields to be overwritten in the
580
+ # Instance resource by the update.
581
+ # The fields specified in the update_mask are relative to the resource, not
582
+ # the full request. A field will be overwritten if it is in the mask. If the
583
+ # user does not provide a mask then all fields will be overwritten.
584
+ # @!attribute [rw] instance
585
+ # @return [::Google::Cloud::AlloyDB::V1alpha::Instance]
586
+ # Required. The resource being updated
587
+ # @!attribute [rw] request_id
588
+ # @return [::String]
589
+ # Optional. An optional request ID to identify requests. Specify a unique
590
+ # request ID so that if you must retry your request, the server will know to
591
+ # ignore the request if it has already been completed. The server will
592
+ # guarantee that for at least 60 minutes since the first request.
593
+ #
594
+ # For example, consider a situation where you make an initial request and
595
+ # the request times out. If you make the request again with the same request
596
+ # ID, the server can check if original operation with the same request ID
597
+ # was received, and if so, will ignore the second request. This prevents
598
+ # clients from accidentally creating duplicate commitments.
599
+ #
600
+ # The request ID must be a valid UUID with the exception that zero UUID is
601
+ # not supported (00000000-0000-0000-0000-000000000000).
602
+ # @!attribute [rw] validate_only
603
+ # @return [::Boolean]
604
+ # Optional. If set, performs request validation (e.g. permission checks and
605
+ # any other type of validation), but do not actually execute the update
606
+ # request.
607
+ # @!attribute [rw] allow_missing
608
+ # @return [::Boolean]
609
+ # Optional. If set to true, update succeeds even if instance is not found. In
610
+ # that case, a new instance is created and `update_mask` is ignored.
611
+ class UpdateInstanceRequest
612
+ include ::Google::Protobuf::MessageExts
613
+ extend ::Google::Protobuf::MessageExts::ClassMethods
614
+ end
615
+
616
+ # Message for deleting a Instance
617
+ # @!attribute [rw] name
618
+ # @return [::String]
619
+ # Required. The name of the resource. For the required format, see the
620
+ # comment on the Instance.name field.
621
+ # @!attribute [rw] request_id
622
+ # @return [::String]
623
+ # Optional. An optional request ID to identify requests. Specify a unique
624
+ # request ID so that if you must retry your request, the server will know to
625
+ # ignore the request if it has already been completed. The server will
626
+ # guarantee that for at least 60 minutes after the first request.
627
+ #
628
+ # For example, consider a situation where you make an initial request and
629
+ # the request times out. If you make the request again with the same request
630
+ # ID, the server can check if original operation with the same request ID
631
+ # was received, and if so, will ignore the second request. This prevents
632
+ # clients from accidentally creating duplicate commitments.
633
+ #
634
+ # The request ID must be a valid UUID with the exception that zero UUID is
635
+ # not supported (00000000-0000-0000-0000-000000000000).
636
+ # @!attribute [rw] etag
637
+ # @return [::String]
638
+ # Optional. The current etag of the Instance.
639
+ # If an etag is provided and does not match the current etag of the Instance,
640
+ # deletion will be blocked and an ABORTED error will be returned.
641
+ # @!attribute [rw] validate_only
642
+ # @return [::Boolean]
643
+ # Optional. If set, performs request validation (e.g. permission checks and
644
+ # any other type of validation), but do not actually execute the delete.
645
+ class DeleteInstanceRequest
646
+ include ::Google::Protobuf::MessageExts
647
+ extend ::Google::Protobuf::MessageExts::ClassMethods
648
+ end
649
+
650
+ # Message for triggering failover on an Instance
651
+ # @!attribute [rw] name
652
+ # @return [::String]
653
+ # Required. The name of the resource. For the required format, see the
654
+ # comment on the Instance.name field.
655
+ # @!attribute [rw] request_id
656
+ # @return [::String]
657
+ # Optional. An optional request ID to identify requests. Specify a unique
658
+ # request ID so that if you must retry your request, the server will know to
659
+ # ignore the request if it has already been completed. The server will
660
+ # guarantee that for at least 60 minutes after the first request.
661
+ #
662
+ # For example, consider a situation where you make an initial request and
663
+ # the request times out. If you make the request again with the same request
664
+ # ID, the server can check if original operation with the same request ID
665
+ # was received, and if so, will ignore the second request. This prevents
666
+ # clients from accidentally creating duplicate commitments.
667
+ #
668
+ # The request ID must be a valid UUID with the exception that zero UUID is
669
+ # not supported (00000000-0000-0000-0000-000000000000).
670
+ # @!attribute [rw] validate_only
671
+ # @return [::Boolean]
672
+ # Optional. If set, performs request validation (e.g. permission checks and
673
+ # any other type of validation), but do not actually execute the failover.
674
+ class FailoverInstanceRequest
675
+ include ::Google::Protobuf::MessageExts
676
+ extend ::Google::Protobuf::MessageExts::ClassMethods
677
+ end
678
+
679
+ # Message for triggering fault injection on an instance
680
+ # @!attribute [rw] fault_type
681
+ # @return [::Google::Cloud::AlloyDB::V1alpha::InjectFaultRequest::FaultType]
682
+ # Required. The type of fault to be injected in an instance.
683
+ # @!attribute [rw] name
684
+ # @return [::String]
685
+ # Required. The name of the resource. For the required format, see the
686
+ # comment on the Instance.name field.
687
+ # @!attribute [rw] request_id
688
+ # @return [::String]
689
+ # Optional. An optional request ID to identify requests. Specify a unique
690
+ # request ID so that if you must retry your request, the server will know to
691
+ # ignore the request if it has already been completed. The server will
692
+ # guarantee that for at least 60 minutes after the first request.
693
+ #
694
+ # For example, consider a situation where you make an initial request and
695
+ # the request times out. If you make the request again with the same request
696
+ # ID, the server can check if original operation with the same request ID
697
+ # was received, and if so, will ignore the second request. This prevents
698
+ # clients from accidentally creating duplicate commitments.
699
+ #
700
+ # The request ID must be a valid UUID with the exception that zero UUID is
701
+ # not supported (00000000-0000-0000-0000-000000000000).
702
+ # @!attribute [rw] validate_only
703
+ # @return [::Boolean]
704
+ # Optional. If set, performs request validation (e.g. permission checks and
705
+ # any other type of validation), but do not actually execute the fault
706
+ # injection.
707
+ class InjectFaultRequest
708
+ include ::Google::Protobuf::MessageExts
709
+ extend ::Google::Protobuf::MessageExts::ClassMethods
710
+
711
+ # FaultType contains all valid types of faults that can be injected to an
712
+ # instance.
713
+ module FaultType
714
+ # The fault type is unknown.
715
+ FAULT_TYPE_UNSPECIFIED = 0
716
+
717
+ # Stop the VM
718
+ STOP_VM = 1
719
+ end
720
+ end
721
+
722
+ # @!attribute [rw] name
723
+ # @return [::String]
724
+ # Required. The name of the resource. For the required format, see the
725
+ # comment on the Instance.name field.
726
+ # @!attribute [rw] request_id
727
+ # @return [::String]
728
+ # Optional. An optional request ID to identify requests. Specify a unique
729
+ # request ID so that if you must retry your request, the server will know to
730
+ # ignore the request if it has already been completed. The server will
731
+ # guarantee that for at least 60 minutes after the first request.
732
+ #
733
+ # For example, consider a situation where you make an initial request and
734
+ # the request times out. If you make the request again with the same request
735
+ # ID, the server can check if original operation with the same request ID
736
+ # was received, and if so, will ignore the second request. This prevents
737
+ # clients from accidentally creating duplicate commitments.
738
+ #
739
+ # The request ID must be a valid UUID with the exception that zero UUID is
740
+ # not supported (00000000-0000-0000-0000-000000000000).
741
+ # @!attribute [rw] validate_only
742
+ # @return [::Boolean]
743
+ # Optional. If set, performs request validation (e.g. permission checks and
744
+ # any other type of validation), but do not actually execute the restart.
745
+ class RestartInstanceRequest
746
+ include ::Google::Protobuf::MessageExts
747
+ extend ::Google::Protobuf::MessageExts::ClassMethods
748
+ end
749
+
750
+ # Message for requesting list of Backups
751
+ # @!attribute [rw] parent
752
+ # @return [::String]
753
+ # Required. Parent value for ListBackupsRequest
754
+ # @!attribute [rw] page_size
755
+ # @return [::Integer]
756
+ # Requested page size. Server may return fewer items than requested.
757
+ # If unspecified, server will pick an appropriate default.
758
+ # @!attribute [rw] page_token
759
+ # @return [::String]
760
+ # A token identifying a page of results the server should return.
761
+ # @!attribute [rw] filter
762
+ # @return [::String]
763
+ # Filtering results
764
+ # @!attribute [rw] order_by
765
+ # @return [::String]
766
+ # Hint for how to order the results
767
+ class ListBackupsRequest
768
+ include ::Google::Protobuf::MessageExts
769
+ extend ::Google::Protobuf::MessageExts::ClassMethods
770
+ end
771
+
772
+ # Message for response to listing Backups
773
+ # @!attribute [rw] backups
774
+ # @return [::Array<::Google::Cloud::AlloyDB::V1alpha::Backup>]
775
+ # The list of Backup
776
+ # @!attribute [rw] next_page_token
777
+ # @return [::String]
778
+ # A token identifying a page of results the server should return.
779
+ # @!attribute [rw] unreachable
780
+ # @return [::Array<::String>]
781
+ # Locations that could not be reached.
782
+ class ListBackupsResponse
783
+ include ::Google::Protobuf::MessageExts
784
+ extend ::Google::Protobuf::MessageExts::ClassMethods
785
+ end
786
+
787
+ # Message for getting a Backup
788
+ # @!attribute [rw] name
789
+ # @return [::String]
790
+ # Required. Name of the resource
791
+ class GetBackupRequest
792
+ include ::Google::Protobuf::MessageExts
793
+ extend ::Google::Protobuf::MessageExts::ClassMethods
794
+ end
795
+
796
+ # Message for creating a Backup
797
+ # @!attribute [rw] parent
798
+ # @return [::String]
799
+ # Required. Value for parent.
800
+ # @!attribute [rw] backup_id
801
+ # @return [::String]
802
+ # Required. ID of the requesting object.
803
+ # @!attribute [rw] backup
804
+ # @return [::Google::Cloud::AlloyDB::V1alpha::Backup]
805
+ # Required. The resource being created
806
+ # @!attribute [rw] request_id
807
+ # @return [::String]
808
+ # Optional. An optional request ID to identify requests. Specify a unique
809
+ # request ID so that if you must retry your request, the server will know to
810
+ # ignore the request if it has already been completed. The server will
811
+ # guarantee that for at least 60 minutes since the first request.
812
+ #
813
+ # For example, consider a situation where you make an initial request and
814
+ # the request times out. If you make the request again with the same request
815
+ # ID, the server can check if original operation with the same request ID
816
+ # was received, and if so, will ignore the second request. This prevents
817
+ # clients from accidentally creating duplicate commitments.
818
+ #
819
+ # The request ID must be a valid UUID with the exception that zero UUID is
820
+ # not supported (00000000-0000-0000-0000-000000000000).
821
+ # @!attribute [rw] validate_only
822
+ # @return [::Boolean]
823
+ # Optional. If set, the backend validates the request, but doesn't actually
824
+ # execute it.
825
+ class CreateBackupRequest
826
+ include ::Google::Protobuf::MessageExts
827
+ extend ::Google::Protobuf::MessageExts::ClassMethods
828
+ end
829
+
830
+ # Message for updating a Backup
831
+ # @!attribute [rw] update_mask
832
+ # @return [::Google::Protobuf::FieldMask]
833
+ # Optional. Field mask is used to specify the fields to be overwritten in the
834
+ # Backup resource by the update.
835
+ # The fields specified in the update_mask are relative to the resource, not
836
+ # the full request. A field will be overwritten if it is in the mask. If the
837
+ # user does not provide a mask then all fields will be overwritten.
838
+ # @!attribute [rw] backup
839
+ # @return [::Google::Cloud::AlloyDB::V1alpha::Backup]
840
+ # Required. The resource being updated
841
+ # @!attribute [rw] request_id
842
+ # @return [::String]
843
+ # Optional. An optional request ID to identify requests. Specify a unique
844
+ # request ID so that if you must retry your request, the server will know to
845
+ # ignore the request if it has already been completed. The server will
846
+ # guarantee that for at least 60 minutes since the first request.
847
+ #
848
+ # For example, consider a situation where you make an initial request and
849
+ # the request times out. If you make the request again with the same request
850
+ # ID, the server can check if original operation with the same request ID
851
+ # was received, and if so, will ignore the second request. This prevents
852
+ # clients from accidentally creating duplicate commitments.
853
+ #
854
+ # The request ID must be a valid UUID with the exception that zero UUID is
855
+ # not supported (00000000-0000-0000-0000-000000000000).
856
+ # @!attribute [rw] validate_only
857
+ # @return [::Boolean]
858
+ # Optional. If set, the backend validates the request, but doesn't actually
859
+ # execute it.
860
+ # @!attribute [rw] allow_missing
861
+ # @return [::Boolean]
862
+ # Optional. If set to true, update succeeds even if instance is not found. In
863
+ # that case, a new backup is created and `update_mask` is ignored.
864
+ class UpdateBackupRequest
865
+ include ::Google::Protobuf::MessageExts
866
+ extend ::Google::Protobuf::MessageExts::ClassMethods
867
+ end
868
+
869
+ # Message for deleting a Backup
870
+ # @!attribute [rw] name
871
+ # @return [::String]
872
+ # Required. Name of the resource. For the required format, see the comment on
873
+ # the Backup.name field.
874
+ # @!attribute [rw] request_id
875
+ # @return [::String]
876
+ # Optional. An optional request ID to identify requests. Specify a unique
877
+ # request ID so that if you must retry your request, the server will know to
878
+ # ignore the request if it has already been completed. The server will
879
+ # guarantee that for at least 60 minutes after the first request.
880
+ #
881
+ # For example, consider a situation where you make an initial request and
882
+ # the request times out. If you make the request again with the same request
883
+ # ID, the server can check if original operation with the same request ID
884
+ # was received, and if so, will ignore the second request. This prevents
885
+ # clients from accidentally creating duplicate commitments.
886
+ #
887
+ # The request ID must be a valid UUID with the exception that zero UUID is
888
+ # not supported (00000000-0000-0000-0000-000000000000).
889
+ # @!attribute [rw] validate_only
890
+ # @return [::Boolean]
891
+ # Optional. If set, the backend validates the request, but doesn't actually
892
+ # execute it.
893
+ # @!attribute [rw] etag
894
+ # @return [::String]
895
+ # Optional. The current etag of the Backup.
896
+ # If an etag is provided and does not match the current etag of the Backup,
897
+ # deletion will be blocked and an ABORTED error will be returned.
898
+ class DeleteBackupRequest
899
+ include ::Google::Protobuf::MessageExts
900
+ extend ::Google::Protobuf::MessageExts::ClassMethods
901
+ end
902
+
903
+ # Message for listing the information about the supported Database flags.
904
+ # @!attribute [rw] parent
905
+ # @return [::String]
906
+ # Required. The name of the parent resource. The required format is:
907
+ # * projects/\\{project}/locations/\\{location}
908
+ #
909
+ # Regardless of the parent specified here, as long it is contains a valid
910
+ # project and location, the service will return a static list of supported
911
+ # flags resources. Note that we do not yet support region-specific
912
+ # flags.
913
+ # @!attribute [rw] page_size
914
+ # @return [::Integer]
915
+ # Requested page size. Server may return fewer items than requested.
916
+ # If unspecified, server will pick an appropriate default.
917
+ # @!attribute [rw] page_token
918
+ # @return [::String]
919
+ # A token identifying a page of results the server should return.
920
+ class ListSupportedDatabaseFlagsRequest
921
+ include ::Google::Protobuf::MessageExts
922
+ extend ::Google::Protobuf::MessageExts::ClassMethods
923
+ end
924
+
925
+ # Message for response to listing SupportedDatabaseFlags.
926
+ # @!attribute [rw] supported_database_flags
927
+ # @return [::Array<::Google::Cloud::AlloyDB::V1alpha::SupportedDatabaseFlag>]
928
+ # The list of SupportedDatabaseFlags.
929
+ # @!attribute [rw] next_page_token
930
+ # @return [::String]
931
+ # A token identifying a page of results the server should return.
932
+ class ListSupportedDatabaseFlagsResponse
933
+ include ::Google::Protobuf::MessageExts
934
+ extend ::Google::Protobuf::MessageExts::ClassMethods
935
+ end
936
+
937
+ # Message for requests to generate a client certificate signed by the Cluster
938
+ # CA.
939
+ # @!attribute [rw] parent
940
+ # @return [::String]
941
+ # Required. The name of the parent resource. The required format is:
942
+ # * projects/\\{project}/locations/\\{location}/clusters/\\{cluster}
943
+ # @!attribute [rw] request_id
944
+ # @return [::String]
945
+ # Optional. An optional request ID to identify requests. Specify a unique
946
+ # request ID so that if you must retry your request, the server will know to
947
+ # ignore the request if it has already been completed. The server will
948
+ # guarantee that for at least 60 minutes after the first request.
949
+ #
950
+ # For example, consider a situation where you make an initial request and
951
+ # the request times out. If you make the request again with the same request
952
+ # ID, the server can check if original operation with the same request ID
953
+ # was received, and if so, will ignore the second request. This prevents
954
+ # clients from accidentally creating duplicate commitments.
955
+ #
956
+ # The request ID must be a valid UUID with the exception that zero UUID is
957
+ # not supported (00000000-0000-0000-0000-000000000000).
958
+ # @!attribute [rw] pem_csr
959
+ # @return [::String]
960
+ # Optional. A pem-encoded X.509 certificate signing request (CSR).
961
+ # @!attribute [rw] cert_duration
962
+ # @return [::Google::Protobuf::Duration]
963
+ # Optional. An optional hint to the endpoint to generate the client
964
+ # certificate with the requested duration. The duration can be from 1 hour to
965
+ # 24 hours. The endpoint may or may not honor the hint. If the hint is left
966
+ # unspecified or is not honored, then the endpoint will pick an appropriate
967
+ # default duration.
968
+ # @!attribute [rw] public_key
969
+ # @return [::String]
970
+ # Optional. The public key from the client.
971
+ # @!attribute [rw] use_metadata_exchange
972
+ # @return [::Boolean]
973
+ # Optional. An optional hint to the endpoint to generate a client
974
+ # ceritificate that can be used by AlloyDB connectors to exchange additional
975
+ # metadata with the server after TLS handshake.
976
+ class GenerateClientCertificateRequest
977
+ include ::Google::Protobuf::MessageExts
978
+ extend ::Google::Protobuf::MessageExts::ClassMethods
979
+ end
980
+
981
+ # Message returned by a GenerateClientCertificate operation.
982
+ # @!attribute [r] pem_certificate
983
+ # @return [::String]
984
+ # Output only. The pem-encoded, signed X.509 certificate.
985
+ # @!attribute [r] pem_certificate_chain
986
+ # @return [::Array<::String>]
987
+ # Output only. The pem-encoded chain that may be used to verify the X.509
988
+ # certificate. Expected to be in issuer-to-root order according to RFC 5246.
989
+ # @!attribute [rw] ca_cert
990
+ # @return [::String]
991
+ # Optional. The pem-encoded cluster ca X.509 certificate.
992
+ class GenerateClientCertificateResponse
993
+ include ::Google::Protobuf::MessageExts
994
+ extend ::Google::Protobuf::MessageExts::ClassMethods
995
+ end
996
+
997
+ # Request message for GetConnectionInfo.
998
+ # @!attribute [rw] parent
999
+ # @return [::String]
1000
+ # Required. The name of the parent resource. The required format is:
1001
+ # projects/\\{project}/locations/\\{location}/clusters/\\{cluster}/instances/\\{instance}
1002
+ # @!attribute [rw] request_id
1003
+ # @return [::String]
1004
+ # Optional. An optional request ID to identify requests. Specify a unique
1005
+ # request ID so that if you must retry your request, the server will know to
1006
+ # ignore the request if it has already been completed. The server will
1007
+ # guarantee that for at least 60 minutes after the first request.
1008
+ #
1009
+ # For example, consider a situation where you make an initial request and
1010
+ # the request times out. If you make the request again with the same request
1011
+ # ID, the server can check if original operation with the same request ID
1012
+ # was received, and if so, will ignore the second request. This prevents
1013
+ # clients from accidentally creating duplicate commitments.
1014
+ #
1015
+ # The request ID must be a valid UUID with the exception that zero UUID is
1016
+ # not supported (00000000-0000-0000-0000-000000000000).
1017
+ class GetConnectionInfoRequest
1018
+ include ::Google::Protobuf::MessageExts
1019
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1020
+ end
1021
+
1022
+ # Represents the metadata of the long-running operation.
1023
+ # @!attribute [r] batch_create_instances_metadata
1024
+ # @return [::Google::Cloud::AlloyDB::V1alpha::BatchCreateInstancesMetadata]
1025
+ # Output only. BatchCreateInstances related metadata.
1026
+ # @!attribute [r] create_time
1027
+ # @return [::Google::Protobuf::Timestamp]
1028
+ # Output only. The time the operation was created.
1029
+ # @!attribute [r] end_time
1030
+ # @return [::Google::Protobuf::Timestamp]
1031
+ # Output only. The time the operation finished running.
1032
+ # @!attribute [r] target
1033
+ # @return [::String]
1034
+ # Output only. Server-defined resource path for the target of the operation.
1035
+ # @!attribute [r] verb
1036
+ # @return [::String]
1037
+ # Output only. Name of the verb executed by the operation.
1038
+ # @!attribute [r] status_message
1039
+ # @return [::String]
1040
+ # Output only. Human-readable status of the operation, if any.
1041
+ # @!attribute [r] requested_cancellation
1042
+ # @return [::Boolean]
1043
+ # Output only. Identifies whether the user has requested cancellation
1044
+ # of the operation. Operations that have successfully been cancelled
1045
+ # have [Operation.error][] value with a
1046
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
1047
+ # `Code.CANCELLED`.
1048
+ # @!attribute [r] api_version
1049
+ # @return [::String]
1050
+ # Output only. API version used to start the operation.
1051
+ class OperationMetadata
1052
+ include ::Google::Protobuf::MessageExts
1053
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1054
+ end
1055
+
1056
+ # Message for requesting list of Users
1057
+ # @!attribute [rw] parent
1058
+ # @return [::String]
1059
+ # Required. Parent value for ListUsersRequest
1060
+ # @!attribute [rw] page_size
1061
+ # @return [::Integer]
1062
+ # Optional. Requested page size. Server may return fewer items than
1063
+ # requested. If unspecified, server will pick an appropriate default.
1064
+ # @!attribute [rw] page_token
1065
+ # @return [::String]
1066
+ # Optional. A token identifying a page of results the server should return.
1067
+ # @!attribute [rw] filter
1068
+ # @return [::String]
1069
+ # Optional. Filtering results
1070
+ # @!attribute [rw] order_by
1071
+ # @return [::String]
1072
+ # Optional. Hint for how to order the results
1073
+ class ListUsersRequest
1074
+ include ::Google::Protobuf::MessageExts
1075
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1076
+ end
1077
+
1078
+ # Message for response to listing Users
1079
+ # @!attribute [rw] users
1080
+ # @return [::Array<::Google::Cloud::AlloyDB::V1alpha::User>]
1081
+ # The list of User
1082
+ # @!attribute [rw] next_page_token
1083
+ # @return [::String]
1084
+ # A token identifying a page of results the server should return.
1085
+ # @!attribute [rw] unreachable
1086
+ # @return [::Array<::String>]
1087
+ # Locations that could not be reached.
1088
+ class ListUsersResponse
1089
+ include ::Google::Protobuf::MessageExts
1090
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1091
+ end
1092
+
1093
+ # Message for getting a User
1094
+ # @!attribute [rw] name
1095
+ # @return [::String]
1096
+ # Required. The name of the resource. For the required format, see the
1097
+ # comment on the User.name field.
1098
+ class GetUserRequest
1099
+ include ::Google::Protobuf::MessageExts
1100
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1101
+ end
1102
+
1103
+ # Message for creating a User
1104
+ # @!attribute [rw] parent
1105
+ # @return [::String]
1106
+ # Required. Value for parent.
1107
+ # @!attribute [rw] user_id
1108
+ # @return [::String]
1109
+ # Required. ID of the requesting object.
1110
+ # @!attribute [rw] user
1111
+ # @return [::Google::Cloud::AlloyDB::V1alpha::User]
1112
+ # Required. The resource being created
1113
+ # @!attribute [rw] request_id
1114
+ # @return [::String]
1115
+ # Optional. An optional request ID to identify requests. Specify a unique
1116
+ # request ID so that if you must retry your request, the server will know to
1117
+ # ignore the request if it has already been completed. The server will
1118
+ # guarantee that for at least 60 minutes since the first request.
1119
+ #
1120
+ # For example, consider a situation where you make an initial request and
1121
+ # the request times out. If you make the request again with the same request
1122
+ # ID, the server can check if original operation with the same request ID
1123
+ # was received, and if so, will ignore the second request. This prevents
1124
+ # clients from accidentally creating duplicate commitments.
1125
+ #
1126
+ # The request ID must be a valid UUID with the exception that zero UUID is
1127
+ # not supported (00000000-0000-0000-0000-000000000000).
1128
+ # @!attribute [rw] validate_only
1129
+ # @return [::Boolean]
1130
+ # Optional. If set, the backend validates the request, but doesn't actually
1131
+ # execute it.
1132
+ class CreateUserRequest
1133
+ include ::Google::Protobuf::MessageExts
1134
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1135
+ end
1136
+
1137
+ # Message for updating a User
1138
+ # @!attribute [rw] update_mask
1139
+ # @return [::Google::Protobuf::FieldMask]
1140
+ # Optional. Field mask is used to specify the fields to be overwritten in the
1141
+ # User resource by the update.
1142
+ # The fields specified in the update_mask are relative to the resource, not
1143
+ # the full request. A field will be overwritten if it is in the mask. If the
1144
+ # user does not provide a mask then all fields will be overwritten.
1145
+ # @!attribute [rw] user
1146
+ # @return [::Google::Cloud::AlloyDB::V1alpha::User]
1147
+ # Required. The resource being updated
1148
+ # @!attribute [rw] request_id
1149
+ # @return [::String]
1150
+ # Optional. An optional request ID to identify requests. Specify a unique
1151
+ # request ID so that if you must retry your request, the server will know to
1152
+ # ignore the request if it has already been completed. The server will
1153
+ # guarantee that for at least 60 minutes since the first request.
1154
+ #
1155
+ # For example, consider a situation where you make an initial request and
1156
+ # the request times out. If you make the request again with the same request
1157
+ # ID, the server can check if original operation with the same request ID
1158
+ # was received, and if so, will ignore the second request. This prevents
1159
+ # clients from accidentally creating duplicate commitments.
1160
+ #
1161
+ # The request ID must be a valid UUID with the exception that zero UUID is
1162
+ # not supported (00000000-0000-0000-0000-000000000000).
1163
+ # @!attribute [rw] validate_only
1164
+ # @return [::Boolean]
1165
+ # Optional. If set, the backend validates the request, but doesn't actually
1166
+ # execute it.
1167
+ # @!attribute [rw] allow_missing
1168
+ # @return [::Boolean]
1169
+ # Optional. Allow missing fields in the update mask.
1170
+ class UpdateUserRequest
1171
+ include ::Google::Protobuf::MessageExts
1172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1173
+ end
1174
+
1175
+ # Message for deleting a User
1176
+ # @!attribute [rw] name
1177
+ # @return [::String]
1178
+ # Required. The name of the resource. For the required format, see the
1179
+ # comment on the User.name field.
1180
+ # @!attribute [rw] request_id
1181
+ # @return [::String]
1182
+ # Optional. An optional request ID to identify requests. Specify a unique
1183
+ # request ID so that if you must retry your request, the server will know to
1184
+ # ignore the request if it has already been completed. The server will
1185
+ # guarantee that for at least 60 minutes after the first request.
1186
+ #
1187
+ # For example, consider a situation where you make an initial request and
1188
+ # the request times out. If you make the request again with the same request
1189
+ # ID, the server can check if original operation with the same request ID
1190
+ # was received, and if so, will ignore the second request. This prevents
1191
+ # clients from accidentally creating duplicate commitments.
1192
+ #
1193
+ # The request ID must be a valid UUID with the exception that zero UUID is
1194
+ # not supported (00000000-0000-0000-0000-000000000000).
1195
+ # @!attribute [rw] validate_only
1196
+ # @return [::Boolean]
1197
+ # Optional. If set, the backend validates the request, but doesn't actually
1198
+ # execute it.
1199
+ class DeleteUserRequest
1200
+ include ::Google::Protobuf::MessageExts
1201
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1202
+ end
1203
+ end
1204
+ end
1205
+ end
1206
+ end