-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
alloydb-gen.go
7944 lines (7412 loc) · 332 KB
/
alloydb-gen.go
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
// Copyright 2024 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package alloydb provides access to the AlloyDB API.
//
// For product documentation, see: https://cloud.google.com/alloydb/
//
// # Library status
//
// These client libraries are officially supported by Google. However, this
// library is considered complete and is in maintenance mode. This means
// that we will address critical bugs and security issues but will not add
// any new features.
//
// When possible, we recommend using our newer
// [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)
// that are still actively being worked and iterated on.
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/alloydb/v1"
// ...
// ctx := context.Background()
// alloydbService, err := alloydb.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for
// authentication. For information on how to create and obtain Application
// Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// # Other authentication options
//
// To use an API key for authentication (note: some APIs do not support API
// keys), use [google.golang.org/api/option.WithAPIKey]:
//
// alloydbService, err := alloydb.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth
// flow, use [google.golang.org/api/option.WithTokenSource]:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// alloydbService, err := alloydb.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package alloydb // import "google.golang.org/api/alloydb/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
var _ = internal.Version
const apiId = "alloydb:v1"
const apiName = "alloydb"
const apiVersion = "v1"
const basePath = "https://alloydb.googleapis.com/"
const basePathTemplate = "https://alloydb.UNIVERSE_DOMAIN/"
const mtlsBasePath = "https://alloydb.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the email
// address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/cloud-platform",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
opts = append(opts, internaloption.EnableNewAuthLibrary())
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Projects = NewProjectsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Projects *ProjectsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewProjectsService(s *Service) *ProjectsService {
rs := &ProjectsService{s: s}
rs.Locations = NewProjectsLocationsService(s)
return rs
}
type ProjectsService struct {
s *Service
Locations *ProjectsLocationsService
}
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService {
rs := &ProjectsLocationsService{s: s}
rs.Backups = NewProjectsLocationsBackupsService(s)
rs.Clusters = NewProjectsLocationsClustersService(s)
rs.Operations = NewProjectsLocationsOperationsService(s)
rs.SupportedDatabaseFlags = NewProjectsLocationsSupportedDatabaseFlagsService(s)
return rs
}
type ProjectsLocationsService struct {
s *Service
Backups *ProjectsLocationsBackupsService
Clusters *ProjectsLocationsClustersService
Operations *ProjectsLocationsOperationsService
SupportedDatabaseFlags *ProjectsLocationsSupportedDatabaseFlagsService
}
func NewProjectsLocationsBackupsService(s *Service) *ProjectsLocationsBackupsService {
rs := &ProjectsLocationsBackupsService{s: s}
return rs
}
type ProjectsLocationsBackupsService struct {
s *Service
}
func NewProjectsLocationsClustersService(s *Service) *ProjectsLocationsClustersService {
rs := &ProjectsLocationsClustersService{s: s}
rs.Instances = NewProjectsLocationsClustersInstancesService(s)
rs.Users = NewProjectsLocationsClustersUsersService(s)
return rs
}
type ProjectsLocationsClustersService struct {
s *Service
Instances *ProjectsLocationsClustersInstancesService
Users *ProjectsLocationsClustersUsersService
}
func NewProjectsLocationsClustersInstancesService(s *Service) *ProjectsLocationsClustersInstancesService {
rs := &ProjectsLocationsClustersInstancesService{s: s}
return rs
}
type ProjectsLocationsClustersInstancesService struct {
s *Service
}
func NewProjectsLocationsClustersUsersService(s *Service) *ProjectsLocationsClustersUsersService {
rs := &ProjectsLocationsClustersUsersService{s: s}
return rs
}
type ProjectsLocationsClustersUsersService struct {
s *Service
}
func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService {
rs := &ProjectsLocationsOperationsService{s: s}
return rs
}
type ProjectsLocationsOperationsService struct {
s *Service
}
func NewProjectsLocationsSupportedDatabaseFlagsService(s *Service) *ProjectsLocationsSupportedDatabaseFlagsService {
rs := &ProjectsLocationsSupportedDatabaseFlagsService{s: s}
return rs
}
type ProjectsLocationsSupportedDatabaseFlagsService struct {
s *Service
}
// AuthorizedNetwork: AuthorizedNetwork contains metadata for an authorized
// network.
type AuthorizedNetwork struct {
// CidrRange: CIDR range for one authorzied network of the instance.
CidrRange string `json:"cidrRange,omitempty"`
// ForceSendFields is a list of field names (e.g. "CidrRange") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CidrRange") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AuthorizedNetwork) MarshalJSON() ([]byte, error) {
type NoMethod AuthorizedNetwork
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// 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.
type AutomatedBackupPolicy struct {
// BackupWindow: 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.
BackupWindow string `json:"backupWindow,omitempty"`
// Enabled: Whether automated automated backups are enabled. If not set,
// defaults to true.
Enabled bool `json:"enabled,omitempty"`
// EncryptionConfig: 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.
EncryptionConfig *EncryptionConfig `json:"encryptionConfig,omitempty"`
// Labels: Labels to apply to backups created using this configuration.
Labels map[string]string `json:"labels,omitempty"`
// Location: 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.
Location string `json:"location,omitempty"`
// QuantityBasedRetention: Quantity-based Backup retention policy to retain
// recent backups.
QuantityBasedRetention *QuantityBasedRetention `json:"quantityBasedRetention,omitempty"`
// TimeBasedRetention: Time-based Backup retention policy.
TimeBasedRetention *TimeBasedRetention `json:"timeBasedRetention,omitempty"`
// WeeklySchedule: Weekly schedule for the Backup.
WeeklySchedule *WeeklySchedule `json:"weeklySchedule,omitempty"`
// ForceSendFields is a list of field names (e.g. "BackupWindow") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "BackupWindow") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AutomatedBackupPolicy) MarshalJSON() ([]byte, error) {
type NoMethod AutomatedBackupPolicy
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Backup: Message describing Backup object
type Backup struct {
// Annotations: Annotations to allow client tools to store small amount of
// arbitrary data. This is distinct from labels. https://google.aip.dev/128
Annotations map[string]string `json:"annotations,omitempty"`
// ClusterName: Required. The full resource name of the backup source cluster
// (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
ClusterName string `json:"clusterName,omitempty"`
// ClusterUid: Output only. The system-generated UID of the cluster which was
// used to create this resource.
ClusterUid string `json:"clusterUid,omitempty"`
// CreateTime: Output only. Create time stamp
CreateTime string `json:"createTime,omitempty"`
// DatabaseVersion: Output only. The database engine major version of the
// cluster this backup was created from. Any restored cluster created from this
// backup will have the same database version.
//
// Possible values:
// "DATABASE_VERSION_UNSPECIFIED" - This is an unknown database version.
// "POSTGRES_13" - DEPRECATED - The database version is Postgres 13.
// "POSTGRES_14" - The database version is Postgres 14.
// "POSTGRES_15" - The database version is Postgres 15.
DatabaseVersion string `json:"databaseVersion,omitempty"`
// DeleteTime: Output only. Delete time stamp
DeleteTime string `json:"deleteTime,omitempty"`
// Description: User-provided description of the backup.
Description string `json:"description,omitempty"`
// DisplayName: User-settable and human-readable display name for the Backup.
DisplayName string `json:"displayName,omitempty"`
// EncryptionConfig: Optional. The encryption config can be specified to
// encrypt the backup 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.
EncryptionConfig *EncryptionConfig `json:"encryptionConfig,omitempty"`
// EncryptionInfo: Output only. The encryption information for the backup.
EncryptionInfo *EncryptionInfo `json:"encryptionInfo,omitempty"`
// Etag: For Resource freshness validation (https://google.aip.dev/154)
Etag string `json:"etag,omitempty"`
// ExpiryQuantity: Output only. The QuantityBasedExpiry of the backup,
// specified by the backup's retention policy. Once the expiry quantity is over
// retention, the backup is eligible to be garbage collected.
ExpiryQuantity *QuantityBasedExpiry `json:"expiryQuantity,omitempty"`
// ExpiryTime: Output only. The time at which after the backup is eligible to
// be garbage collected. It is the duration specified by the backup's retention
// policy, added to the backup's create_time.
ExpiryTime string `json:"expiryTime,omitempty"`
// Labels: Labels as key value pairs
Labels map[string]string `json:"labels,omitempty"`
// Name: Output only. The name of the backup resource with the format: *
// projects/{project}/locations/{region}/backups/{backup_id} where the cluster
// and backup ID segments should satisfy the regex expression
// `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase
// letters, numbers, and dashes, starting with a letter, and ending with a
// letter or number. For more details see https://google.aip.dev/122. The
// prefix of the backup resource name is the name of the parent resource: *
// projects/{project}/locations/{region}
Name string `json:"name,omitempty"`
// Reconciling: Output only. Reconciling
// (https://google.aip.dev/128#reconciliation), if true, indicates that the
// service is actively updating the resource. This can happen due to
// user-triggered updates or system actions like failover or maintenance.
Reconciling bool `json:"reconciling,omitempty"`
// SatisfiesPzs: Output only. Reserved for future use.
SatisfiesPzs bool `json:"satisfiesPzs,omitempty"`
// SizeBytes: Output only. The size of the backup in bytes.
SizeBytes int64 `json:"sizeBytes,omitempty,string"`
// State: Output only. The current state of the backup.
//
// Possible values:
// "STATE_UNSPECIFIED" - The state of the backup is unknown.
// "READY" - The backup is ready.
// "CREATING" - The backup is creating.
// "FAILED" - The backup failed.
// "DELETING" - The backup is being deleted.
State string `json:"state,omitempty"`
// Type: The backup type, which suggests the trigger for the backup.
//
// Possible values:
// "TYPE_UNSPECIFIED" - Backup Type is unknown.
// "ON_DEMAND" - ON_DEMAND backups that were triggered by the customer (e.g.,
// not AUTOMATED).
// "AUTOMATED" - AUTOMATED backups triggered by the automated backups
// scheduler pursuant to an automated backup policy.
// "CONTINUOUS" - CONTINUOUS backups triggered by the automated backups
// scheduler due to a continuous backup policy.
Type string `json:"type,omitempty"`
// Uid: 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.
Uid string `json:"uid,omitempty"`
// UpdateTime: Output only. Update time stamp
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Annotations") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Annotations") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Backup) MarshalJSON() ([]byte, error) {
type NoMethod Backup
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// BackupSource: Message describing a BackupSource.
type BackupSource struct {
// BackupName: Required. The name of the backup resource with the format: *
// projects/{project}/locations/{region}/backups/{backup_id}
BackupName string `json:"backupName,omitempty"`
// BackupUid: 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.
BackupUid string `json:"backupUid,omitempty"`
// ForceSendFields is a list of field names (e.g. "BackupName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "BackupName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BackupSource) MarshalJSON() ([]byte, error) {
type NoMethod BackupSource
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// CancelOperationRequest: The request message for Operations.CancelOperation.
type CancelOperationRequest struct {
}
// ClientConnectionConfig: Client connection configuration
type ClientConnectionConfig struct {
// RequireConnectors: Optional. Configuration to enforce connectors only (ex:
// AuthProxy) connections to the database.
RequireConnectors bool `json:"requireConnectors,omitempty"`
// SslConfig: Optional. SSL config option for this instance.
SslConfig *SslConfig `json:"sslConfig,omitempty"`
// ForceSendFields is a list of field names (e.g. "RequireConnectors") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "RequireConnectors") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ClientConnectionConfig) MarshalJSON() ([]byte, error) {
type NoMethod ClientConnectionConfig
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// CloudControl2SharedOperationsReconciliationOperationMetadata: Operation
// metadata returned by the CLH during resource state reconciliation.
type CloudControl2SharedOperationsReconciliationOperationMetadata struct {
// DeleteResource: DEPRECATED. Use exclusive_action instead.
DeleteResource bool `json:"deleteResource,omitempty"`
// ExclusiveAction: Excluisive action returned by the CLH.
//
// Possible values:
// "UNKNOWN_REPAIR_ACTION" - Unknown repair action.
// "DELETE" - The resource has to be deleted. When using this bit, the CLH
// should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE
// OperationSignal in SideChannel.
// "RETRY" - This resource could not be repaired but the repair should be
// tried again at a later time. This can happen if there is a dependency that
// needs to be resolved first- e.g. if a parent resource must be repaired
// before a child resource.
ExclusiveAction string `json:"exclusiveAction,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeleteResource") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeleteResource") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CloudControl2SharedOperationsReconciliationOperationMetadata) MarshalJSON() ([]byte, error) {
type NoMethod CloudControl2SharedOperationsReconciliationOperationMetadata
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// 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.
type Cluster struct {
// Annotations: Annotations to allow client tools to store small amount of
// arbitrary data. This is distinct from labels. https://google.aip.dev/128
Annotations map[string]string `json:"annotations,omitempty"`
// AutomatedBackupPolicy: 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.
AutomatedBackupPolicy *AutomatedBackupPolicy `json:"automatedBackupPolicy,omitempty"`
// BackupSource: Output only. Cluster created from backup.
BackupSource *BackupSource `json:"backupSource,omitempty"`
// ClusterType: 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`
//
// Possible values:
// "CLUSTER_TYPE_UNSPECIFIED" - The type of the cluster is unknown.
// "PRIMARY" - Primary cluster that support read and write operations.
// "SECONDARY" - Secondary cluster that is replicating from another region.
// This only supports read.
ClusterType string `json:"clusterType,omitempty"`
// ContinuousBackupConfig: Optional. Continuous backup configuration for this
// cluster.
ContinuousBackupConfig *ContinuousBackupConfig `json:"continuousBackupConfig,omitempty"`
// ContinuousBackupInfo: Output only. Continuous backup properties for this
// cluster.
ContinuousBackupInfo *ContinuousBackupInfo `json:"continuousBackupInfo,omitempty"`
// CreateTime: Output only. Create time stamp
CreateTime string `json:"createTime,omitempty"`
// DatabaseVersion: 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.
//
// Possible values:
// "DATABASE_VERSION_UNSPECIFIED" - This is an unknown database version.
// "POSTGRES_13" - DEPRECATED - The database version is Postgres 13.
// "POSTGRES_14" - The database version is Postgres 14.
// "POSTGRES_15" - The database version is Postgres 15.
DatabaseVersion string `json:"databaseVersion,omitempty"`
// DeleteTime: Output only. Delete time stamp
DeleteTime string `json:"deleteTime,omitempty"`
// DisplayName: User-settable and human-readable display name for the Cluster.
DisplayName string `json:"displayName,omitempty"`
// EncryptionConfig: 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.
EncryptionConfig *EncryptionConfig `json:"encryptionConfig,omitempty"`
// EncryptionInfo: Output only. The encryption information for the cluster.
EncryptionInfo *EncryptionInfo `json:"encryptionInfo,omitempty"`
// Etag: For Resource freshness validation (https://google.aip.dev/154)
Etag string `json:"etag,omitempty"`
// InitialUser: Input only. Initial user to setup during cluster creation.
// Required. If used in `RestoreCluster` this is ignored.
InitialUser *UserPassword `json:"initialUser,omitempty"`
// Labels: Labels as key value pairs
Labels map[string]string `json:"labels,omitempty"`
// MaintenanceSchedule: Output only. The maintenance schedule for the cluster,
// generated for a specific rollout if a maintenance window is set.
MaintenanceSchedule *MaintenanceSchedule `json:"maintenanceSchedule,omitempty"`
// MaintenanceUpdatePolicy: Optional. The maintenance update policy determines
// when to allow or deny updates.
MaintenanceUpdatePolicy *MaintenanceUpdatePolicy `json:"maintenanceUpdatePolicy,omitempty"`
// MigrationSource: Output only. Cluster created via DMS migration.
MigrationSource *MigrationSource `json:"migrationSource,omitempty"`
// Name: 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}
Name string `json:"name,omitempty"`
// Network: 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.
Network string `json:"network,omitempty"`
NetworkConfig *NetworkConfig `json:"networkConfig,omitempty"`
// PrimaryConfig: Output only. Cross Region replication config specific to
// PRIMARY cluster.
PrimaryConfig *PrimaryConfig `json:"primaryConfig,omitempty"`
// PscConfig: Optional. The configuration for Private Service Connect (PSC) for
// the cluster.
PscConfig *PscConfig `json:"pscConfig,omitempty"`
// Reconciling: 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.
Reconciling bool `json:"reconciling,omitempty"`
// SatisfiesPzs: Output only. Reserved for future use.
SatisfiesPzs bool `json:"satisfiesPzs,omitempty"`
// SecondaryConfig: Cross Region replication config specific to SECONDARY
// cluster.
SecondaryConfig *SecondaryConfig `json:"secondaryConfig,omitempty"`
// SslConfig: SSL configuration for this AlloyDB cluster.
SslConfig *SslConfig `json:"sslConfig,omitempty"`
// State: Output only. The current serving state of the cluster.
//
// Possible values:
// "STATE_UNSPECIFIED" - The state of the cluster is unknown.
// "READY" - The cluster is active and running.
// "STOPPED" - The cluster is stopped. All instances in the cluster are
// stopped. Customers can start a stopped cluster at any point and all their
// instances will come back to life with same names and IP resources. In this
// state, customer pays for storage. Associated backups could also be present
// in a stopped cluster.
// "EMPTY" - The cluster is empty and has no associated resources. All
// instances, associated storage and backups have been deleted.
// "CREATING" - The cluster is being created.
// "DELETING" - The cluster is being deleted.
// "FAILED" - The creation of the cluster failed.
// "BOOTSTRAPPING" - The cluster is bootstrapping with data from some other
// source. Direct mutations to the cluster (e.g. adding read pool) are not
// allowed.
// "MAINTENANCE" - The cluster is under maintenance. AlloyDB regularly
// performs maintenance and upgrades on customer clusters. Updates on the
// cluster are not allowed while the cluster is in this state.
// "PROMOTING" - The cluster is being promoted.
State string `json:"state,omitempty"`
// Uid: 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.
Uid string `json:"uid,omitempty"`
// UpdateTime: Output only. Update time stamp
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Annotations") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Annotations") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Cluster) MarshalJSON() ([]byte, error) {
type NoMethod Cluster
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// ConnectionInfo: ConnectionInfo singleton resource.
// https://google.aip.dev/156
type ConnectionInfo struct {
// InstanceUid: Output only. The unique ID of the Instance.
InstanceUid string `json:"instanceUid,omitempty"`
// IpAddress: Output only. The private network IP address for the Instance.
// This is the default IP for the instance and is always created (even if
// enable_public_ip is set). This is the connection endpoint for an end-user
// application.
IpAddress string `json:"ipAddress,omitempty"`
// Name: The name of the ConnectionInfo singleton resource, e.g.:
// projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo
// This field currently has no semantic meaning.
Name string `json:"name,omitempty"`
// PublicIpAddress: Output only. The public IP addresses for the Instance. This
// is available ONLY when enable_public_ip is set. This is the connection
// endpoint for an end-user application.
PublicIpAddress string `json:"publicIpAddress,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "InstanceUid") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "InstanceUid") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ConnectionInfo) MarshalJSON() ([]byte, error) {
type NoMethod ConnectionInfo
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// ContinuousBackupConfig: ContinuousBackupConfig describes the continuous
// backups recovery configurations of a cluster.
type ContinuousBackupConfig struct {
// Enabled: Whether ContinuousBackup is enabled.
Enabled bool `json:"enabled,omitempty"`
// EncryptionConfig: 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.
EncryptionConfig *EncryptionConfig `json:"encryptionConfig,omitempty"`
// RecoveryWindowDays: 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.
RecoveryWindowDays int64 `json:"recoveryWindowDays,omitempty"`
// ForceSendFields is a list of field names (e.g. "Enabled") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Enabled") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ContinuousBackupConfig) MarshalJSON() ([]byte, error) {
type NoMethod ContinuousBackupConfig
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// ContinuousBackupInfo: ContinuousBackupInfo describes the continuous backup
// properties of a cluster.
type ContinuousBackupInfo struct {
// EarliestRestorableTime: Output only. The earliest restorable time that can
// be restored to. Output only field.
EarliestRestorableTime string `json:"earliestRestorableTime,omitempty"`
// EnabledTime: Output only. When ContinuousBackup was most recently enabled.
// Set to null if ContinuousBackup is not enabled.
EnabledTime string `json:"enabledTime,omitempty"`
// EncryptionInfo: Output only. The encryption information for the WALs and
// backups required for ContinuousBackup.
EncryptionInfo *EncryptionInfo `json:"encryptionInfo,omitempty"`
// Schedule: Output only. Days of the week on which a continuous backup is
// taken. Output only field. Ignored if passed into the request.
//
// Possible values:
// "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified.
// "MONDAY" - Monday
// "TUESDAY" - Tuesday
// "WEDNESDAY" - Wednesday
// "THURSDAY" - Thursday
// "FRIDAY" - Friday
// "SATURDAY" - Saturday
// "SUNDAY" - Sunday
Schedule []string `json:"schedule,omitempty"`
// ForceSendFields is a list of field names (e.g. "EarliestRestorableTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EarliestRestorableTime") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ContinuousBackupInfo) MarshalJSON() ([]byte, error) {
type NoMethod ContinuousBackupInfo
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// ContinuousBackupSource: Message describing a ContinuousBackupSource.
type ContinuousBackupSource struct {
// Cluster: Required. The source cluster from which to restore. This cluster
// must have continuous backup enabled for this operation to succeed. For the
// required format, see the comment on the Cluster.name field.
Cluster string `json:"cluster,omitempty"`
// PointInTime: Required. The point in time to restore to.
PointInTime string `json:"pointInTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "Cluster") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Cluster") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ContinuousBackupSource) MarshalJSON() ([]byte, error) {
type NoMethod ContinuousBackupSource
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Empty: A generic empty message that you can re-use to avoid defining
// duplicated empty messages in your APIs. A typical example is to use it as
// the request or the response type of an API method. For instance: service Foo
// { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
// EncryptionConfig: EncryptionConfig describes the encryption config of a
// cluster or a backup that is encrypted with a CMEK (customer-managed
// encryption key).
type EncryptionConfig struct {
// KmsKeyName: 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]
KmsKeyName string `json:"kmsKeyName,omitempty"`
// ForceSendFields is a list of field names (e.g. "KmsKeyName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "KmsKeyName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EncryptionConfig) MarshalJSON() ([]byte, error) {
type NoMethod EncryptionConfig
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// EncryptionInfo: EncryptionInfo describes the encryption information of a
// cluster or a backup.
type EncryptionInfo struct {
// EncryptionType: Output only. Type of encryption.
//
// Possible values:
// "TYPE_UNSPECIFIED" - Encryption type not specified. Defaults to
// GOOGLE_DEFAULT_ENCRYPTION.
// "GOOGLE_DEFAULT_ENCRYPTION" - The data is encrypted at rest with a key
// that is fully managed by Google. No key version will be populated. This is
// the default state.
// "CUSTOMER_MANAGED_ENCRYPTION" - The data is encrypted at rest with a key
// that is managed by the customer. KMS key versions will be populated.
EncryptionType string `json:"encryptionType,omitempty"`
// KmsKeyVersions: Output only. Cloud KMS key versions that are being used to
// protect the database or the backup.
KmsKeyVersions []string `json:"kmsKeyVersions,omitempty"`
// ForceSendFields is a list of field names (e.g. "EncryptionType") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EncryptionType") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EncryptionInfo) MarshalJSON() ([]byte, error) {
type NoMethod EncryptionInfo
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// FailoverInstanceRequest: Message for triggering failover on an Instance
type FailoverInstanceRequest struct {
// RequestId: 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).
RequestId string `json:"requestId,omitempty"`
// ValidateOnly: Optional. If set, performs request validation (e.g. permission
// checks and any other type of validation), but do not actually execute the
// failover.
ValidateOnly bool `json:"validateOnly,omitempty"`
// ForceSendFields is a list of field names (e.g. "RequestId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "RequestId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *FailoverInstanceRequest) MarshalJSON() ([]byte, error) {
type NoMethod FailoverInstanceRequest
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// GoogleCloudLocationListLocationsResponse: The response message for
// Locations.ListLocations.
type GoogleCloudLocationListLocationsResponse struct {
// Locations: A list of locations that matches the specified filter in the
// request.
Locations []*GoogleCloudLocationLocation `json:"locations,omitempty"`
// NextPageToken: The standard List next-page token.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Locations") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Locations") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudLocationListLocationsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudLocationListLocationsResponse
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// GoogleCloudLocationLocation: A resource that represents a Google Cloud
// location.
type GoogleCloudLocationLocation struct {
// DisplayName: The friendly name for this location, typically a nearby city
// name. For example, "Tokyo".
DisplayName string `json:"displayName,omitempty"`
// Labels: Cross-service attributes for the location. For example
// {"cloud.googleapis.com/region": "us-east1"}
Labels map[string]string `json:"labels,omitempty"`
// LocationId: The canonical id for this location. For example: "us-east1".
LocationId string `json:"locationId,omitempty"`
// Metadata: Service-specific metadata. For example the available capacity at
// the given location.
Metadata googleapi.RawMessage `json:"metadata,omitempty"`
// Name: Resource name for the location, which may vary between
// implementations. For example:
// "projects/example-project/locations/us-east1"
Name string `json:"name,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleCloudLocationLocation) MarshalJSON() ([]byte, error) {
type NoMethod GoogleCloudLocationLocation
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// GoogleTypeTimeOfDay: 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`.