google-cloud-alloy_db-v1 0.a → 0.2.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 (40) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb +2695 -0
  6. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/credentials.rb +47 -0
  7. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/operations.rb +770 -0
  8. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/paths.rb +149 -0
  9. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/rest/client.rb +2113 -0
  10. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/rest/operations.rb +795 -0
  11. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/rest/service_stub.rb +1238 -0
  12. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/rest.rb +54 -0
  13. data/lib/google/cloud/alloy_db/v1/alloy_db_admin.rb +56 -0
  14. data/lib/google/cloud/alloy_db/v1/bindings_override.rb +102 -0
  15. data/lib/google/cloud/alloy_db/v1/rest.rb +38 -0
  16. data/lib/google/cloud/alloy_db/v1/version.rb +8 -3
  17. data/lib/google/cloud/alloy_db/v1.rb +45 -0
  18. data/lib/google/cloud/alloydb/v1/resources_pb.rb +89 -0
  19. data/lib/google/cloud/alloydb/v1/service_pb.rb +86 -0
  20. data/lib/google/cloud/alloydb/v1/service_services_pb.rb +97 -0
  21. data/lib/google-cloud-alloy_db-v1.rb +21 -0
  22. data/proto_docs/README.md +4 -0
  23. data/proto_docs/google/api/client.rb +381 -0
  24. data/proto_docs/google/api/field_behavior.rb +71 -0
  25. data/proto_docs/google/api/launch_stage.rb +71 -0
  26. data/proto_docs/google/api/resource.rb +222 -0
  27. data/proto_docs/google/cloud/alloydb/v1/resources.rb +985 -0
  28. data/proto_docs/google/cloud/alloydb/v1/service.rb +815 -0
  29. data/proto_docs/google/longrunning/operations.rb +164 -0
  30. data/proto_docs/google/protobuf/any.rb +144 -0
  31. data/proto_docs/google/protobuf/duration.rb +98 -0
  32. data/proto_docs/google/protobuf/empty.rb +34 -0
  33. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  34. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  35. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  36. data/proto_docs/google/rpc/status.rb +48 -0
  37. data/proto_docs/google/type/dayofweek.rb +49 -0
  38. data/proto_docs/google/type/expr.rb +75 -0
  39. data/proto_docs/google/type/timeofday.rb +45 -0
  40. metadata +250 -12
@@ -0,0 +1,815 @@
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 V1
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::V1::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
+ class GetClusterRequest
70
+ include ::Google::Protobuf::MessageExts
71
+ extend ::Google::Protobuf::MessageExts::ClassMethods
72
+ end
73
+
74
+ # Message for creating a Cluster
75
+ # @!attribute [rw] parent
76
+ # @return [::String]
77
+ # Required. The name of the parent resource. For the required format, see the
78
+ # comment on the Cluster.name field.
79
+ # @!attribute [rw] cluster_id
80
+ # @return [::String]
81
+ # Required. ID of the requesting object.
82
+ # @!attribute [rw] cluster
83
+ # @return [::Google::Cloud::AlloyDB::V1::Cluster]
84
+ # Required. The resource being created
85
+ # @!attribute [rw] request_id
86
+ # @return [::String]
87
+ # Optional. An optional request ID to identify requests. Specify a unique
88
+ # request ID so that if you must retry your request, the server will know to
89
+ # ignore the request if it has already been completed. The server will
90
+ # guarantee that for at least 60 minutes since the first request.
91
+ #
92
+ # For example, consider a situation where you make an initial request and
93
+ # the request times out. If you make the request again with the same request
94
+ # ID, the server can check if original operation with the same request ID
95
+ # was received, and if so, will ignore the second request. This prevents
96
+ # clients from accidentally creating duplicate commitments.
97
+ #
98
+ # The request ID must be a valid UUID with the exception that zero UUID is
99
+ # not supported (00000000-0000-0000-0000-000000000000).
100
+ # @!attribute [rw] validate_only
101
+ # @return [::Boolean]
102
+ # Optional. If set, performs request validation (e.g. permission checks and
103
+ # any other type of validation), but do not actually execute the create
104
+ # request.
105
+ class CreateClusterRequest
106
+ include ::Google::Protobuf::MessageExts
107
+ extend ::Google::Protobuf::MessageExts::ClassMethods
108
+ end
109
+
110
+ # Message for updating a Cluster
111
+ # @!attribute [rw] update_mask
112
+ # @return [::Google::Protobuf::FieldMask]
113
+ # Optional. Field mask is used to specify the fields to be overwritten in the
114
+ # Cluster resource by the update.
115
+ # The fields specified in the update_mask are relative to the resource, not
116
+ # the full request. A field will be overwritten if it is in the mask. If the
117
+ # user does not provide a mask then all fields will be overwritten.
118
+ # @!attribute [rw] cluster
119
+ # @return [::Google::Cloud::AlloyDB::V1::Cluster]
120
+ # Required. The resource being updated
121
+ # @!attribute [rw] request_id
122
+ # @return [::String]
123
+ # Optional. An optional request ID to identify requests. Specify a unique
124
+ # request ID so that if you must retry your request, the server will know to
125
+ # ignore the request if it has already been completed. The server will
126
+ # guarantee that for at least 60 minutes since the first request.
127
+ #
128
+ # For example, consider a situation where you make an initial request and
129
+ # the request times out. If you make the request again with the same request
130
+ # ID, the server can check if original operation with the same request ID
131
+ # was received, and if so, will ignore the second request. This prevents
132
+ # clients from accidentally creating duplicate commitments.
133
+ #
134
+ # The request ID must be a valid UUID with the exception that zero UUID is
135
+ # not supported (00000000-0000-0000-0000-000000000000).
136
+ # @!attribute [rw] validate_only
137
+ # @return [::Boolean]
138
+ # Optional. If set, performs request validation (e.g. permission checks and
139
+ # any other type of validation), but do not actually execute the update
140
+ # request.
141
+ # @!attribute [rw] allow_missing
142
+ # @return [::Boolean]
143
+ # Optional. If set to true, update succeeds even if cluster is not found. In
144
+ # that case, a new cluster is created and `update_mask` is ignored.
145
+ class UpdateClusterRequest
146
+ include ::Google::Protobuf::MessageExts
147
+ extend ::Google::Protobuf::MessageExts::ClassMethods
148
+ end
149
+
150
+ # Message for deleting a Cluster
151
+ # @!attribute [rw] name
152
+ # @return [::String]
153
+ # Required. The name of the resource. For the required format, see the
154
+ # comment on the Cluster.name field.
155
+ # @!attribute [rw] request_id
156
+ # @return [::String]
157
+ # Optional. An optional request ID to identify requests. Specify a unique
158
+ # request ID so that if you must retry your request, the server will know to
159
+ # ignore the request if it has already been completed. The server will
160
+ # guarantee that for at least 60 minutes after the first request.
161
+ #
162
+ # For example, consider a situation where you make an initial request and
163
+ # the request times out. If you make the request again with the same request
164
+ # ID, the server can check if original operation with the same request ID
165
+ # was received, and if so, will ignore the second request. This prevents
166
+ # clients from accidentally creating duplicate commitments.
167
+ #
168
+ # The request ID must be a valid UUID with the exception that zero UUID is
169
+ # not supported (00000000-0000-0000-0000-000000000000).
170
+ # @!attribute [rw] etag
171
+ # @return [::String]
172
+ # Optional. The current etag of the Cluster.
173
+ # If an etag is provided and does not match the current etag of the Cluster,
174
+ # deletion will be blocked and an ABORTED error will be returned.
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 delete.
179
+ # @!attribute [rw] force
180
+ # @return [::Boolean]
181
+ # Optional. Whether to cascade delete child instances for given cluster.
182
+ class DeleteClusterRequest
183
+ include ::Google::Protobuf::MessageExts
184
+ extend ::Google::Protobuf::MessageExts::ClassMethods
185
+ end
186
+
187
+ # Message for restoring a Cluster from a backup or another cluster at a given
188
+ # point in time.
189
+ # @!attribute [rw] backup_source
190
+ # @return [::Google::Cloud::AlloyDB::V1::BackupSource]
191
+ # Backup source.
192
+ # @!attribute [rw] parent
193
+ # @return [::String]
194
+ # Required. The name of the parent resource. For the required format, see the
195
+ # comment on the Cluster.name field.
196
+ # @!attribute [rw] cluster_id
197
+ # @return [::String]
198
+ # Required. ID of the requesting object.
199
+ # @!attribute [rw] cluster
200
+ # @return [::Google::Cloud::AlloyDB::V1::Cluster]
201
+ # Required. The resource being created
202
+ # @!attribute [rw] request_id
203
+ # @return [::String]
204
+ # Optional. An optional request ID to identify requests. Specify a unique
205
+ # request ID so that if you must retry your request, the server will know to
206
+ # ignore the request if it has already been completed. The server will
207
+ # guarantee that for at least 60 minutes since the first request.
208
+ #
209
+ # For example, consider a situation where you make an initial request and
210
+ # the request times out. If you make the request again with the same request
211
+ # ID, the server can check if original operation with the same request ID
212
+ # was received, and if so, will ignore the second request. This prevents
213
+ # clients from accidentally creating duplicate commitments.
214
+ #
215
+ # The request ID must be a valid UUID with the exception that zero UUID is
216
+ # not supported (00000000-0000-0000-0000-000000000000).
217
+ # @!attribute [rw] validate_only
218
+ # @return [::Boolean]
219
+ # Optional. If set, performs request validation (e.g. permission checks and
220
+ # any other type of validation), but do not actually execute the import
221
+ # request.
222
+ class RestoreClusterRequest
223
+ include ::Google::Protobuf::MessageExts
224
+ extend ::Google::Protobuf::MessageExts::ClassMethods
225
+ end
226
+
227
+ # Message for requesting list of Instances
228
+ # @!attribute [rw] parent
229
+ # @return [::String]
230
+ # Required. The name of the parent resource. For the required format, see the
231
+ # comment on the Instance.name field. Additionally, you can perform an
232
+ # aggregated list operation by specifying a value with one of the following
233
+ # formats:
234
+ # * projects/\\{project}/locations/-/clusters/-
235
+ # * projects/\\{project}/locations/\\{region}/clusters/-
236
+ # @!attribute [rw] page_size
237
+ # @return [::Integer]
238
+ # Optional. Requested page size. Server may return fewer items than
239
+ # requested. If unspecified, server will pick an appropriate default.
240
+ # @!attribute [rw] page_token
241
+ # @return [::String]
242
+ # A token identifying a page of results the server should return.
243
+ # @!attribute [rw] filter
244
+ # @return [::String]
245
+ # Optional. Filtering results
246
+ # @!attribute [rw] order_by
247
+ # @return [::String]
248
+ # Optional. Hint for how to order the results
249
+ class ListInstancesRequest
250
+ include ::Google::Protobuf::MessageExts
251
+ extend ::Google::Protobuf::MessageExts::ClassMethods
252
+ end
253
+
254
+ # Message for response to listing Instances
255
+ # @!attribute [rw] instances
256
+ # @return [::Array<::Google::Cloud::AlloyDB::V1::Instance>]
257
+ # The list of Instance
258
+ # @!attribute [rw] next_page_token
259
+ # @return [::String]
260
+ # A token identifying a page of results the server should return.
261
+ # @!attribute [rw] unreachable
262
+ # @return [::Array<::String>]
263
+ # Locations that could not be reached.
264
+ class ListInstancesResponse
265
+ include ::Google::Protobuf::MessageExts
266
+ extend ::Google::Protobuf::MessageExts::ClassMethods
267
+ end
268
+
269
+ # Message for getting a Instance
270
+ # @!attribute [rw] name
271
+ # @return [::String]
272
+ # Required. The name of the resource. For the required format, see the
273
+ # comment on the Instance.name field.
274
+ # @!attribute [rw] view
275
+ # @return [::Google::Cloud::AlloyDB::V1::InstanceView]
276
+ # The view of the instance to return.
277
+ class GetInstanceRequest
278
+ include ::Google::Protobuf::MessageExts
279
+ extend ::Google::Protobuf::MessageExts::ClassMethods
280
+ end
281
+
282
+ # Message for creating a Instance
283
+ # @!attribute [rw] parent
284
+ # @return [::String]
285
+ # Required. The name of the parent resource. For the required format, see the
286
+ # comment on the Instance.name field.
287
+ # @!attribute [rw] instance_id
288
+ # @return [::String]
289
+ # Required. ID of the requesting object.
290
+ # @!attribute [rw] instance
291
+ # @return [::Google::Cloud::AlloyDB::V1::Instance]
292
+ # Required. The resource being created
293
+ # @!attribute [rw] request_id
294
+ # @return [::String]
295
+ # Optional. An optional request ID to identify requests. Specify a unique
296
+ # request ID so that if you must retry your request, the server will know to
297
+ # ignore the request if it has already been completed. The server will
298
+ # guarantee that for at least 60 minutes since the first request.
299
+ #
300
+ # For example, consider a situation where you make an initial request and
301
+ # the request times out. If you make the request again with the same request
302
+ # ID, the server can check if original operation with the same request ID
303
+ # was received, and if so, will ignore the second request. This prevents
304
+ # clients from accidentally creating duplicate commitments.
305
+ #
306
+ # The request ID must be a valid UUID with the exception that zero UUID is
307
+ # not supported (00000000-0000-0000-0000-000000000000).
308
+ # @!attribute [rw] validate_only
309
+ # @return [::Boolean]
310
+ # Optional. If set, performs request validation (e.g. permission checks and
311
+ # any other type of validation), but do not actually execute the create
312
+ # request.
313
+ class CreateInstanceRequest
314
+ include ::Google::Protobuf::MessageExts
315
+ extend ::Google::Protobuf::MessageExts::ClassMethods
316
+ end
317
+
318
+ # See usage below for notes.
319
+ # @!attribute [rw] create_instance_requests
320
+ # @return [::Array<::Google::Cloud::AlloyDB::V1::CreateInstanceRequest>]
321
+ # Required. Primary and read replica instances to be created. This list
322
+ # should not be empty.
323
+ class CreateInstanceRequests
324
+ include ::Google::Protobuf::MessageExts
325
+ extend ::Google::Protobuf::MessageExts::ClassMethods
326
+ end
327
+
328
+ # Message for creating a batch of instances under the specified cluster.
329
+ # @!attribute [rw] parent
330
+ # @return [::String]
331
+ # Required. The name of the parent resource.
332
+ # @!attribute [rw] requests
333
+ # @return [::Google::Cloud::AlloyDB::V1::CreateInstanceRequests]
334
+ # Required. Resources being created.
335
+ # @!attribute [rw] request_id
336
+ # @return [::String]
337
+ # Optional. An optional request ID to identify requests. Specify a unique
338
+ # request ID so that if you must retry your request, the server will know to
339
+ # ignore the request if it has already been completed. The server will
340
+ # guarantee that for at least 60 minutes since the first request.
341
+ #
342
+ # For example, consider a situation where you make an initial request and
343
+ # the request times out. If you make the request again with the same request
344
+ # ID, the server can check if original operation with the same request ID
345
+ # was received, and if so, will ignore the second request. This prevents
346
+ # clients from accidentally creating duplicate commitments.
347
+ #
348
+ # The request ID must be a valid UUID with the exception that zero UUID is
349
+ # not supported (00000000-0000-0000-0000-000000000000).
350
+ class BatchCreateInstancesRequest
351
+ include ::Google::Protobuf::MessageExts
352
+ extend ::Google::Protobuf::MessageExts::ClassMethods
353
+ end
354
+
355
+ # Message for creating batches of instances in a cluster.
356
+ # @!attribute [rw] instances
357
+ # @return [::Array<::Google::Cloud::AlloyDB::V1::Instance>]
358
+ # Created instances.
359
+ class BatchCreateInstancesResponse
360
+ include ::Google::Protobuf::MessageExts
361
+ extend ::Google::Protobuf::MessageExts::ClassMethods
362
+ end
363
+
364
+ # Message for metadata that is specific to BatchCreateInstances API.
365
+ # @!attribute [rw] instance_targets
366
+ # @return [::Array<::String>]
367
+ # The instances being created in the API call. Each string in this list
368
+ # is the server defined resource path for target instances in the request
369
+ # and for the format of each string, see the comment on the Instance.name
370
+ # field.
371
+ # @!attribute [rw] instance_statuses
372
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AlloyDB::V1::BatchCreateInstanceStatus}]
373
+ # A map representing state of the instances involved in the
374
+ # BatchCreateInstances operation during the operation execution.
375
+ # The instance state will be in STATE_UNSPECIFIED state if the instance has
376
+ # not yet been picked up for processing.
377
+ # The key of the map is the name of the instance resource.
378
+ # For the format, see the comment on the Instance.name field.
379
+ class BatchCreateInstancesMetadata
380
+ include ::Google::Protobuf::MessageExts
381
+ extend ::Google::Protobuf::MessageExts::ClassMethods
382
+
383
+ # @!attribute [rw] key
384
+ # @return [::String]
385
+ # @!attribute [rw] value
386
+ # @return [::Google::Cloud::AlloyDB::V1::BatchCreateInstanceStatus]
387
+ class InstanceStatusesEntry
388
+ include ::Google::Protobuf::MessageExts
389
+ extend ::Google::Protobuf::MessageExts::ClassMethods
390
+ end
391
+ end
392
+
393
+ # Message for current status of an instance in the BatchCreateInstances
394
+ # operation.
395
+ # For example, lets say a BatchCreateInstances workflow has 4 instances,
396
+ # Instance1 through Instance4. Lets also assume that 2 instances succeeded
397
+ # but the third failed to create and the 4th was never picked up for creation
398
+ # because of failure of the previous one. Then, resulting states would look
399
+ # something like:
400
+ # 1. Instance1 = ROLLED_BACK
401
+ # 2. Instance2 = ROLLED_BACK
402
+ # 3. Instance3 = FAILED
403
+ # 4. Instance4 = FAILED
404
+ # However, while the operation is running, the instance might be in other
405
+ # states including PENDING_CREATE, ACTIVE, DELETING and CREATING. The states
406
+ # / do not get further updated once the operation is done.
407
+ # @!attribute [rw] state
408
+ # @return [::Google::Cloud::AlloyDB::V1::BatchCreateInstanceStatus::State]
409
+ # The current state of an instance involved in the batch create operation.
410
+ # Once the operation is complete, the final state of the instances in the
411
+ # LRO can be one of:
412
+ # 1. ACTIVE, indicating that instances were created successfully
413
+ # 2. FAILED, indicating that a particular instance failed creation
414
+ # 3. ROLLED_BACK indicating that although the instance was created
415
+ # successfully, it had to be rolled back and deleted due to failure in
416
+ # other steps of the workflow.
417
+ # @!attribute [rw] error_msg
418
+ # @return [::String]
419
+ # DEPRECATED - Use the error field instead.
420
+ # Error, if any error occurred and is available, during instance creation.
421
+ # @!attribute [rw] error
422
+ # @return [::Google::Rpc::Status]
423
+ # The RPC status of the instance creation operation. This field will be
424
+ # present if an error happened during the instance creation.
425
+ # @!attribute [rw] type
426
+ # @return [::Google::Cloud::AlloyDB::V1::Instance::InstanceType]
427
+ class BatchCreateInstanceStatus
428
+ include ::Google::Protobuf::MessageExts
429
+ extend ::Google::Protobuf::MessageExts::ClassMethods
430
+
431
+ # State contains all valid instance states for the BatchCreateInstances
432
+ # operation. This is mainly used for status reporting through the LRO
433
+ # metadata.
434
+ module State
435
+ # The state of the instance is unknown.
436
+ STATE_UNSPECIFIED = 0
437
+
438
+ # Instance is pending creation and has not yet been picked up for
439
+ # processsing in the backend.
440
+ PENDING_CREATE = 1
441
+
442
+ # The instance is active and running.
443
+ READY = 2
444
+
445
+ # The instance is being created.
446
+ CREATING = 3
447
+
448
+ # The instance is being deleted.
449
+ DELETING = 4
450
+
451
+ # The creation of the instance failed or a fatal error occurred during
452
+ # an operation on the instance or a batch of instances.
453
+ FAILED = 5
454
+
455
+ # The instance was created successfully, but was rolled back and deleted
456
+ # due to some other failure during BatchCreateInstances operation.
457
+ ROLLED_BACK = 6
458
+ end
459
+ end
460
+
461
+ # Message for updating a Instance
462
+ # @!attribute [rw] update_mask
463
+ # @return [::Google::Protobuf::FieldMask]
464
+ # Optional. Field mask is used to specify the fields to be overwritten in the
465
+ # Instance resource by the update.
466
+ # The fields specified in the update_mask are relative to the resource, not
467
+ # the full request. A field will be overwritten if it is in the mask. If the
468
+ # user does not provide a mask then all fields will be overwritten.
469
+ # @!attribute [rw] instance
470
+ # @return [::Google::Cloud::AlloyDB::V1::Instance]
471
+ # Required. The resource being updated
472
+ # @!attribute [rw] request_id
473
+ # @return [::String]
474
+ # Optional. An optional request ID to identify requests. Specify a unique
475
+ # request ID so that if you must retry your request, the server will know to
476
+ # ignore the request if it has already been completed. The server will
477
+ # guarantee that for at least 60 minutes since the first request.
478
+ #
479
+ # For example, consider a situation where you make an initial request and
480
+ # the request times out. If you make the request again with the same request
481
+ # ID, the server can check if original operation with the same request ID
482
+ # was received, and if so, will ignore the second request. This prevents
483
+ # clients from accidentally creating duplicate commitments.
484
+ #
485
+ # The request ID must be a valid UUID with the exception that zero UUID is
486
+ # not supported (00000000-0000-0000-0000-000000000000).
487
+ # @!attribute [rw] validate_only
488
+ # @return [::Boolean]
489
+ # Optional. If set, performs request validation (e.g. permission checks and
490
+ # any other type of validation), but do not actually execute the update
491
+ # request.
492
+ # @!attribute [rw] allow_missing
493
+ # @return [::Boolean]
494
+ # Optional. If set to true, update succeeds even if instance is not found. In
495
+ # that case, a new instance is created and `update_mask` is ignored.
496
+ class UpdateInstanceRequest
497
+ include ::Google::Protobuf::MessageExts
498
+ extend ::Google::Protobuf::MessageExts::ClassMethods
499
+ end
500
+
501
+ # Message for deleting a Instance
502
+ # @!attribute [rw] name
503
+ # @return [::String]
504
+ # Required. The name of the resource. For the required format, see the
505
+ # comment on the Instance.name field.
506
+ # @!attribute [rw] request_id
507
+ # @return [::String]
508
+ # Optional. An optional request ID to identify requests. Specify a unique
509
+ # request ID so that if you must retry your request, the server will know to
510
+ # ignore the request if it has already been completed. The server will
511
+ # guarantee that for at least 60 minutes after the first request.
512
+ #
513
+ # For example, consider a situation where you make an initial request and
514
+ # the request times out. If you make the request again with the same request
515
+ # ID, the server can check if original operation with the same request ID
516
+ # was received, and if so, will ignore the second request. This prevents
517
+ # clients from accidentally creating duplicate commitments.
518
+ #
519
+ # The request ID must be a valid UUID with the exception that zero UUID is
520
+ # not supported (00000000-0000-0000-0000-000000000000).
521
+ # @!attribute [rw] etag
522
+ # @return [::String]
523
+ # Optional. The current etag of the Instance.
524
+ # If an etag is provided and does not match the current etag of the Instance,
525
+ # deletion will be blocked and an ABORTED error will be returned.
526
+ # @!attribute [rw] validate_only
527
+ # @return [::Boolean]
528
+ # Optional. If set, performs request validation (e.g. permission checks and
529
+ # any other type of validation), but do not actually execute the delete.
530
+ class DeleteInstanceRequest
531
+ include ::Google::Protobuf::MessageExts
532
+ extend ::Google::Protobuf::MessageExts::ClassMethods
533
+ end
534
+
535
+ # Message for triggering failover on an Instance
536
+ # @!attribute [rw] name
537
+ # @return [::String]
538
+ # Required. The name of the resource. For the required format, see the
539
+ # comment on the Instance.name field.
540
+ # @!attribute [rw] request_id
541
+ # @return [::String]
542
+ # Optional. An optional request ID to identify requests. Specify a unique
543
+ # request ID so that if you must retry your request, the server will know to
544
+ # ignore the request if it has already been completed. The server will
545
+ # guarantee that for at least 60 minutes after the first request.
546
+ #
547
+ # For example, consider a situation where you make an initial request and
548
+ # the request times out. If you make the request again with the same request
549
+ # ID, the server can check if original operation with the same request ID
550
+ # was received, and if so, will ignore the second request. This prevents
551
+ # clients from accidentally creating duplicate commitments.
552
+ #
553
+ # The request ID must be a valid UUID with the exception that zero UUID is
554
+ # not supported (00000000-0000-0000-0000-000000000000).
555
+ # @!attribute [rw] validate_only
556
+ # @return [::Boolean]
557
+ # Optional. If set, performs request validation (e.g. permission checks and
558
+ # any other type of validation), but do not actually execute the failover.
559
+ class FailoverInstanceRequest
560
+ include ::Google::Protobuf::MessageExts
561
+ extend ::Google::Protobuf::MessageExts::ClassMethods
562
+ end
563
+
564
+ # @!attribute [rw] name
565
+ # @return [::String]
566
+ # Required. The name of the resource. For the required format, see the
567
+ # comment on the Instance.name field.
568
+ # @!attribute [rw] request_id
569
+ # @return [::String]
570
+ # Optional. An optional request ID to identify requests. Specify a unique
571
+ # request ID so that if you must retry your request, the server will know to
572
+ # ignore the request if it has already been completed. The server will
573
+ # guarantee that for at least 60 minutes after the first request.
574
+ #
575
+ # For example, consider a situation where you make an initial request and
576
+ # the request times out. If you make the request again with the same request
577
+ # ID, the server can check if original operation with the same request ID
578
+ # was received, and if so, will ignore the second request. This prevents
579
+ # clients from accidentally creating duplicate commitments.
580
+ #
581
+ # The request ID must be a valid UUID with the exception that zero UUID is
582
+ # not supported (00000000-0000-0000-0000-000000000000).
583
+ # @!attribute [rw] validate_only
584
+ # @return [::Boolean]
585
+ # Optional. If set, performs request validation (e.g. permission checks and
586
+ # any other type of validation), but do not actually execute the restart.
587
+ class RestartInstanceRequest
588
+ include ::Google::Protobuf::MessageExts
589
+ extend ::Google::Protobuf::MessageExts::ClassMethods
590
+ end
591
+
592
+ # Message for requesting list of Backups
593
+ # @!attribute [rw] parent
594
+ # @return [::String]
595
+ # Required. Parent value for ListBackupsRequest
596
+ # @!attribute [rw] page_size
597
+ # @return [::Integer]
598
+ # Requested page size. Server may return fewer items than requested.
599
+ # If unspecified, server will pick an appropriate default.
600
+ # @!attribute [rw] page_token
601
+ # @return [::String]
602
+ # A token identifying a page of results the server should return.
603
+ # @!attribute [rw] filter
604
+ # @return [::String]
605
+ # Filtering results
606
+ # @!attribute [rw] order_by
607
+ # @return [::String]
608
+ # Hint for how to order the results
609
+ class ListBackupsRequest
610
+ include ::Google::Protobuf::MessageExts
611
+ extend ::Google::Protobuf::MessageExts::ClassMethods
612
+ end
613
+
614
+ # Message for response to listing Backups
615
+ # @!attribute [rw] backups
616
+ # @return [::Array<::Google::Cloud::AlloyDB::V1::Backup>]
617
+ # The list of Backup
618
+ # @!attribute [rw] next_page_token
619
+ # @return [::String]
620
+ # A token identifying a page of results the server should return.
621
+ # @!attribute [rw] unreachable
622
+ # @return [::Array<::String>]
623
+ # Locations that could not be reached.
624
+ class ListBackupsResponse
625
+ include ::Google::Protobuf::MessageExts
626
+ extend ::Google::Protobuf::MessageExts::ClassMethods
627
+ end
628
+
629
+ # Message for getting a Backup
630
+ # @!attribute [rw] name
631
+ # @return [::String]
632
+ # Required. Name of the resource
633
+ class GetBackupRequest
634
+ include ::Google::Protobuf::MessageExts
635
+ extend ::Google::Protobuf::MessageExts::ClassMethods
636
+ end
637
+
638
+ # Message for creating a Backup
639
+ # @!attribute [rw] parent
640
+ # @return [::String]
641
+ # Required. Value for parent.
642
+ # @!attribute [rw] backup_id
643
+ # @return [::String]
644
+ # Required. ID of the requesting object.
645
+ # @!attribute [rw] backup
646
+ # @return [::Google::Cloud::AlloyDB::V1::Backup]
647
+ # Required. The resource being created
648
+ # @!attribute [rw] request_id
649
+ # @return [::String]
650
+ # Optional. An optional request ID to identify requests. Specify a unique
651
+ # request ID so that if you must retry your request, the server will know to
652
+ # ignore the request if it has already been completed. The server will
653
+ # guarantee that for at least 60 minutes since the first request.
654
+ #
655
+ # For example, consider a situation where you make an initial request and
656
+ # the request times out. If you make the request again with the same request
657
+ # ID, the server can check if original operation with the same request ID
658
+ # was received, and if so, will ignore the second request. This prevents
659
+ # clients from accidentally creating duplicate commitments.
660
+ #
661
+ # The request ID must be a valid UUID with the exception that zero UUID is
662
+ # not supported (00000000-0000-0000-0000-000000000000).
663
+ # @!attribute [rw] validate_only
664
+ # @return [::Boolean]
665
+ # Optional. If set, the backend validates the request, but doesn't actually
666
+ # execute it.
667
+ class CreateBackupRequest
668
+ include ::Google::Protobuf::MessageExts
669
+ extend ::Google::Protobuf::MessageExts::ClassMethods
670
+ end
671
+
672
+ # Message for updating a Backup
673
+ # @!attribute [rw] update_mask
674
+ # @return [::Google::Protobuf::FieldMask]
675
+ # Optional. Field mask is used to specify the fields to be overwritten in the
676
+ # Backup resource by the update.
677
+ # The fields specified in the update_mask are relative to the resource, not
678
+ # the full request. A field will be overwritten if it is in the mask. If the
679
+ # user does not provide a mask then all fields will be overwritten.
680
+ # @!attribute [rw] backup
681
+ # @return [::Google::Cloud::AlloyDB::V1::Backup]
682
+ # Required. The resource being updated
683
+ # @!attribute [rw] request_id
684
+ # @return [::String]
685
+ # Optional. An optional request ID to identify requests. Specify a unique
686
+ # request ID so that if you must retry your request, the server will know to
687
+ # ignore the request if it has already been completed. The server will
688
+ # guarantee that for at least 60 minutes since the first request.
689
+ #
690
+ # For example, consider a situation where you make an initial request and
691
+ # the request times out. If you make the request again with the same request
692
+ # ID, the server can check if original operation with the same request ID
693
+ # was received, and if so, will ignore the second request. This prevents
694
+ # clients from accidentally creating duplicate commitments.
695
+ #
696
+ # The request ID must be a valid UUID with the exception that zero UUID is
697
+ # not supported (00000000-0000-0000-0000-000000000000).
698
+ # @!attribute [rw] validate_only
699
+ # @return [::Boolean]
700
+ # Optional. If set, the backend validates the request, but doesn't actually
701
+ # execute it.
702
+ # @!attribute [rw] allow_missing
703
+ # @return [::Boolean]
704
+ # Optional. If set to true, update succeeds even if instance is not found. In
705
+ # that case, a new backup is created and `update_mask` is ignored.
706
+ class UpdateBackupRequest
707
+ include ::Google::Protobuf::MessageExts
708
+ extend ::Google::Protobuf::MessageExts::ClassMethods
709
+ end
710
+
711
+ # Message for deleting a Backup
712
+ # @!attribute [rw] name
713
+ # @return [::String]
714
+ # Required. Name of the resource. For the required format, see the comment on
715
+ # the Backup.name field.
716
+ # @!attribute [rw] request_id
717
+ # @return [::String]
718
+ # Optional. An optional request ID to identify requests. Specify a unique
719
+ # request ID so that if you must retry your request, the server will know to
720
+ # ignore the request if it has already been completed. The server will
721
+ # guarantee that for at least 60 minutes after the first request.
722
+ #
723
+ # For example, consider a situation where you make an initial request and
724
+ # the request times out. If you make the request again with the same request
725
+ # ID, the server can check if original operation with the same request ID
726
+ # was received, and if so, will ignore the second request. This prevents
727
+ # clients from accidentally creating duplicate commitments.
728
+ #
729
+ # The request ID must be a valid UUID with the exception that zero UUID is
730
+ # not supported (00000000-0000-0000-0000-000000000000).
731
+ # @!attribute [rw] validate_only
732
+ # @return [::Boolean]
733
+ # Optional. If set, the backend validates the request, but doesn't actually
734
+ # execute it.
735
+ # @!attribute [rw] etag
736
+ # @return [::String]
737
+ # Optional. The current etag of the Backup.
738
+ # If an etag is provided and does not match the current etag of the Backup,
739
+ # deletion will be blocked and an ABORTED error will be returned.
740
+ class DeleteBackupRequest
741
+ include ::Google::Protobuf::MessageExts
742
+ extend ::Google::Protobuf::MessageExts::ClassMethods
743
+ end
744
+
745
+ # Message for listing the information about the supported Database flags.
746
+ # @!attribute [rw] parent
747
+ # @return [::String]
748
+ # Required. The name of the parent resource. The required format is:
749
+ # * projects/\\{project}/locations/\\{location}
750
+ #
751
+ # Regardless of the parent specified here, as long it is contains a valid
752
+ # project and location, the service will return a static list of supported
753
+ # flags resources. Note that we do not yet support region-specific
754
+ # flags.
755
+ # @!attribute [rw] page_size
756
+ # @return [::Integer]
757
+ # Requested page size. Server may return fewer items than requested.
758
+ # If unspecified, server will pick an appropriate default.
759
+ # @!attribute [rw] page_token
760
+ # @return [::String]
761
+ # A token identifying a page of results the server should return.
762
+ class ListSupportedDatabaseFlagsRequest
763
+ include ::Google::Protobuf::MessageExts
764
+ extend ::Google::Protobuf::MessageExts::ClassMethods
765
+ end
766
+
767
+ # Message for response to listing SupportedDatabaseFlags.
768
+ # @!attribute [rw] supported_database_flags
769
+ # @return [::Array<::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag>]
770
+ # The list of SupportedDatabaseFlags.
771
+ # @!attribute [rw] next_page_token
772
+ # @return [::String]
773
+ # A token identifying a page of results the server should return.
774
+ class ListSupportedDatabaseFlagsResponse
775
+ include ::Google::Protobuf::MessageExts
776
+ extend ::Google::Protobuf::MessageExts::ClassMethods
777
+ end
778
+
779
+ # Represents the metadata of the long-running operation.
780
+ # @!attribute [r] batch_create_instances_metadata
781
+ # @return [::Google::Cloud::AlloyDB::V1::BatchCreateInstancesMetadata]
782
+ # Output only. BatchCreateInstances related metadata.
783
+ # @!attribute [r] create_time
784
+ # @return [::Google::Protobuf::Timestamp]
785
+ # Output only. The time the operation was created.
786
+ # @!attribute [r] end_time
787
+ # @return [::Google::Protobuf::Timestamp]
788
+ # Output only. The time the operation finished running.
789
+ # @!attribute [r] target
790
+ # @return [::String]
791
+ # Output only. Server-defined resource path for the target of the operation.
792
+ # @!attribute [r] verb
793
+ # @return [::String]
794
+ # Output only. Name of the verb executed by the operation.
795
+ # @!attribute [r] status_message
796
+ # @return [::String]
797
+ # Output only. Human-readable status of the operation, if any.
798
+ # @!attribute [r] requested_cancellation
799
+ # @return [::Boolean]
800
+ # Output only. Identifies whether the user has requested cancellation
801
+ # of the operation. Operations that have successfully been cancelled
802
+ # have [Operation.error][] value with a
803
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
804
+ # `Code.CANCELLED`.
805
+ # @!attribute [r] api_version
806
+ # @return [::String]
807
+ # Output only. API version used to start the operation.
808
+ class OperationMetadata
809
+ include ::Google::Protobuf::MessageExts
810
+ extend ::Google::Protobuf::MessageExts::ClassMethods
811
+ end
812
+ end
813
+ end
814
+ end
815
+ end