forked from Azure/azure-sdk-for-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
models.go
870 lines (783 loc) · 31.5 KB
/
models.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
package documentdb
// Copyright (c) Microsoft and contributors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Code generated by Microsoft (R) AutoRest Code Generator.
// Changes may cause incorrect behavior and will be lost if the code is regenerated.
import (
"encoding/json"
"github.com/Azure/go-autorest/autorest"
"github.com/Azure/go-autorest/autorest/azure"
"github.com/Azure/go-autorest/autorest/date"
"github.com/Azure/go-autorest/autorest/to"
"net/http"
)
// DatabaseAccountKind enumerates the values for database account kind.
type DatabaseAccountKind string
const (
// GlobalDocumentDB ...
GlobalDocumentDB DatabaseAccountKind = "GlobalDocumentDB"
// MongoDB ...
MongoDB DatabaseAccountKind = "MongoDB"
// Parse ...
Parse DatabaseAccountKind = "Parse"
)
// DatabaseAccountOfferType enumerates the values for database account offer type.
type DatabaseAccountOfferType string
const (
// Standard ...
Standard DatabaseAccountOfferType = "Standard"
)
// DefaultConsistencyLevel enumerates the values for default consistency level.
type DefaultConsistencyLevel string
const (
// BoundedStaleness ...
BoundedStaleness DefaultConsistencyLevel = "BoundedStaleness"
// ConsistentPrefix ...
ConsistentPrefix DefaultConsistencyLevel = "ConsistentPrefix"
// Eventual ...
Eventual DefaultConsistencyLevel = "Eventual"
// Session ...
Session DefaultConsistencyLevel = "Session"
// Strong ...
Strong DefaultConsistencyLevel = "Strong"
)
// KeyKind enumerates the values for key kind.
type KeyKind string
const (
// Primary ...
Primary KeyKind = "primary"
// PrimaryReadonly ...
PrimaryReadonly KeyKind = "primaryReadonly"
// Secondary ...
Secondary KeyKind = "secondary"
// SecondaryReadonly ...
SecondaryReadonly KeyKind = "secondaryReadonly"
)
// PrimaryAggregationType enumerates the values for primary aggregation type.
type PrimaryAggregationType string
const (
// Average ...
Average PrimaryAggregationType = "Average"
// Last ...
Last PrimaryAggregationType = "Last"
// Maximum ...
Maximum PrimaryAggregationType = "Maximum"
// Minimimum ...
Minimimum PrimaryAggregationType = "Minimimum"
// None ...
None PrimaryAggregationType = "None"
// Total ...
Total PrimaryAggregationType = "Total"
)
// UnitType enumerates the values for unit type.
type UnitType string
const (
// Bytes ...
Bytes UnitType = "Bytes"
// BytesPerSecond ...
BytesPerSecond UnitType = "BytesPerSecond"
// Count ...
Count UnitType = "Count"
// CountPerSecond ...
CountPerSecond UnitType = "CountPerSecond"
// Milliseconds ...
Milliseconds UnitType = "Milliseconds"
// Percent ...
Percent UnitType = "Percent"
// Seconds ...
Seconds UnitType = "Seconds"
)
// ConsistencyPolicy the consistency policy for the Cosmos DB database account.
type ConsistencyPolicy struct {
// DefaultConsistencyLevel - The default consistency level and configuration settings of the Cosmos DB account. Possible values include: 'Eventual', 'Session', 'BoundedStaleness', 'Strong', 'ConsistentPrefix'
DefaultConsistencyLevel DefaultConsistencyLevel `json:"defaultConsistencyLevel,omitempty"`
// MaxStalenessPrefix - When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
MaxStalenessPrefix *int64 `json:"maxStalenessPrefix,omitempty"`
// MaxIntervalInSeconds - When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
MaxIntervalInSeconds *int32 `json:"maxIntervalInSeconds,omitempty"`
}
// DatabaseAccount an Azure Cosmos DB database account.
type DatabaseAccount struct {
autorest.Response `json:"-"`
// ID - The unique resource identifier of the database account.
ID *string `json:"id,omitempty"`
// Name - The name of the database account.
Name *string `json:"name,omitempty"`
// Type - The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags *map[string]*string `json:"tags,omitempty"`
// Kind - Indicates the type of database account. This can only be set at database account creation. Possible values include: 'GlobalDocumentDB', 'MongoDB', 'Parse'
Kind DatabaseAccountKind `json:"kind,omitempty"`
*DatabaseAccountProperties `json:"properties,omitempty"`
}
// UnmarshalJSON is the custom unmarshaler for DatabaseAccount struct.
func (da *DatabaseAccount) UnmarshalJSON(body []byte) error {
var m map[string]*json.RawMessage
err := json.Unmarshal(body, &m)
if err != nil {
return err
}
var v *json.RawMessage
v = m["kind"]
if v != nil {
var kind DatabaseAccountKind
err = json.Unmarshal(*m["kind"], &kind)
if err != nil {
return err
}
da.Kind = kind
}
v = m["properties"]
if v != nil {
var properties DatabaseAccountProperties
err = json.Unmarshal(*m["properties"], &properties)
if err != nil {
return err
}
da.DatabaseAccountProperties = &properties
}
v = m["id"]
if v != nil {
var ID string
err = json.Unmarshal(*m["id"], &ID)
if err != nil {
return err
}
da.ID = &ID
}
v = m["name"]
if v != nil {
var name string
err = json.Unmarshal(*m["name"], &name)
if err != nil {
return err
}
da.Name = &name
}
v = m["type"]
if v != nil {
var typeVar string
err = json.Unmarshal(*m["type"], &typeVar)
if err != nil {
return err
}
da.Type = &typeVar
}
v = m["location"]
if v != nil {
var location string
err = json.Unmarshal(*m["location"], &location)
if err != nil {
return err
}
da.Location = &location
}
v = m["tags"]
if v != nil {
var tags map[string]*string
err = json.Unmarshal(*m["tags"], &tags)
if err != nil {
return err
}
da.Tags = &tags
}
return nil
}
// DatabaseAccountConnectionString connection string for the Cosmos DB account
type DatabaseAccountConnectionString struct {
// ConnectionString - Value of the connection string
ConnectionString *string `json:"connectionString,omitempty"`
// Description - Description of the connection string
Description *string `json:"description,omitempty"`
}
// DatabaseAccountCreateUpdateParameters parameters to create and update Cosmos DB database accounts.
type DatabaseAccountCreateUpdateParameters struct {
// ID - The unique resource identifier of the database account.
ID *string `json:"id,omitempty"`
// Name - The name of the database account.
Name *string `json:"name,omitempty"`
// Type - The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags *map[string]*string `json:"tags,omitempty"`
// Kind - Indicates the type of database account. This can only be set at database account creation. Possible values include: 'GlobalDocumentDB', 'MongoDB', 'Parse'
Kind DatabaseAccountKind `json:"kind,omitempty"`
*DatabaseAccountCreateUpdateProperties `json:"properties,omitempty"`
}
// UnmarshalJSON is the custom unmarshaler for DatabaseAccountCreateUpdateParameters struct.
func (dacup *DatabaseAccountCreateUpdateParameters) UnmarshalJSON(body []byte) error {
var m map[string]*json.RawMessage
err := json.Unmarshal(body, &m)
if err != nil {
return err
}
var v *json.RawMessage
v = m["kind"]
if v != nil {
var kind DatabaseAccountKind
err = json.Unmarshal(*m["kind"], &kind)
if err != nil {
return err
}
dacup.Kind = kind
}
v = m["properties"]
if v != nil {
var properties DatabaseAccountCreateUpdateProperties
err = json.Unmarshal(*m["properties"], &properties)
if err != nil {
return err
}
dacup.DatabaseAccountCreateUpdateProperties = &properties
}
v = m["id"]
if v != nil {
var ID string
err = json.Unmarshal(*m["id"], &ID)
if err != nil {
return err
}
dacup.ID = &ID
}
v = m["name"]
if v != nil {
var name string
err = json.Unmarshal(*m["name"], &name)
if err != nil {
return err
}
dacup.Name = &name
}
v = m["type"]
if v != nil {
var typeVar string
err = json.Unmarshal(*m["type"], &typeVar)
if err != nil {
return err
}
dacup.Type = &typeVar
}
v = m["location"]
if v != nil {
var location string
err = json.Unmarshal(*m["location"], &location)
if err != nil {
return err
}
dacup.Location = &location
}
v = m["tags"]
if v != nil {
var tags map[string]*string
err = json.Unmarshal(*m["tags"], &tags)
if err != nil {
return err
}
dacup.Tags = &tags
}
return nil
}
// DatabaseAccountCreateUpdateProperties properties to create and update Azure Cosmos DB database accounts.
type DatabaseAccountCreateUpdateProperties struct {
// ConsistencyPolicy - The consistency policy for the Cosmos DB account.
ConsistencyPolicy *ConsistencyPolicy `json:"consistencyPolicy,omitempty"`
// Locations - An array that contains the georeplication locations enabled for the Cosmos DB account.
Locations *[]Location `json:"locations,omitempty"`
DatabaseAccountOfferType *string `json:"databaseAccountOfferType,omitempty"`
// IPRangeFilter - Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
IPRangeFilter *string `json:"ipRangeFilter,omitempty"`
// EnableAutomaticFailover - Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
EnableAutomaticFailover *bool `json:"enableAutomaticFailover,omitempty"`
}
// DatabaseAccountListConnectionStringsResult the connection strings for the given database account.
type DatabaseAccountListConnectionStringsResult struct {
autorest.Response `json:"-"`
// ConnectionStrings - An array that contains the connection strings for the Cosmos DB account.
ConnectionStrings *[]DatabaseAccountConnectionString `json:"connectionStrings,omitempty"`
}
// DatabaseAccountListKeysResult the access keys for the given database account.
type DatabaseAccountListKeysResult struct {
autorest.Response `json:"-"`
// PrimaryMasterKey - Base 64 encoded value of the primary read-write key.
PrimaryMasterKey *string `json:"primaryMasterKey,omitempty"`
// SecondaryMasterKey - Base 64 encoded value of the secondary read-write key.
SecondaryMasterKey *string `json:"secondaryMasterKey,omitempty"`
*DatabaseAccountListReadOnlyKeysResult `json:"properties,omitempty"`
}
// UnmarshalJSON is the custom unmarshaler for DatabaseAccountListKeysResult struct.
func (dalkr *DatabaseAccountListKeysResult) UnmarshalJSON(body []byte) error {
var m map[string]*json.RawMessage
err := json.Unmarshal(body, &m)
if err != nil {
return err
}
var v *json.RawMessage
v = m["primaryMasterKey"]
if v != nil {
var primaryMasterKey string
err = json.Unmarshal(*m["primaryMasterKey"], &primaryMasterKey)
if err != nil {
return err
}
dalkr.PrimaryMasterKey = &primaryMasterKey
}
v = m["secondaryMasterKey"]
if v != nil {
var secondaryMasterKey string
err = json.Unmarshal(*m["secondaryMasterKey"], &secondaryMasterKey)
if err != nil {
return err
}
dalkr.SecondaryMasterKey = &secondaryMasterKey
}
v = m["properties"]
if v != nil {
var properties DatabaseAccountListReadOnlyKeysResult
err = json.Unmarshal(*m["properties"], &properties)
if err != nil {
return err
}
dalkr.DatabaseAccountListReadOnlyKeysResult = &properties
}
return nil
}
// DatabaseAccountListReadOnlyKeysResult the read-only access keys for the given database account.
type DatabaseAccountListReadOnlyKeysResult struct {
autorest.Response `json:"-"`
// PrimaryReadonlyMasterKey - Base 64 encoded value of the primary read-only key.
PrimaryReadonlyMasterKey *string `json:"primaryReadonlyMasterKey,omitempty"`
// SecondaryReadonlyMasterKey - Base 64 encoded value of the secondary read-only key.
SecondaryReadonlyMasterKey *string `json:"secondaryReadonlyMasterKey,omitempty"`
}
// DatabaseAccountPatchParameters parameters for patching Azure Cosmos DB database account properties.
type DatabaseAccountPatchParameters struct {
Tags *map[string]*string `json:"tags,omitempty"`
}
// DatabaseAccountProperties properties for the database account.
type DatabaseAccountProperties struct {
ProvisioningState *string `json:"provisioningState,omitempty"`
// DocumentEndpoint - The connection endpoint for the Cosmos DB database account.
DocumentEndpoint *string `json:"documentEndpoint,omitempty"`
// DatabaseAccountOfferType - The offer type for the Cosmos DB database account. Default value: Standard. Possible values include: 'Standard'
DatabaseAccountOfferType DatabaseAccountOfferType `json:"databaseAccountOfferType,omitempty"`
// IPRangeFilter - Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
IPRangeFilter *string `json:"ipRangeFilter,omitempty"`
// EnableAutomaticFailover - Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
EnableAutomaticFailover *bool `json:"enableAutomaticFailover,omitempty"`
// ConsistencyPolicy - The consistency policy for the Cosmos DB database account.
ConsistencyPolicy *ConsistencyPolicy `json:"consistencyPolicy,omitempty"`
// WriteLocations - An array that contains the write location for the Cosmos DB account.
WriteLocations *[]Location `json:"writeLocations,omitempty"`
// ReadLocations - An array that contains of the read locations enabled for the Cosmos DB account.
ReadLocations *[]Location `json:"readLocations,omitempty"`
// FailoverPolicies - An array that contains the regions ordered by their failover priorities.
FailoverPolicies *[]FailoverPolicy `json:"failoverPolicies,omitempty"`
}
// DatabaseAccountRegenerateKeyParameters parameters to regenerate the keys within the database account.
type DatabaseAccountRegenerateKeyParameters struct {
// KeyKind - The access key to regenerate. Possible values include: 'Primary', 'Secondary', 'PrimaryReadonly', 'SecondaryReadonly'
KeyKind KeyKind `json:"keyKind,omitempty"`
}
// DatabaseAccountsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running
// operation.
type DatabaseAccountsCreateOrUpdateFuture struct {
azure.Future
req *http.Request
}
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
func (future DatabaseAccountsCreateOrUpdateFuture) Result(client DatabaseAccountsClient) (da DatabaseAccount, err error) {
var done bool
done, err = future.Done(client)
if err != nil {
return
}
if !done {
return da, autorest.NewError("documentdb.DatabaseAccountsCreateOrUpdateFuture", "Result", "asynchronous operation has not completed")
}
if future.PollingMethod() == azure.PollingLocation {
da, err = client.CreateOrUpdateResponder(future.Response())
return
}
var resp *http.Response
resp, err = autorest.SendWithSender(client, autorest.ChangeToGet(future.req),
autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
if err != nil {
return
}
da, err = client.CreateOrUpdateResponder(resp)
return
}
// DatabaseAccountsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsDeleteFuture struct {
azure.Future
req *http.Request
}
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
func (future DatabaseAccountsDeleteFuture) Result(client DatabaseAccountsClient) (ar autorest.Response, err error) {
var done bool
done, err = future.Done(client)
if err != nil {
return
}
if !done {
return ar, autorest.NewError("documentdb.DatabaseAccountsDeleteFuture", "Result", "asynchronous operation has not completed")
}
if future.PollingMethod() == azure.PollingLocation {
ar, err = client.DeleteResponder(future.Response())
return
}
var resp *http.Response
resp, err = autorest.SendWithSender(client, autorest.ChangeToGet(future.req),
autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
if err != nil {
return
}
ar, err = client.DeleteResponder(resp)
return
}
// DatabaseAccountsFailoverPriorityChangeFuture an abstraction for monitoring and retrieving the results of a
// long-running operation.
type DatabaseAccountsFailoverPriorityChangeFuture struct {
azure.Future
req *http.Request
}
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
func (future DatabaseAccountsFailoverPriorityChangeFuture) Result(client DatabaseAccountsClient) (ar autorest.Response, err error) {
var done bool
done, err = future.Done(client)
if err != nil {
return
}
if !done {
return ar, autorest.NewError("documentdb.DatabaseAccountsFailoverPriorityChangeFuture", "Result", "asynchronous operation has not completed")
}
if future.PollingMethod() == azure.PollingLocation {
ar, err = client.FailoverPriorityChangeResponder(future.Response())
return
}
var resp *http.Response
resp, err = autorest.SendWithSender(client, autorest.ChangeToGet(future.req),
autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
if err != nil {
return
}
ar, err = client.FailoverPriorityChangeResponder(resp)
return
}
// DatabaseAccountsListResult the List operation response, that contains the database accounts and their properties.
type DatabaseAccountsListResult struct {
autorest.Response `json:"-"`
// Value - List of database account and their properties.
Value *[]DatabaseAccount `json:"value,omitempty"`
}
// DatabaseAccountsPatchFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsPatchFuture struct {
azure.Future
req *http.Request
}
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
func (future DatabaseAccountsPatchFuture) Result(client DatabaseAccountsClient) (da DatabaseAccount, err error) {
var done bool
done, err = future.Done(client)
if err != nil {
return
}
if !done {
return da, autorest.NewError("documentdb.DatabaseAccountsPatchFuture", "Result", "asynchronous operation has not completed")
}
if future.PollingMethod() == azure.PollingLocation {
da, err = client.PatchResponder(future.Response())
return
}
var resp *http.Response
resp, err = autorest.SendWithSender(client, autorest.ChangeToGet(future.req),
autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
if err != nil {
return
}
da, err = client.PatchResponder(resp)
return
}
// DatabaseAccountsRegenerateKeyFuture an abstraction for monitoring and retrieving the results of a long-running
// operation.
type DatabaseAccountsRegenerateKeyFuture struct {
azure.Future
req *http.Request
}
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
func (future DatabaseAccountsRegenerateKeyFuture) Result(client DatabaseAccountsClient) (ar autorest.Response, err error) {
var done bool
done, err = future.Done(client)
if err != nil {
return
}
if !done {
return ar, autorest.NewError("documentdb.DatabaseAccountsRegenerateKeyFuture", "Result", "asynchronous operation has not completed")
}
if future.PollingMethod() == azure.PollingLocation {
ar, err = client.RegenerateKeyResponder(future.Response())
return
}
var resp *http.Response
resp, err = autorest.SendWithSender(client, autorest.ChangeToGet(future.req),
autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
if err != nil {
return
}
ar, err = client.RegenerateKeyResponder(resp)
return
}
// FailoverPolicies the list of new failover policies for the failover priority change.
type FailoverPolicies struct {
// FailoverPolicies - List of failover policies.
FailoverPolicies *[]FailoverPolicy `json:"failoverPolicies,omitempty"`
}
// FailoverPolicy the failover policy for a given region of a database account.
type FailoverPolicy struct {
// ID - The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
ID *string `json:"id,omitempty"`
// LocationName - The name of the region in which the database account exists.
LocationName *string `json:"locationName,omitempty"`
// FailoverPriority - The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
FailoverPriority *int32 `json:"failoverPriority,omitempty"`
}
// Location a region in which the Azure Cosmos DB database account is deployed.
type Location struct {
// ID - The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
ID *string `json:"id,omitempty"`
// LocationName - The name of the region.
LocationName *string `json:"locationName,omitempty"`
// DocumentEndpoint - The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/
DocumentEndpoint *string `json:"documentEndpoint,omitempty"`
ProvisioningState *string `json:"provisioningState,omitempty"`
// FailoverPriority - The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
FailoverPriority *int32 `json:"failoverPriority,omitempty"`
}
// Metric metric data
type Metric struct {
// StartTime - The start time for the metric (ISO-8601 format).
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - The end time for the metric (ISO-8601 format).
EndTime *date.Time `json:"endTime,omitempty"`
// TimeGrain - The time grain to be used to summarize the metric values.
TimeGrain *string `json:"timeGrain,omitempty"`
// Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
Unit UnitType `json:"unit,omitempty"`
// Name - The name information for the metric.
Name *MetricName `json:"name,omitempty"`
// MetricValues - The metric values for the specified time window and timestep.
MetricValues *[]MetricValue `json:"metricValues,omitempty"`
}
// MetricAvailability the availability of the metric.
type MetricAvailability struct {
// TimeGrain - The time grain to be used to summarize the metric values.
TimeGrain *string `json:"timeGrain,omitempty"`
// Retention - The retention for the metric values.
Retention *string `json:"retention,omitempty"`
}
// MetricDefinition the definition of a metric.
type MetricDefinition struct {
// MetricAvailabilities - The list of metric availabilities for the account.
MetricAvailabilities *[]MetricAvailability `json:"metricAvailabilities,omitempty"`
// PrimaryAggregationType - The primary aggregation type of the metric. Possible values include: 'None', 'Average', 'Total', 'Minimimum', 'Maximum', 'Last'
PrimaryAggregationType PrimaryAggregationType `json:"primaryAggregationType,omitempty"`
// Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
Unit UnitType `json:"unit,omitempty"`
// ResourceURI - The resource uri of the database.
ResourceURI *string `json:"resourceUri,omitempty"`
// Name - The name information for the metric.
Name *MetricName `json:"name,omitempty"`
}
// MetricDefinitionsListResult the response to a list metric definitions request.
type MetricDefinitionsListResult struct {
autorest.Response `json:"-"`
// Value - The list of metric definitions for the account.
Value *[]MetricDefinition `json:"value,omitempty"`
}
// MetricListResult the response to a list metrics request.
type MetricListResult struct {
autorest.Response `json:"-"`
// Value - The list of metrics for the account.
Value *[]Metric `json:"value,omitempty"`
}
// MetricName a metric name.
type MetricName struct {
// Value - The name of the metric.
Value *string `json:"value,omitempty"`
// LocalizedValue - The friendly name of the metric.
LocalizedValue *string `json:"localizedValue,omitempty"`
}
// MetricValue represents metrics values.
type MetricValue struct {
// Count - The number of values for the metric.
Count *float64 `json:"_count,omitempty"`
// Average - The average value of the metric.
Average *float64 `json:"average,omitempty"`
// Maximum - The max value of the metric.
Maximum *float64 `json:"maximum,omitempty"`
// Minimum - The min value of the metric.
Minimum *float64 `json:"minimum,omitempty"`
// Timestamp - The metric timestamp (ISO-8601 format).
Timestamp *date.Time `json:"timestamp,omitempty"`
// Total - The total value of the metric.
Total *float64 `json:"total,omitempty"`
}
// Operation REST API operation
type Operation struct {
// Name - Operation name: {provider}/{resource}/{operation}
Name *string `json:"name,omitempty"`
// Display - The object that represents the operation.
Display *OperationDisplay `json:"display,omitempty"`
}
// OperationDisplay the object that represents the operation.
type OperationDisplay struct {
// Provider - Service provider: Microsoft.ResourceProvider
Provider *string `json:"Provider,omitempty"`
// Resource - Resource on which the operation is performed: Profile, endpoint, etc.
Resource *string `json:"Resource,omitempty"`
// Operation - Operation type: Read, write, delete, etc.
Operation *string `json:"Operation,omitempty"`
// Description - Description of operation
Description *string `json:"Description,omitempty"`
}
// OperationListResult result of the request to list Resource Provider operations. It contains a list of operations and
// a URL link to get the next set of results.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - List of operations supported by the Resource Provider.
Value *[]Operation `json:"value,omitempty"`
// NextLink - URL to get the next set of operation list results if there are any.
NextLink *string `json:"nextLink,omitempty"`
}
// OperationListResultIterator provides access to a complete listing of Operation values.
type OperationListResultIterator struct {
i int
page OperationListResultPage
}
// Next advances to the next value. If there was an error making
// the request the iterator does not advance and the error is returned.
func (iter *OperationListResultIterator) Next() error {
iter.i++
if iter.i < len(iter.page.Values()) {
return nil
}
err := iter.page.Next()
if err != nil {
iter.i--
return err
}
iter.i = 0
return nil
}
// NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationListResultIterator) NotDone() bool {
return iter.page.NotDone() && iter.i < len(iter.page.Values())
}
// Response returns the raw server response from the last page request.
func (iter OperationListResultIterator) Response() OperationListResult {
return iter.page.Response()
}
// Value returns the current value or a zero-initialized value if the
// iterator has advanced beyond the end of the collection.
func (iter OperationListResultIterator) Value() Operation {
if !iter.page.NotDone() {
return Operation{}
}
return iter.page.Values()[iter.i]
}
// IsEmpty returns true if the ListResult contains no values.
func (olr OperationListResult) IsEmpty() bool {
return olr.Value == nil || len(*olr.Value) == 0
}
// operationListResultPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (olr OperationListResult) operationListResultPreparer() (*http.Request, error) {
if olr.NextLink == nil || len(to.String(olr.NextLink)) < 1 {
return nil, nil
}
return autorest.Prepare(&http.Request{},
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(olr.NextLink)))
}
// OperationListResultPage contains a page of Operation values.
type OperationListResultPage struct {
fn func(OperationListResult) (OperationListResult, error)
olr OperationListResult
}
// Next advances to the next page of values. If there was an error making
// the request the page does not advance and the error is returned.
func (page *OperationListResultPage) Next() error {
next, err := page.fn(page.olr)
if err != nil {
return err
}
page.olr = next
return nil
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationListResultPage) NotDone() bool {
return !page.olr.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page OperationListResultPage) Response() OperationListResult {
return page.olr
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page OperationListResultPage) Values() []Operation {
if page.olr.IsEmpty() {
return nil
}
return *page.olr.Value
}
// Resource a database account resource.
type Resource struct {
// ID - The unique resource identifier of the database account.
ID *string `json:"id,omitempty"`
// Name - The name of the database account.
Name *string `json:"name,omitempty"`
// Type - The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags *map[string]*string `json:"tags,omitempty"`
}
// Usage the usage data for a usage request.
type Usage struct {
// Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
Unit UnitType `json:"unit,omitempty"`
// Name - The name information for the metric.
Name *MetricName `json:"name,omitempty"`
// QuotaPeriod - The quota period used to summarize the usage values.
QuotaPeriod *string `json:"quotaPeriod,omitempty"`
// Limit - Maximum value for this metric
Limit *int32 `json:"limit,omitempty"`
// CurrentValue - Current value for this metric
CurrentValue *int32 `json:"currentValue,omitempty"`
}
// UsagesResult the response to a list usage request.
type UsagesResult struct {
autorest.Response `json:"-"`
// Value - The list of usages for the database. A usage is a point in time metric
Value *[]Usage `json:"value,omitempty"`
}