forked from scaleway/scaleway-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrdb_sdk.go
2867 lines (2188 loc) · 69.3 KB
/
rdb_sdk.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
// This file was automatically generated. DO NOT EDIT.
// If you have any remark or suggestion do not hesitate to open an issue.
// Package rdb provides methods and message types of the rdb v1 API.
package rdb
import (
"bytes"
"encoding/json"
"fmt"
"net"
"net/http"
"net/url"
"time"
"github.com./scaleway/scaleway-sdk-go/internal/errors"
"github.com./scaleway/scaleway-sdk-go/internal/marshaler"
"github.com./scaleway/scaleway-sdk-go/internal/parameter"
"github.com./scaleway/scaleway-sdk-go/namegenerator"
"github.com./scaleway/scaleway-sdk-go/scw"
)
// always import dependencies
var (
_ fmt.Stringer
_ json.Unmarshaler
_ url.URL
_ net.IP
_ http.Header
_ bytes.Reader
_ time.Time
_ scw.ScalewayRequest
_ marshaler.Duration
_ scw.File
_ = parameter.AddToQuery
_ = namegenerator.GetRandomName
)
// API database RDB API
type API struct {
client *scw.Client
}
// NewAPI returns a API object from a Scaleway client.
func NewAPI(client *scw.Client) *API {
return &API{
client: client,
}
}
type ACLRuleAction string
const (
// ACLRuleActionAllow is [insert doc].
ACLRuleActionAllow = ACLRuleAction("allow")
// ACLRuleActionDeny is [insert doc].
ACLRuleActionDeny = ACLRuleAction("deny")
)
func (enum ACLRuleAction) String() string {
if enum == "" {
// return default value if empty
return "allow"
}
return string(enum)
}
func (enum ACLRuleAction) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ACLRuleAction) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ACLRuleAction(ACLRuleAction(tmp).String())
return nil
}
type ACLRuleDirection string
const (
// ACLRuleDirectionInbound is [insert doc].
ACLRuleDirectionInbound = ACLRuleDirection("inbound")
// ACLRuleDirectionOutbound is [insert doc].
ACLRuleDirectionOutbound = ACLRuleDirection("outbound")
)
func (enum ACLRuleDirection) String() string {
if enum == "" {
// return default value if empty
return "inbound"
}
return string(enum)
}
func (enum ACLRuleDirection) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ACLRuleDirection) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ACLRuleDirection(ACLRuleDirection(tmp).String())
return nil
}
type ACLRuleProtocol string
const (
// ACLRuleProtocolTCP is [insert doc].
ACLRuleProtocolTCP = ACLRuleProtocol("tcp")
// ACLRuleProtocolUDP is [insert doc].
ACLRuleProtocolUDP = ACLRuleProtocol("udp")
// ACLRuleProtocolIcmp is [insert doc].
ACLRuleProtocolIcmp = ACLRuleProtocol("icmp")
)
func (enum ACLRuleProtocol) String() string {
if enum == "" {
// return default value if empty
return "tcp"
}
return string(enum)
}
func (enum ACLRuleProtocol) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ACLRuleProtocol) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ACLRuleProtocol(ACLRuleProtocol(tmp).String())
return nil
}
type DatabaseBackupStatus string
const (
// DatabaseBackupStatusUnknown is [insert doc].
DatabaseBackupStatusUnknown = DatabaseBackupStatus("unknown")
// DatabaseBackupStatusCreating is [insert doc].
DatabaseBackupStatusCreating = DatabaseBackupStatus("creating")
// DatabaseBackupStatusReady is [insert doc].
DatabaseBackupStatusReady = DatabaseBackupStatus("ready")
// DatabaseBackupStatusRestoring is [insert doc].
DatabaseBackupStatusRestoring = DatabaseBackupStatus("restoring")
// DatabaseBackupStatusDeleting is [insert doc].
DatabaseBackupStatusDeleting = DatabaseBackupStatus("deleting")
// DatabaseBackupStatusError is [insert doc].
DatabaseBackupStatusError = DatabaseBackupStatus("error")
// DatabaseBackupStatusExporting is [insert doc].
DatabaseBackupStatusExporting = DatabaseBackupStatus("exporting")
)
func (enum DatabaseBackupStatus) String() string {
if enum == "" {
// return default value if empty
return "unknown"
}
return string(enum)
}
func (enum DatabaseBackupStatus) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *DatabaseBackupStatus) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = DatabaseBackupStatus(DatabaseBackupStatus(tmp).String())
return nil
}
type EngineSettingPropertyType string
const (
// EngineSettingPropertyTypeBOOLEAN is [insert doc].
EngineSettingPropertyTypeBOOLEAN = EngineSettingPropertyType("BOOLEAN")
// EngineSettingPropertyTypeINT is [insert doc].
EngineSettingPropertyTypeINT = EngineSettingPropertyType("INT")
// EngineSettingPropertyTypeSTRING is [insert doc].
EngineSettingPropertyTypeSTRING = EngineSettingPropertyType("STRING")
)
func (enum EngineSettingPropertyType) String() string {
if enum == "" {
// return default value if empty
return "BOOLEAN"
}
return string(enum)
}
func (enum EngineSettingPropertyType) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *EngineSettingPropertyType) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = EngineSettingPropertyType(EngineSettingPropertyType(tmp).String())
return nil
}
type InstanceLogStatus string
const (
// InstanceLogStatusUnknown is [insert doc].
InstanceLogStatusUnknown = InstanceLogStatus("unknown")
// InstanceLogStatusReady is [insert doc].
InstanceLogStatusReady = InstanceLogStatus("ready")
// InstanceLogStatusCreating is [insert doc].
InstanceLogStatusCreating = InstanceLogStatus("creating")
// InstanceLogStatusError is [insert doc].
InstanceLogStatusError = InstanceLogStatus("error")
)
func (enum InstanceLogStatus) String() string {
if enum == "" {
// return default value if empty
return "unknown"
}
return string(enum)
}
func (enum InstanceLogStatus) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *InstanceLogStatus) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = InstanceLogStatus(InstanceLogStatus(tmp).String())
return nil
}
type InstanceStatus string
const (
// InstanceStatusUnknown is [insert doc].
InstanceStatusUnknown = InstanceStatus("unknown")
// InstanceStatusReady is [insert doc].
InstanceStatusReady = InstanceStatus("ready")
// InstanceStatusProvisioning is [insert doc].
InstanceStatusProvisioning = InstanceStatus("provisioning")
// InstanceStatusConfiguring is [insert doc].
InstanceStatusConfiguring = InstanceStatus("configuring")
// InstanceStatusDeleting is [insert doc].
InstanceStatusDeleting = InstanceStatus("deleting")
// InstanceStatusError is [insert doc].
InstanceStatusError = InstanceStatus("error")
// InstanceStatusAutohealing is [insert doc].
InstanceStatusAutohealing = InstanceStatus("autohealing")
// InstanceStatusLocked is [insert doc].
InstanceStatusLocked = InstanceStatus("locked")
// InstanceStatusInitializing is [insert doc].
InstanceStatusInitializing = InstanceStatus("initializing")
// InstanceStatusDiskFull is [insert doc].
InstanceStatusDiskFull = InstanceStatus("disk_full")
// InstanceStatusBackuping is [insert doc].
InstanceStatusBackuping = InstanceStatus("backuping")
)
func (enum InstanceStatus) String() string {
if enum == "" {
// return default value if empty
return "unknown"
}
return string(enum)
}
func (enum InstanceStatus) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *InstanceStatus) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = InstanceStatus(InstanceStatus(tmp).String())
return nil
}
type ListDatabaseBackupsRequestOrderBy string
const (
// ListDatabaseBackupsRequestOrderByCreatedAtAsc is [insert doc].
ListDatabaseBackupsRequestOrderByCreatedAtAsc = ListDatabaseBackupsRequestOrderBy("created_at_asc")
// ListDatabaseBackupsRequestOrderByCreatedAtDesc is [insert doc].
ListDatabaseBackupsRequestOrderByCreatedAtDesc = ListDatabaseBackupsRequestOrderBy("created_at_desc")
// ListDatabaseBackupsRequestOrderByNameAsc is [insert doc].
ListDatabaseBackupsRequestOrderByNameAsc = ListDatabaseBackupsRequestOrderBy("name_asc")
// ListDatabaseBackupsRequestOrderByNameDesc is [insert doc].
ListDatabaseBackupsRequestOrderByNameDesc = ListDatabaseBackupsRequestOrderBy("name_desc")
// ListDatabaseBackupsRequestOrderByStatusAsc is [insert doc].
ListDatabaseBackupsRequestOrderByStatusAsc = ListDatabaseBackupsRequestOrderBy("status_asc")
// ListDatabaseBackupsRequestOrderByStatusDesc is [insert doc].
ListDatabaseBackupsRequestOrderByStatusDesc = ListDatabaseBackupsRequestOrderBy("status_desc")
)
func (enum ListDatabaseBackupsRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "created_at_asc"
}
return string(enum)
}
func (enum ListDatabaseBackupsRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListDatabaseBackupsRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListDatabaseBackupsRequestOrderBy(ListDatabaseBackupsRequestOrderBy(tmp).String())
return nil
}
type ListDatabasesRequestOrderBy string
const (
// ListDatabasesRequestOrderByNameAsc is [insert doc].
ListDatabasesRequestOrderByNameAsc = ListDatabasesRequestOrderBy("name_asc")
// ListDatabasesRequestOrderByNameDesc is [insert doc].
ListDatabasesRequestOrderByNameDesc = ListDatabasesRequestOrderBy("name_desc")
// ListDatabasesRequestOrderBySizeAsc is [insert doc].
ListDatabasesRequestOrderBySizeAsc = ListDatabasesRequestOrderBy("size_asc")
// ListDatabasesRequestOrderBySizeDesc is [insert doc].
ListDatabasesRequestOrderBySizeDesc = ListDatabasesRequestOrderBy("size_desc")
)
func (enum ListDatabasesRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "name_asc"
}
return string(enum)
}
func (enum ListDatabasesRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListDatabasesRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListDatabasesRequestOrderBy(ListDatabasesRequestOrderBy(tmp).String())
return nil
}
type ListInstanceLogsRequestOrderBy string
const (
// ListInstanceLogsRequestOrderByCreatedAtAsc is [insert doc].
ListInstanceLogsRequestOrderByCreatedAtAsc = ListInstanceLogsRequestOrderBy("created_at_asc")
// ListInstanceLogsRequestOrderByCreatedAtDesc is [insert doc].
ListInstanceLogsRequestOrderByCreatedAtDesc = ListInstanceLogsRequestOrderBy("created_at_desc")
)
func (enum ListInstanceLogsRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "created_at_asc"
}
return string(enum)
}
func (enum ListInstanceLogsRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListInstanceLogsRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListInstanceLogsRequestOrderBy(ListInstanceLogsRequestOrderBy(tmp).String())
return nil
}
type ListInstancesRequestOrderBy string
const (
// ListInstancesRequestOrderByCreatedAtAsc is [insert doc].
ListInstancesRequestOrderByCreatedAtAsc = ListInstancesRequestOrderBy("created_at_asc")
// ListInstancesRequestOrderByCreatedAtDesc is [insert doc].
ListInstancesRequestOrderByCreatedAtDesc = ListInstancesRequestOrderBy("created_at_desc")
// ListInstancesRequestOrderByNameAsc is [insert doc].
ListInstancesRequestOrderByNameAsc = ListInstancesRequestOrderBy("name_asc")
// ListInstancesRequestOrderByNameDesc is [insert doc].
ListInstancesRequestOrderByNameDesc = ListInstancesRequestOrderBy("name_desc")
// ListInstancesRequestOrderByRegion is [insert doc].
ListInstancesRequestOrderByRegion = ListInstancesRequestOrderBy("region")
// ListInstancesRequestOrderByStatusAsc is [insert doc].
ListInstancesRequestOrderByStatusAsc = ListInstancesRequestOrderBy("status_asc")
// ListInstancesRequestOrderByStatusDesc is [insert doc].
ListInstancesRequestOrderByStatusDesc = ListInstancesRequestOrderBy("status_desc")
)
func (enum ListInstancesRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "created_at_asc"
}
return string(enum)
}
func (enum ListInstancesRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListInstancesRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListInstancesRequestOrderBy(ListInstancesRequestOrderBy(tmp).String())
return nil
}
type ListPrivilegesRequestOrderBy string
const (
// ListPrivilegesRequestOrderByUserNameAsc is [insert doc].
ListPrivilegesRequestOrderByUserNameAsc = ListPrivilegesRequestOrderBy("user_name_asc")
// ListPrivilegesRequestOrderByUserNameDesc is [insert doc].
ListPrivilegesRequestOrderByUserNameDesc = ListPrivilegesRequestOrderBy("user_name_desc")
// ListPrivilegesRequestOrderByDatabaseNameAsc is [insert doc].
ListPrivilegesRequestOrderByDatabaseNameAsc = ListPrivilegesRequestOrderBy("database_name_asc")
// ListPrivilegesRequestOrderByDatabaseNameDesc is [insert doc].
ListPrivilegesRequestOrderByDatabaseNameDesc = ListPrivilegesRequestOrderBy("database_name_desc")
)
func (enum ListPrivilegesRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "user_name_asc"
}
return string(enum)
}
func (enum ListPrivilegesRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListPrivilegesRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListPrivilegesRequestOrderBy(ListPrivilegesRequestOrderBy(tmp).String())
return nil
}
type ListUsersRequestOrderBy string
const (
// ListUsersRequestOrderByNameAsc is [insert doc].
ListUsersRequestOrderByNameAsc = ListUsersRequestOrderBy("name_asc")
// ListUsersRequestOrderByNameDesc is [insert doc].
ListUsersRequestOrderByNameDesc = ListUsersRequestOrderBy("name_desc")
// ListUsersRequestOrderByIsAdminAsc is [insert doc].
ListUsersRequestOrderByIsAdminAsc = ListUsersRequestOrderBy("is_admin_asc")
// ListUsersRequestOrderByIsAdminDesc is [insert doc].
ListUsersRequestOrderByIsAdminDesc = ListUsersRequestOrderBy("is_admin_desc")
)
func (enum ListUsersRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "name_asc"
}
return string(enum)
}
func (enum ListUsersRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListUsersRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListUsersRequestOrderBy(ListUsersRequestOrderBy(tmp).String())
return nil
}
type NodeTypeStock string
const (
// NodeTypeStockUnknown is [insert doc].
NodeTypeStockUnknown = NodeTypeStock("unknown")
// NodeTypeStockLowStock is [insert doc].
NodeTypeStockLowStock = NodeTypeStock("low_stock")
// NodeTypeStockOutOfStock is [insert doc].
NodeTypeStockOutOfStock = NodeTypeStock("out_of_stock")
// NodeTypeStockAvailable is [insert doc].
NodeTypeStockAvailable = NodeTypeStock("available")
)
func (enum NodeTypeStock) String() string {
if enum == "" {
// return default value if empty
return "unknown"
}
return string(enum)
}
func (enum NodeTypeStock) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *NodeTypeStock) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = NodeTypeStock(NodeTypeStock(tmp).String())
return nil
}
type Permission string
const (
// PermissionReadonly is [insert doc].
PermissionReadonly = Permission("readonly")
// PermissionReadwrite is [insert doc].
PermissionReadwrite = Permission("readwrite")
// PermissionAll is [insert doc].
PermissionAll = Permission("all")
// PermissionCustom is [insert doc].
PermissionCustom = Permission("custom")
// PermissionNone is [insert doc].
PermissionNone = Permission("none")
)
func (enum Permission) String() string {
if enum == "" {
// return default value if empty
return "readonly"
}
return string(enum)
}
func (enum Permission) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *Permission) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = Permission(Permission(tmp).String())
return nil
}
type VolumeType string
const (
// VolumeTypeLssd is [insert doc].
VolumeTypeLssd = VolumeType("lssd")
// VolumeTypeBssd is [insert doc].
VolumeTypeBssd = VolumeType("bssd")
)
func (enum VolumeType) String() string {
if enum == "" {
// return default value if empty
return "lssd"
}
return string(enum)
}
func (enum VolumeType) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *VolumeType) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = VolumeType(VolumeType(tmp).String())
return nil
}
type ACLRule struct {
IP net.IP `json:"ip"`
Port uint32 `json:"port"`
// Protocol
//
// Default value: tcp
Protocol ACLRuleProtocol `json:"protocol"`
// Direction
//
// Default value: inbound
Direction ACLRuleDirection `json:"direction"`
// Action
//
// Default value: allow
Action ACLRuleAction `json:"action"`
Description string `json:"description"`
}
type ACLRuleRequest struct {
IP net.IP `json:"ip"`
Description string `json:"description"`
}
// AddInstanceACLRulesResponse add instance acl rules response
type AddInstanceACLRulesResponse struct {
Rules []*ACLRule `json:"rules"`
}
// AddInstanceSettingsResponse add instance settings response
type AddInstanceSettingsResponse struct {
Settings []*InstanceSetting `json:"settings"`
}
type BackupSchedule struct {
Frequency uint32 `json:"frequency"`
Retention uint32 `json:"retention"`
Disabled bool `json:"disabled"`
}
// Database database
type Database struct {
Name string `json:"name"`
Owner string `json:"owner"`
Managed bool `json:"managed"`
Size scw.Size `json:"size"`
}
// DatabaseBackup database backup
type DatabaseBackup struct {
ID string `json:"id"`
InstanceID string `json:"instance_id"`
DatabaseName string `json:"database_name"`
Name string `json:"name"`
// Status
//
// Default value: unknown
Status DatabaseBackupStatus `json:"status"`
Size *scw.Size `json:"size"`
ExpiresAt time.Time `json:"expires_at"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
InstanceName string `json:"instance_name"`
DownloadURL *string `json:"download_url"`
DownloadURLExpiresAt time.Time `json:"download_url_expires_at"`
Region scw.Region `json:"region"`
}
type DatabaseEngine struct {
Name string `json:"name"`
LogoURL string `json:"logo_url"`
Versions []*EngineVersion `json:"versions"`
Region scw.Region `json:"region"`
}
// DeleteInstanceACLRulesResponse delete instance acl rules response
type DeleteInstanceACLRulesResponse struct {
Rules []*ACLRule `json:"rules"`
}
// DeleteInstanceSettingsResponse delete instance settings response
type DeleteInstanceSettingsResponse struct {
Settings []*InstanceSetting `json:"settings"`
}
// Endpoint endpoint
type Endpoint struct {
IP *net.IP `json:"ip"`
Port uint32 `json:"port"`
Name *string `json:"name"`
}
type EngineSetting struct {
Name string `json:"name"`
DefaultValue string `json:"default_value"`
HotConfigurable bool `json:"hot_configurable"`
Description string `json:"description"`
// PropertyType
//
// Default value: BOOLEAN
PropertyType EngineSettingPropertyType `json:"property_type"`
Unit *string `json:"unit"`
StringConstraint *string `json:"string_constraint"`
IntMin *int32 `json:"int_min"`
IntMax *int32 `json:"int_max"`
}
type EngineVersion struct {
Version string `json:"version"`
Name string `json:"name"`
EndOfLife time.Time `json:"end_of_life"`
AvailableSettings []*EngineSetting `json:"available_settings"`
Disabled bool `json:"disabled"`
}
// Instance instance
type Instance struct {
ID string `json:"id"`
Name string `json:"name"`
OrganizationID string `json:"organization_id"`
// Status
//
// Default value: unknown
Status InstanceStatus `json:"status"`
Engine string `json:"engine"`
Endpoint *Endpoint `json:"endpoint"`
Tags []string `json:"tags"`
Settings []*InstanceSetting `json:"settings"`
BackupSchedule *BackupSchedule `json:"backup_schedule"`
IsHaCluster bool `json:"is_ha_cluster"`
ReadReplicas []*Endpoint `json:"read_replicas"`
NodeType string `json:"node_type"`
Volume *Volume `json:"volume"`
CreatedAt time.Time `json:"created_at"`
Region scw.Region `json:"region"`
}
// InstanceLog instance log
type InstanceLog struct {
// DownloadURL presigned S3 URL to download your log file
DownloadURL *string `json:"download_url"`
ID string `json:"id"`
// Status
//
// Default value: unknown
Status InstanceLogStatus `json:"status"`
NodeName string `json:"node_name"`
ExpiresAt time.Time `json:"expires_at"`
CreatedAt time.Time `json:"created_at"`
Region scw.Region `json:"region"`
}
// InstanceMetrics instance metrics
type InstanceMetrics struct {
Timeseries []*scw.TimeSeries `json:"timeseries"`
}
type InstanceSetting struct {
Name string `json:"name"`
Value string `json:"value"`
}
// ListDatabaseBackupsResponse list database backups response
type ListDatabaseBackupsResponse struct {
DatabaseBackups []*DatabaseBackup `json:"database_backups"`
TotalCount uint32 `json:"total_count"`
}
// ListDatabaseEnginesResponse list database engines response
type ListDatabaseEnginesResponse struct {
Engines []*DatabaseEngine `json:"engines"`
TotalCount uint32 `json:"total_count"`
}
// ListDatabasesResponse list databases response
type ListDatabasesResponse struct {
Databases []*Database `json:"databases"`
TotalCount uint32 `json:"total_count"`
}
// ListInstanceACLRulesResponse list instance acl rules response
type ListInstanceACLRulesResponse struct {
Rules []*ACLRule `json:"rules"`
TotalCount uint32 `json:"total_count"`
}
type ListInstanceLogsResponse struct {
InstanceLogs []*InstanceLog `json:"instance_logs"`
}
// ListInstancesResponse list instances response
type ListInstancesResponse struct {
Instances []*Instance `json:"instances"`
TotalCount uint32 `json:"total_count"`
}
// ListNodeTypesResponse list node types response
type ListNodeTypesResponse struct {
NodeTypes []*NodeType `json:"node_types"`
TotalCount uint32 `json:"total_count"`
}
// ListPrivilegesResponse list privileges response
type ListPrivilegesResponse struct {
Privileges []*Privilege `json:"privileges"`
TotalCount uint32 `json:"total_count"`
}
// ListUsersResponse list users response
type ListUsersResponse struct {
Users []*User `json:"users"`
TotalCount uint32 `json:"total_count"`
}
type NodeType struct {
Name string `json:"name"`
// StockStatus
//
// Default value: unknown
StockStatus NodeTypeStock `json:"stock_status"`
Description string `json:"description"`
Vcpus uint32 `json:"vcpus"`
Memory scw.Size `json:"memory"`
VolumeConstraint *NodeTypeVolumeConstraintSizes `json:"volume_constraint"`
IsBssdCompatible bool `json:"is_bssd_compatible"`
Disabled bool `json:"disabled"`
Region scw.Region `json:"region"`
}
type NodeTypeVolumeConstraintSizes struct {
MinSize scw.Size `json:"min_size"`
MaxSize scw.Size `json:"max_size"`
}
// PrepareInstanceLogsResponse prepare instance logs response
type PrepareInstanceLogsResponse struct {
InstanceLogs []*InstanceLog `json:"instance_logs"`
}
// Privilege privilege
type Privilege struct {
// Permission
//
// Default value: readonly
Permission Permission `json:"permission"`
DatabaseName string `json:"database_name"`
UserName string `json:"user_name"`
}
// SetInstanceACLRulesResponse set instance acl rules response
type SetInstanceACLRulesResponse struct {
Rules []*ACLRule `json:"rules"`
}
// SetInstanceSettingsResponse set instance settings response
type SetInstanceSettingsResponse struct {
Settings []*InstanceSetting `json:"settings"`
}
// User user
type User struct {
Name string `json:"name"`
IsAdmin bool `json:"is_admin"`
}
type Volume struct {
// Type
//
// Default value: lssd
Type VolumeType `json:"type"`
Size scw.Size `json:"size"`
}
// Service API
type GetServiceInfoRequest struct {
Region scw.Region `json:"-"`
}
func (s *API) GetServiceInfo(req *GetServiceInfoRequest, opts ...scw.RequestOption) (*scw.ServiceInfo, error) {
var err error
if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}
if fmt.Sprint(req.Region) == "" {