-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
alloydb_v1.projects.locations.clusters.html
1137 lines (1068 loc) 路 124 KB
/
alloydb_v1.projects.locations.clusters.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="alloydb_v1.html">AlloyDB API</a> . <a href="alloydb_v1.projects.html">projects</a> . <a href="alloydb_v1.projects.locations.html">locations</a> . <a href="alloydb_v1.projects.locations.clusters.html">clusters</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="alloydb_v1.projects.locations.clusters.instances.html">instances()</a></code>
</p>
<p class="firstline">Returns the instances Resource.</p>
<p class="toc_element">
<code><a href="alloydb_v1.projects.locations.clusters.users.html">users()</a></code>
</p>
<p class="firstline">Returns the users Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, clusterId=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Cluster in a given project and location.</p>
<p class="toc_element">
<code><a href="#createsecondary">createsecondary(parent, body=None, clusterId=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, etag=None, force=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single Cluster.</p>
<p class="toc_element">
<code><a href="#generateClientCertificate">generateClientCertificate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.</p>
<p class="toc_element">
<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Cluster.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Clusters in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single Cluster.</p>
<p class="toc_element">
<code><a href="#promote">promote(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.</p>
<p class="toc_element">
<code><a href="#restore">restore(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, clusterId=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Creates a new Cluster in a given project and location.
Args:
parent: string, Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field. (required)
body: object, The request body.
The object takes the form of:
{ # A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"automatedBackupPolicy": { # Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set. # The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
"backupWindow": "A String", # The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
"enabled": True or False, # Whether automated automated backups are enabled. If not set, defaults to true.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"labels": { # Labels to apply to backups created using this configuration.
"a_key": "A String",
},
"location": "A String", # The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
"quantityBasedRetention": { # A quantity based policy specifies that a certain number of the most recent successful backups should be retained. # Quantity-based Backup retention policy to retain recent backups.
"count": 42, # The number of backups to retain.
},
"timeBasedRetention": { # A time based retention policy specifies that all backups within a certain time period should be retained. # Time-based Backup retention policy.
"retentionPeriod": "A String", # The retention period.
},
"weeklySchedule": { # A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week. The weekly schedule message is flexible and can be used to create many types of schedules. For example, to have a daily backup that starts at 22:00, configure the `start_times` field to have one element "22:00" and the `days_of_week` field to have all seven days of the week. # Weekly schedule for the Backup.
"daysOfWeek": [ # The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
"A String",
],
"startTimes": [ # The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
{ # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
},
],
},
},
"backupSource": { # Message describing a BackupSource. # Output only. Cluster created from backup.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
"continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster.
"enabled": True or False, # Whether ContinuousBackup is enabled.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
"earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Cluster.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the cluster.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
"password": "A String", # The initial password for the user.
"user": "A String", # The database username.
},
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
"sourceType": "A String", # Output only. Type of migration source.
},
"name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
"network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.
"networkConfig": { # Metadata related to network configuration.
"allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.
"network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster.
},
"primaryConfig": { # Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY. # Output only. Cross Region replication config specific to PRIMARY cluster.
"secondaryClusterNames": [ # Output only. Names of the clusters that are replicating from this cluster.
"A String",
],
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster.
"primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
},
"sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
"state": "A String", # Output only. The current serving state of the cluster.
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updateTime": "A String", # Output only. Update time stamp
}
clusterId: string, Required. ID of the requesting object.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="createsecondary">createsecondary(parent, body=None, clusterId=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
Args:
parent: string, Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field. (required)
body: object, The request body.
The object takes the form of:
{ # A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"automatedBackupPolicy": { # Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set. # The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
"backupWindow": "A String", # The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
"enabled": True or False, # Whether automated automated backups are enabled. If not set, defaults to true.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"labels": { # Labels to apply to backups created using this configuration.
"a_key": "A String",
},
"location": "A String", # The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
"quantityBasedRetention": { # A quantity based policy specifies that a certain number of the most recent successful backups should be retained. # Quantity-based Backup retention policy to retain recent backups.
"count": 42, # The number of backups to retain.
},
"timeBasedRetention": { # A time based retention policy specifies that all backups within a certain time period should be retained. # Time-based Backup retention policy.
"retentionPeriod": "A String", # The retention period.
},
"weeklySchedule": { # A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week. The weekly schedule message is flexible and can be used to create many types of schedules. For example, to have a daily backup that starts at 22:00, configure the `start_times` field to have one element "22:00" and the `days_of_week` field to have all seven days of the week. # Weekly schedule for the Backup.
"daysOfWeek": [ # The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
"A String",
],
"startTimes": [ # The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
{ # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
},
],
},
},
"backupSource": { # Message describing a BackupSource. # Output only. Cluster created from backup.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
"continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster.
"enabled": True or False, # Whether ContinuousBackup is enabled.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
"earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Cluster.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the cluster.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
"password": "A String", # The initial password for the user.
"user": "A String", # The database username.
},
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
"sourceType": "A String", # Output only. Type of migration source.
},
"name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
"network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.
"networkConfig": { # Metadata related to network configuration.
"allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.
"network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster.
},
"primaryConfig": { # Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY. # Output only. Cross Region replication config specific to PRIMARY cluster.
"secondaryClusterNames": [ # Output only. Names of the clusters that are replicating from this cluster.
"A String",
],
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster.
"primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
},
"sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
"state": "A String", # Output only. The current serving state of the cluster.
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updateTime": "A String", # Output only. Update time stamp
}
clusterId: string, Required. ID of the requesting object (the secondary cluster).
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, etag=None, force=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Deletes a single Cluster.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Cluster.name field. (required)
etag: string, Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.
force: boolean, Optional. Whether to cascade delete child instances for given cluster.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="generateClientCertificate">generateClientCertificate(parent, body=None, x__xgafv=None)</code>
<pre>Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.
Args:
parent: string, Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location}/clusters/{cluster} (required)
body: object, The request body.
The object takes the form of:
{ # Message for requests to generate a client certificate signed by the Cluster CA.
"certDuration": "A String", # Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration.
"publicKey": "A String", # Optional. The public key from the client.
"requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
"useMetadataExchange": True or False, # Optional. An optional hint to the endpoint to generate a client ceritificate that can be used by AlloyDB connectors to exchange additional metadata with the server after TLS handshake.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message returned by a GenerateClientCertificate operation.
"caCert": "A String", # Optional. The pem-encoded cluster ca X.509 certificate.
"pemCertificateChain": [ # Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
<pre>Gets details of a single Cluster.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Cluster.name field. (required)
view: string, Optional. The view of the cluster to return. Returns all default fields if not set.
Allowed values
CLUSTER_VIEW_UNSPECIFIED - CLUSTER_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
CLUSTER_VIEW_BASIC - BASIC server responses include all the relevant cluster details, excluding Cluster.ContinuousBackupInfo.EarliestRestorableTime and other view-specific fields. The default value.
CLUSTER_VIEW_CONTINUOUS_BACKUP - CONTINUOUS_BACKUP response returns all the fields from BASIC plus the earliest restorable time if continuous backups are enabled. May increase latency.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"automatedBackupPolicy": { # Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set. # The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
"backupWindow": "A String", # The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
"enabled": True or False, # Whether automated automated backups are enabled. If not set, defaults to true.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"labels": { # Labels to apply to backups created using this configuration.
"a_key": "A String",
},
"location": "A String", # The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
"quantityBasedRetention": { # A quantity based policy specifies that a certain number of the most recent successful backups should be retained. # Quantity-based Backup retention policy to retain recent backups.
"count": 42, # The number of backups to retain.
},
"timeBasedRetention": { # A time based retention policy specifies that all backups within a certain time period should be retained. # Time-based Backup retention policy.
"retentionPeriod": "A String", # The retention period.
},
"weeklySchedule": { # A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week. The weekly schedule message is flexible and can be used to create many types of schedules. For example, to have a daily backup that starts at 22:00, configure the `start_times` field to have one element "22:00" and the `days_of_week` field to have all seven days of the week. # Weekly schedule for the Backup.
"daysOfWeek": [ # The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
"A String",
],
"startTimes": [ # The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
{ # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
},
],
},
},
"backupSource": { # Message describing a BackupSource. # Output only. Cluster created from backup.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
"continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster.
"enabled": True or False, # Whether ContinuousBackup is enabled.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
"earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Cluster.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the cluster.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
"password": "A String", # The initial password for the user.
"user": "A String", # The database username.
},
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
"sourceType": "A String", # Output only. Type of migration source.
},
"name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
"network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.
"networkConfig": { # Metadata related to network configuration.
"allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.
"network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster.
},
"primaryConfig": { # Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY. # Output only. Cross Region replication config specific to PRIMARY cluster.
"secondaryClusterNames": [ # Output only. Names of the clusters that are replicating from this cluster.
"A String",
],
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster.
"primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
},
"sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
"state": "A String", # Output only. The current serving state of the cluster.
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updateTime": "A String", # Output only. Update time stamp
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Clusters in a given project and location.
Args:
parent: string, Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/- (required)
filter: string, Optional. Filtering results
orderBy: string, Optional. Hint for how to order the results
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing Clusters
"clusters": [ # The list of Cluster
{ # A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"automatedBackupPolicy": { # Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set. # The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
"backupWindow": "A String", # The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
"enabled": True or False, # Whether automated automated backups are enabled. If not set, defaults to true.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"labels": { # Labels to apply to backups created using this configuration.
"a_key": "A String",
},
"location": "A String", # The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
"quantityBasedRetention": { # A quantity based policy specifies that a certain number of the most recent successful backups should be retained. # Quantity-based Backup retention policy to retain recent backups.
"count": 42, # The number of backups to retain.
},
"timeBasedRetention": { # A time based retention policy specifies that all backups within a certain time period should be retained. # Time-based Backup retention policy.
"retentionPeriod": "A String", # The retention period.
},
"weeklySchedule": { # A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week. The weekly schedule message is flexible and can be used to create many types of schedules. For example, to have a daily backup that starts at 22:00, configure the `start_times` field to have one element "22:00" and the `days_of_week` field to have all seven days of the week. # Weekly schedule for the Backup.
"daysOfWeek": [ # The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
"A String",
],
"startTimes": [ # The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
{ # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
},
],
},
},
"backupSource": { # Message describing a BackupSource. # Output only. Cluster created from backup.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
"continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster.
"enabled": True or False, # Whether ContinuousBackup is enabled.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
"earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Cluster.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the cluster.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
"password": "A String", # The initial password for the user.
"user": "A String", # The database username.
},
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
"sourceType": "A String", # Output only. Type of migration source.
},
"name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
"network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.
"networkConfig": { # Metadata related to network configuration.
"allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.
"network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster.
},
"primaryConfig": { # Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY. # Output only. Cross Region replication config specific to PRIMARY cluster.
"secondaryClusterNames": [ # Output only. Names of the clusters that are replicating from this cluster.
"A String",
],
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster.
"primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
},
"sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
"state": "A String", # Output only. The current serving state of the cluster.
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updateTime": "A String", # Output only. Update time stamp
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>
<pre>Updates the parameters of a single Cluster.
Args:
name: string, Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} (required)
body: object, The request body.
The object takes the form of:
{ # A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"automatedBackupPolicy": { # Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set. # The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
"backupWindow": "A String", # The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
"enabled": True or False, # Whether automated automated backups are enabled. If not set, defaults to true.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"labels": { # Labels to apply to backups created using this configuration.
"a_key": "A String",
},
"location": "A String", # The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
"quantityBasedRetention": { # A quantity based policy specifies that a certain number of the most recent successful backups should be retained. # Quantity-based Backup retention policy to retain recent backups.
"count": 42, # The number of backups to retain.
},
"timeBasedRetention": { # A time based retention policy specifies that all backups within a certain time period should be retained. # Time-based Backup retention policy.
"retentionPeriod": "A String", # The retention period.
},
"weeklySchedule": { # A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week. The weekly schedule message is flexible and can be used to create many types of schedules. For example, to have a daily backup that starts at 22:00, configure the `start_times` field to have one element "22:00" and the `days_of_week` field to have all seven days of the week. # Weekly schedule for the Backup.
"daysOfWeek": [ # The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
"A String",
],
"startTimes": [ # The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
{ # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
"seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
},
],
},
},
"backupSource": { # Message describing a BackupSource. # Output only. Cluster created from backup.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
"continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster.
"enabled": True or False, # Whether ContinuousBackup is enabled.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
"earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
"A String",
],
},
"createTime": "A String", # Output only. Create time stamp
"databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Cluster.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the cluster.
"encryptionType": "A String", # Output only. Type of encryption.
"kmsKeyVersions": [ # Output only. Cloud KMS key versions that are being used to protect the database or the backup.
"A String",
],
},
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"initialUser": { # The username/password for a database user. Used for specifying initial users at cluster creation time. # Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
"password": "A String", # The initial password for the user.
"user": "A String", # The database username.
},
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
"sourceType": "A String", # Output only. Type of migration source.
},
"name": "A String", # Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
"network": "A String", # Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.
"networkConfig": { # Metadata related to network configuration.
"allocatedIpRange": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.
"network": "A String", # Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number}/global/networks/{network_id}`. This is required to create a cluster.
},
"primaryConfig": { # Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY. # Output only. Cross Region replication config specific to PRIMARY cluster.
"secondaryClusterNames": [ # Output only. Names of the clusters that are replicating from this cluster.
"A String",
],
},
"reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster.
"primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
},
"sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
"state": "A String", # Output only. The current serving state of the cluster.
"uid": "A String", # Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
"updateTime": "A String", # Output only. Update time stamp
}
allowMissing: boolean, Optional. If set to true, update succeeds even if cluster is not found. In that case, a new cluster is created and `update_mask` is ignored.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
validateOnly: boolean, Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="promote">promote(name, body=None, x__xgafv=None)</code>
<pre>Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Cluster.name field (required)
body: object, The request body.
The object takes the form of:
{ # Message for promoting a Cluster
"etag": "A String", # Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.
"requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
"validateOnly": True or False, # Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="restore">restore(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.
Args:
parent: string, Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. (required)
body: object, The request body.
The object takes the form of:
{ # Message for restoring a Cluster from a backup or another cluster at a given point in time.
"backupSource": { # Message describing a BackupSource. # Backup source.
"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
"backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
},
"cluster": { # A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed. # Required. The resource being created
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"automatedBackupPolicy": { # Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set. # The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
"backupWindow": "A String", # The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
"enabled": True or False, # Whether automated automated backups are enabled. If not set, defaults to true.
"encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
"kmsKeyName": "A String", # The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
},
"labels": { # Labels to apply to backups created using this configuration.