-
Notifications
You must be signed in to change notification settings - Fork 1
/
oas_parameters_gen.go
1696 lines (1526 loc) · 71.2 KB
/
oas_parameters_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
// Code generated by ogen, DO NOT EDIT.
package api
// ContainersListServersParams is parameters of ContainersListServers operation.
type ContainersListServersParams struct {
// The ID of the requested container.
ContainerId string
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []ContainersListServersMetaItem
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptContainersListServersPage
}
// CreateContainerInstanceParams is parameters of createContainerInstance operation.
type CreateContainerInstanceParams struct {
// The ID of the container this instance is created from.
ContainerId string
}
// CreateContainerInstanceJobParams is parameters of createContainerInstanceJob operation.
type CreateContainerInstanceJobParams struct {
// The ID of the requested container.
ContainerId string
// The ID for the container instance.
InstanceId string
}
// CreateContainerJobParams is parameters of createContainerJob operation.
type CreateContainerJobParams struct {
// The ID of the requested container.
ContainerId string
}
// CreateDNSRecordParams is parameters of createDNSRecord operation.
type CreateDNSRecordParams struct {
// The ID of the zone.
ZoneId string
}
// CreateEnvironmentJobParams is parameters of createEnvironmentJob operation.
type CreateEnvironmentJobParams struct {
// The ID of the requested environment.
EnvironmentId string
}
// CreateEnvironmentVpnTaskParams is parameters of createEnvironmentVpnTask operation.
type CreateEnvironmentVpnTaskParams struct {
// The ID of the environment the VPN service resides in.
EnvironmentId string
}
// CreateImageJobParams is parameters of createImageJob operation.
type CreateImageJobParams struct {
// The ID of the requested image.
ImageId string
}
// CreateInvoiceJobParams is parameters of createInvoiceJob operation.
type CreateInvoiceJobParams struct {
// The ID of the invoice.
InvoiceId string
}
// CreateNetworkJobParams is parameters of createNetworkJob operation.
type CreateNetworkJobParams struct {
// The ID of the network.
NetworkId string
}
// CreateOrderJobParams is parameters of createOrderJob operation.
type CreateOrderJobParams struct {
// The ID of the requested order.
OrderId string
}
// CreatePipelineJobParams is parameters of createPipelineJob operation.
type CreatePipelineJobParams struct {
// The ID of the pipeline.
PipelineId string
}
// CreatePipelineTriggerKeyParams is parameters of createPipelineTriggerKey operation.
type CreatePipelineTriggerKeyParams struct {
// The ID of the pipeline.
PipelineId string
}
// CreateProviderJobParams is parameters of createProviderJob operation.
type CreateProviderJobParams struct {
// The identifier for the given provider. Example `gcp`, `equinix-metal`, `a-<abstract-provider-id>`,
// etc.
ProviderIdentifier string
}
// CreateSDNNetworkParams is parameters of createSDNNetwork operation.
type CreateSDNNetworkParams struct {
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []CreateSDNNetworkIncludeItem
}
// CreateScopedVariableParams is parameters of createScopedVariable operation.
type CreateScopedVariableParams struct {
// The ID of the requested environment.
EnvironmentId string
}
// CreateServerJobParams is parameters of createServerJob operation.
type CreateServerJobParams struct {
// The ID for the given server.
ServerId string
}
// CreateStackBuildParams is parameters of createStackBuild operation.
type CreateStackBuildParams struct {
// The ID of the stack.
StackId string
}
// CreateStackBuildJobParams is parameters of createStackBuildJob operation.
type CreateStackBuildJobParams struct {
// The ID of the stack.
StackId string
// The ID of the build.
BuildId string
}
// CreateStackJobParams is parameters of createStackJob operation.
type CreateStackJobParams struct {
// The ID of the stack.
StackId string
}
// CreateVPNUserParams is parameters of createVPNUser operation.
type CreateVPNUserParams struct {
// The environmentId where the VPN service resides.
EnvironmentId string
}
// DNSRecordTaskParams is parameters of DNSRecordTask operation.
type DNSRecordTaskParams struct {
// The ID of the zone.
ZoneId string
// The ID of the record.
RecordId string
}
// DNSTLSAttemptsParams is parameters of DNSTLSAttempts operation.
type DNSTLSAttemptsParams struct {
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptDNSTLSAttemptsFilter
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptDNSTLSAttemptsPage
}
// DNSZoneTaskParams is parameters of DNSZoneTask operation.
type DNSZoneTaskParams struct {
// The ID of the zone.
ZoneId string
}
// ExpireInstanceSSHTokensParams is parameters of expireInstanceSSHTokens operation.
type ExpireInstanceSSHTokensParams struct {
// The ID of the requested container.
ContainerId string
// The ID for the container instance.
InstanceId string
}
// FetchScopedVariableParams is parameters of fetchScopedVariable operation.
type FetchScopedVariableParams struct {
// The ID of the requested environment.
EnvironmentId string
// The ID of the requested scoped variable.
ScopedVariableId string
}
// GetAccountInvitesParams is parameters of getAccountInvites operation.
type GetAccountInvitesParams struct {
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetAccountInvitesMetaItem
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetAccountInvitesIncludeItem
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
Filter *GetAccountInvitesFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetAccountInvitesPage
}
// GetAccountLoginsParams is parameters of getAccountLogins operation.
type GetAccountLoginsParams struct {
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
Filter *GetAccountLoginsFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetAccountLoginsPage
}
// GetAnnouncementsListParams is parameters of getAnnouncementsList operation.
type GetAnnouncementsListParams struct {
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
Filter *GetAnnouncementsListFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetAnnouncementsListPage
}
// GetApiKeyParams is parameters of getApiKey operation.
type GetApiKeyParams struct {
// The ID of the API Key.
ApikeyId string
}
// GetApiKeysParams is parameters of getApiKeys operation.
type GetApiKeysParams struct {
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
Filter *GetApiKeysFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetApiKeysPage
}
// GetAutoScaleGroupParams is parameters of getAutoScaleGroup operation.
type GetAutoScaleGroupParams struct {
// The ID for the given auto-scale group.
GroupId string
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetAutoScaleGroupIncludeItem
}
// GetAutoScaleGroupsParams is parameters of getAutoScaleGroups operation.
type GetAutoScaleGroupsParams struct {
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetAutoScaleGroupsPage
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetAutoScaleGroupsIncludeItem
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetAutoScaleGroupsFilter
}
// GetBackupParams is parameters of getBackup operation.
type GetBackupParams struct {
// The ID of the requested container.
ContainerId string
// The ID for the container backup.
BackupId string
}
// GetBackupLogsParams is parameters of getBackupLogs operation.
type GetBackupLogsParams struct {
// The ID of the requested container.
ContainerId string
// The ID for the container backup.
BackupId string
}
// GetBackupsCollectionParams is parameters of getBackupsCollection operation.
type GetBackupsCollectionParams struct {
// The ID of the requested container.
ContainerId string
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetBackupsCollectionPage
}
// GetBillingMethodParams is parameters of getBillingMethod operation.
type GetBillingMethodParams struct {
// The ID of the billing method.
MethodId string
}
// GetBillingMethodsParams is parameters of getBillingMethods operation.
type GetBillingMethodsParams struct {
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
Filter *GetBillingMethodsFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetBillingMethodsPage
}
// GetBillingOrderParams is parameters of getBillingOrder operation.
type GetBillingOrderParams struct {
// The ID of the billing order.
OrderId string
}
// GetBillingOveragesParams is parameters of getBillingOverages operation.
type GetBillingOveragesParams struct {
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
Filter *GetBillingOveragesFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetBillingOveragesPage
}
// GetBillingServiceParams is parameters of getBillingService operation.
type GetBillingServiceParams struct {
// The ID of the billing service.
ServicesId string
}
// GetBillingServicesParams is parameters of getBillingServices operation.
type GetBillingServicesParams struct {
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
Filter *GetBillingServicesFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetBillingServicesPage
}
// GetBillingSupportPlansParams is parameters of getBillingSupportPlans operation.
type GetBillingSupportPlansParams struct {
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
Filter *GetBillingSupportPlansFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetBillingSupportPlansPage
}
// GetCompatibleImagesParams is parameters of getCompatibleImages operation.
type GetCompatibleImagesParams struct {
// The ID of the requested container.
ContainerId string
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetCompatibleImagesPage
}
// GetContainerByIdParams is parameters of getContainerById operation.
type GetContainerByIdParams struct {
// The ID of the requested container.
ContainerId string
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetContainerByIdMetaItem
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetContainerByIdIncludeItem
}
// GetContainerInstanceParams is parameters of getContainerInstance operation.
type GetContainerInstanceParams struct {
// The ID of the requested container.
ContainerId string
// The ID for the container instance.
InstanceId string
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetContainerInstanceIncludeItem
}
// GetContainerInstanceVolumesParams is parameters of getContainerInstanceVolumes operation.
type GetContainerInstanceVolumesParams struct {
// The ID of the requested container.
ContainerId string
// The ID for the container instance.
InstanceId string
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetContainerInstanceVolumesPage
}
// GetContainerInstancesTelemetryParams is parameters of getContainerInstancesTelemetry operation.
type GetContainerInstancesTelemetryParams struct {
// The ID of the desired container.
ContainerId string
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetContainerInstancesTelemetryFilter
}
// GetContainerSummaryParams is parameters of getContainerSummary operation.
type GetContainerSummaryParams struct {
// The ID of the requested container.
ContainerId string
}
// GetContainersParams is parameters of getContainers operation.
type GetContainersParams struct {
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetContainersMetaItem
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetContainersIncludeItem
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetContainersFilter
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetContainersPage
}
// GetCreditParams is parameters of getCredit operation.
type GetCreditParams struct {
// The ID for a given credit.
CreditsId string
}
// GetCreditsParams is parameters of getCredits operation.
type GetCreditsParams struct {
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetCreditsFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetCreditsPage
}
// GetDNSZoneParams is parameters of getDNSZone operation.
type GetDNSZoneParams struct {
// The ID of the zone.
ZoneId string
}
// GetEnvironmentByIdParams is parameters of getEnvironmentById operation.
type GetEnvironmentByIdParams struct {
// The ID of the requested environment.
EnvironmentId string
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetEnvironmentByIdMetaItem
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetEnvironmentByIdIncludeItem
}
// GetEnvironmentDeploymentsParams is parameters of getEnvironmentDeployments operation.
type GetEnvironmentDeploymentsParams struct {
// The ID of the environment to get the list of deployments for.
EnvironmentId string
}
// GetEnvironmentInstancesTelemetryParams is parameters of getEnvironmentInstancesTelemetry operation.
type GetEnvironmentInstancesTelemetryParams struct {
// The ID of the desired environment.
EnvironmentId string
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetEnvironmentInstancesTelemetryFilter
}
// GetEnvironmentSummaryParams is parameters of getEnvironmentSummary operation.
type GetEnvironmentSummaryParams struct {
// The ID of the requested environment.
EnvironmentId string
}
// GetEnvironmentsParams is parameters of getEnvironments operation.
type GetEnvironmentsParams struct {
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetEnvironmentsMetaItem
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetEnvironmentsIncludeItem
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetEnvironmentsFilter
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetEnvironmentsPage
}
// GetHubParams is parameters of getHub operation.
type GetHubParams struct {
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetHubMetaItem
}
// GetHubInvitesParams is parameters of getHubInvites operation.
type GetHubInvitesParams struct {
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetHubInvitesMetaItem
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetHubInvitesIncludeItem
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
Filter *GetHubInvitesFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetHubInvitesPage
}
// GetHubMemberParams is parameters of getHubMember operation.
type GetHubMemberParams struct {
// The ID for the given member.
MemberId string
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetHubMemberIncludeItem
}
// GetHubMembersParams is parameters of getHubMembers operation.
type GetHubMembersParams struct {
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetHubMembersMetaItem
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetHubMembersIncludeItem
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
Filter *GetHubMembersFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetHubMembersPage
}
// GetHubMembersAccountParams is parameters of getHubMembersAccount operation.
type GetHubMembersAccountParams struct {
// The ID of the member account.
AccountId string
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetHubMembersAccountMetaItem
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetHubMembersAccountIncludeItem
}
// GetHubMembershipParams is parameters of getHubMembership operation.
type GetHubMembershipParams struct {
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetHubMembershipMetaItem
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetHubMembershipIncludeItem
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
Filter *GetHubMembershipFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetHubMembershipPage
}
// GetHubUsageParams is parameters of getHubUsage operation.
type GetHubUsageParams struct {
Filter *GetHubUsageFilter
}
// GetHubsParams is parameters of getHubs operation.
type GetHubsParams struct {
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetHubsPage
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetHubsFilter
}
// GetImageParams is parameters of getImage operation.
type GetImageParams struct {
// The ID of the image.
ImageId string
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetImageMetaItem
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetImageIncludeItem
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetImagePage
}
// GetImageBuildLogParams is parameters of getImageBuildLog operation.
type GetImageBuildLogParams struct {
// The ID of the image.
ImageId string
}
// GetImagesParams is parameters of getImages operation.
type GetImagesParams struct {
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetImagesMetaItem
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetImagesIncludeItem
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetImagesFilter
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetImagesPage
}
// GetInfrastructureIPPoolParams is parameters of getInfrastructureIPPool operation.
type GetInfrastructureIPPoolParams struct {
// The ID for the given pool.
PoolId string
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetInfrastructureIPPoolIncludeItem
}
// GetInfrastructureIPPoolsParams is parameters of getInfrastructureIPPools operation.
type GetInfrastructureIPPoolsParams struct {
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetInfrastructureIPPoolsIncludeItem
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetInfrastructureIPPoolsPage
}
// GetInfrastructureSummaryParams is parameters of getInfrastructureSummary operation.
type GetInfrastructureSummaryParams struct {
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetInfrastructureSummaryFilter
}
// GetInstanceResourcesTelemetryReportParams is parameters of getInstanceResourcesTelemetryReport operation.
type GetInstanceResourcesTelemetryReportParams struct {
// The ID of the requested container.
ContainerId string
// The ID for the container instance.
InstanceId string
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetInstanceResourcesTelemetryReportFilter
}
// GetInstanceResourcesTelemetryStreamParams is parameters of getInstanceResourcesTelemetryStream operation.
type GetInstanceResourcesTelemetryStreamParams struct {
// The ID of the requested container.
ContainerId string
// The ID for the container instance.
InstanceId string
}
// GetInstancesParams is parameters of getInstances operation.
type GetInstancesParams struct {
// The ID of the container this instance is created from.
ContainerId string
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetInstancesIncludeItem
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetInstancesFilter
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetInstancesPage
}
// GetInvoiceParams is parameters of getInvoice operation.
type GetInvoiceParams struct {
// The ID of the invoice.
InvoiceId string
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetInvoiceMetaItem
}
// GetInvoicesParams is parameters of getInvoices operation.
type GetInvoicesParams struct {
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetInvoicesPage
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetInvoicesMetaItem
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetInvoicesFilter
}
// GetJobParams is parameters of getJob operation.
type GetJobParams struct {
// The ID for the given job.
JobId string
}
// GetJobsParams is parameters of getJobs operation.
type GetJobsParams struct {
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetJobsIncludeItem
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetJobsFilter
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetJobsPage
}
// GetLoadBalancerInfoParams is parameters of getLoadBalancerInfo operation.
type GetLoadBalancerInfoParams struct {
// The environmentId where the load balancer resides.
EnvironmentId string
}
// GetLoadBalancerLatestTelemetryReportParams is parameters of getLoadBalancerLatestTelemetryReport operation.
type GetLoadBalancerLatestTelemetryReportParams struct {
// The environmentId where the load balancer resides.
EnvironmentId string
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
// ### Required Filter
// On this endpoint, you MUST pass filter[controller].
Filter GetLoadBalancerLatestTelemetryReportFilter
}
// GetLoadBalancerTelemetryLatestControllersParams is parameters of getLoadBalancerTelemetryLatestControllers operation.
type GetLoadBalancerTelemetryLatestControllersParams struct {
// The ID of the environment of the desired load balancer.
EnvironmentId string
}
// GetLoadBalancerTelemetryReportParams is parameters of getLoadBalancerTelemetryReport operation.
type GetLoadBalancerTelemetryReportParams struct {
// The environmentId where the load balancer resides.
EnvironmentId string
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetLoadBalancerTelemetryReportFilter
}
// GetNativeProvidersParams is parameters of getNativeProviders operation.
type GetNativeProvidersParams struct {
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetNativeProvidersMetaItem
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetNativeProvidersFilter
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetNativeProvidersPage
}
// GetNetworkParams is parameters of getNetwork operation.
type GetNetworkParams struct {
// The ID of the network.
NetworkId string
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetNetworkIncludeItem
}
// GetNetworksParams is parameters of getNetworks operation.
type GetNetworksParams struct {
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetNetworksIncludeItem
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetNetworksFilter
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetNetworksPage
}
// GetOrdersParams is parameters of getOrders operation.
type GetOrdersParams struct {
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
Filter *GetOrdersFilter
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetOrdersPage
// A comma separated list of meta values. Meta values will show up under a resource's `meta` field.
// In the case of applying a meta to a collection of resources, each resource will have it's own
// relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear
// in the root document. These will be clearly labeled.
Meta []GetOrdersMetaItem
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetOrdersIncludeItem
}
// GetPipelineParams is parameters of getPipeline operation.
type GetPipelineParams struct {
// The ID of the pipeline.
PipelineId string
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetPipelineIncludeItem
}
// GetPipelineRunsParams is parameters of getPipelineRuns operation.
type GetPipelineRunsParams struct {
// The ID of the pipeline.
PipelineId string
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetPipelineRunsIncludeItem
}
// GetPipelineTriggerKeyParams is parameters of getPipelineTriggerKey operation.
type GetPipelineTriggerKeyParams struct {
// The ID of the pipeline.
PipelineId string
// The ID of the trigger key.
TriggerKeyId string
}
// GetPipelineTriggerKeysParams is parameters of getPipelineTriggerKeys operation.
type GetPipelineTriggerKeysParams struct {
// The ID of the pipeline.
PipelineId string
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetPipelineTriggerKeysFilter
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetPipelineTriggerKeysPage
}
// GetPipelinesParams is parameters of getPipelines operation.
type GetPipelinesParams struct {
// A comma separated list of include values. Included resources will show up under the root
// document's `include` field, with the key being the id of the included resource. In the case of
// applying an include to a collection of resources, if two resources share the same include, it will
// only appear once in the return.
Include []GetPipelinesIncludeItem
// ## Filter Field
// The filter field is a key-value object, where the key is what you would like to filter, and the
// value is the value you're filtering for.
Filter OptGetPipelinesFilter
// An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
Sort []string
// In a list return, the data associated with the page number and size returned. 20 results per page,
// page 2 would be `page[size]=20&page[number]=2`.
Page OptGetPipelinesPage
}
// GetPoolsIPsParams is parameters of getPoolsIPs operation.
type GetPoolsIPsParams struct {
// The ID for the given pool.
PoolId string
}
// GetProviderParams is parameters of getProvider operation.
type GetProviderParams struct {
// The identifier for the given provider. Example `gcp`, `equinix-metal`, `a-<abstract-provider-id>`,
// etc.
ProviderIdentifier string