forked from Azure/azure-sdk-for-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmodels.go
2916 lines (2631 loc) · 113 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
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
package batchai
// 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"
)
// AllocationState enumerates the values for allocation state.
type AllocationState string
const (
// Resizing ...
Resizing AllocationState = "resizing"
// Steady ...
Steady AllocationState = "steady"
)
// PossibleAllocationStateValues returns an array of possible values for the AllocationState const type.
func PossibleAllocationStateValues() []AllocationState {
return []AllocationState{Resizing, Steady}
}
// CachingType enumerates the values for caching type.
type CachingType string
const (
// None ...
None CachingType = "none"
// Readonly ...
Readonly CachingType = "readonly"
// Readwrite ...
Readwrite CachingType = "readwrite"
)
// PossibleCachingTypeValues returns an array of possible values for the CachingType const type.
func PossibleCachingTypeValues() []CachingType {
return []CachingType{None, Readonly, Readwrite}
}
// DeallocationOption enumerates the values for deallocation option.
type DeallocationOption string
const (
// Requeue ...
Requeue DeallocationOption = "requeue"
// Terminate ...
Terminate DeallocationOption = "terminate"
// Waitforjobcompletion ...
Waitforjobcompletion DeallocationOption = "waitforjobcompletion"
)
// PossibleDeallocationOptionValues returns an array of possible values for the DeallocationOption const type.
func PossibleDeallocationOptionValues() []DeallocationOption {
return []DeallocationOption{Requeue, Terminate, Waitforjobcompletion}
}
// ExecutionState enumerates the values for execution state.
type ExecutionState string
const (
// Failed ...
Failed ExecutionState = "failed"
// Queued ...
Queued ExecutionState = "queued"
// Running ...
Running ExecutionState = "running"
// Succeeded ...
Succeeded ExecutionState = "succeeded"
// Terminating ...
Terminating ExecutionState = "terminating"
)
// PossibleExecutionStateValues returns an array of possible values for the ExecutionState const type.
func PossibleExecutionStateValues() []ExecutionState {
return []ExecutionState{Failed, Queued, Running, Succeeded, Terminating}
}
// FileServerProvisioningState enumerates the values for file server provisioning state.
type FileServerProvisioningState string
const (
// FileServerProvisioningStateCreating ...
FileServerProvisioningStateCreating FileServerProvisioningState = "creating"
// FileServerProvisioningStateDeleting ...
FileServerProvisioningStateDeleting FileServerProvisioningState = "deleting"
// FileServerProvisioningStateFailed ...
FileServerProvisioningStateFailed FileServerProvisioningState = "failed"
// FileServerProvisioningStateSucceeded ...
FileServerProvisioningStateSucceeded FileServerProvisioningState = "succeeded"
// FileServerProvisioningStateUpdating ...
FileServerProvisioningStateUpdating FileServerProvisioningState = "updating"
)
// PossibleFileServerProvisioningStateValues returns an array of possible values for the FileServerProvisioningState const type.
func PossibleFileServerProvisioningStateValues() []FileServerProvisioningState {
return []FileServerProvisioningState{FileServerProvisioningStateCreating, FileServerProvisioningStateDeleting, FileServerProvisioningStateFailed, FileServerProvisioningStateSucceeded, FileServerProvisioningStateUpdating}
}
// FileType enumerates the values for file type.
type FileType string
const (
// FileTypeDirectory ...
FileTypeDirectory FileType = "directory"
// FileTypeFile ...
FileTypeFile FileType = "file"
)
// PossibleFileTypeValues returns an array of possible values for the FileType const type.
func PossibleFileTypeValues() []FileType {
return []FileType{FileTypeDirectory, FileTypeFile}
}
// JobPriority enumerates the values for job priority.
type JobPriority string
const (
// High ...
High JobPriority = "high"
// Low ...
Low JobPriority = "low"
// Normal ...
Normal JobPriority = "normal"
)
// PossibleJobPriorityValues returns an array of possible values for the JobPriority const type.
func PossibleJobPriorityValues() []JobPriority {
return []JobPriority{High, Low, Normal}
}
// ProvisioningState enumerates the values for provisioning state.
type ProvisioningState string
const (
// ProvisioningStateCreating ...
ProvisioningStateCreating ProvisioningState = "creating"
// ProvisioningStateDeleting ...
ProvisioningStateDeleting ProvisioningState = "deleting"
// ProvisioningStateFailed ...
ProvisioningStateFailed ProvisioningState = "failed"
// ProvisioningStateSucceeded ...
ProvisioningStateSucceeded ProvisioningState = "succeeded"
)
// PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
func PossibleProvisioningStateValues() []ProvisioningState {
return []ProvisioningState{ProvisioningStateCreating, ProvisioningStateDeleting, ProvisioningStateFailed, ProvisioningStateSucceeded}
}
// StorageAccountType enumerates the values for storage account type.
type StorageAccountType string
const (
// PremiumLRS ...
PremiumLRS StorageAccountType = "Premium_LRS"
// StandardLRS ...
StandardLRS StorageAccountType = "Standard_LRS"
)
// PossibleStorageAccountTypeValues returns an array of possible values for the StorageAccountType const type.
func PossibleStorageAccountTypeValues() []StorageAccountType {
return []StorageAccountType{PremiumLRS, StandardLRS}
}
// ToolType enumerates the values for tool type.
type ToolType string
const (
// Caffe ...
Caffe ToolType = "caffe"
// Caffe2 ...
Caffe2 ToolType = "caffe2"
// Chainer ...
Chainer ToolType = "chainer"
// Cntk ...
Cntk ToolType = "cntk"
// Custom ...
Custom ToolType = "custom"
// Custommpi ...
Custommpi ToolType = "custommpi"
// Horovod ...
Horovod ToolType = "horovod"
// Tensorflow ...
Tensorflow ToolType = "tensorflow"
)
// PossibleToolTypeValues returns an array of possible values for the ToolType const type.
func PossibleToolTypeValues() []ToolType {
return []ToolType{Caffe, Caffe2, Chainer, Cntk, Custom, Custommpi, Horovod, Tensorflow}
}
// UsageUnit enumerates the values for usage unit.
type UsageUnit string
const (
// Count ...
Count UsageUnit = "Count"
)
// PossibleUsageUnitValues returns an array of possible values for the UsageUnit const type.
func PossibleUsageUnitValues() []UsageUnit {
return []UsageUnit{Count}
}
// VMPriority enumerates the values for vm priority.
type VMPriority string
const (
// Dedicated ...
Dedicated VMPriority = "dedicated"
// Lowpriority ...
Lowpriority VMPriority = "lowpriority"
)
// PossibleVMPriorityValues returns an array of possible values for the VMPriority const type.
func PossibleVMPriorityValues() []VMPriority {
return []VMPriority{Dedicated, Lowpriority}
}
// AppInsightsReference azure Application Insights information for performance counters reporting.
type AppInsightsReference struct {
// Component - Azure Application Insights component resource ID.
Component *ResourceID `json:"component,omitempty"`
// InstrumentationKey - Value of the Azure Application Insights instrumentation key.
InstrumentationKey *string `json:"instrumentationKey,omitempty"`
// InstrumentationKeySecretReference - KeyVault Store and Secret which contains Azure Application Insights instrumentation key. One of instrumentationKey or instrumentationKeySecretReference must be specified.
InstrumentationKeySecretReference *KeyVaultSecretReference `json:"instrumentationKeySecretReference,omitempty"`
}
// AutoScaleSettings auto-scale settings for the cluster. The system automatically scales the cluster up and down
// (within minimumNodeCount and maximumNodeCount) based on the number of queued and running jobs assigned to the
// cluster.
type AutoScaleSettings struct {
// MinimumNodeCount - The minimum number of compute nodes the Batch AI service will try to allocate for the cluster. Note, the actual number of nodes can be less than the specified value if the subscription has not enough quota to fulfill the request.
MinimumNodeCount *int32 `json:"minimumNodeCount,omitempty"`
// MaximumNodeCount - The maximum number of compute nodes the cluster can have.
MaximumNodeCount *int32 `json:"maximumNodeCount,omitempty"`
// InitialNodeCount - The number of compute nodes to allocate on cluster creation. Note that this value is used only during cluster creation. Default: 0.
InitialNodeCount *int32 `json:"initialNodeCount,omitempty"`
}
// AzureBlobFileSystemReference azure Blob Storage Container mounting configuration.
type AzureBlobFileSystemReference struct {
// AccountName - Name of the Azure storage account.
AccountName *string `json:"accountName,omitempty"`
// ContainerName - Name of the Azure Blob Storage container to mount on the cluster.
ContainerName *string `json:"containerName,omitempty"`
// Credentials - Information about the Azure storage credentials.
Credentials *AzureStorageCredentialsInfo `json:"credentials,omitempty"`
// RelativeMountPath - The relative path on the compute node where the Azure File container will be mounted. Note that all cluster level containers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level containers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
RelativeMountPath *string `json:"relativeMountPath,omitempty"`
// MountOptions - Mount options for mounting blobfuse file system.
MountOptions *string `json:"mountOptions,omitempty"`
}
// AzureFileShareReference azure File Share mounting configuration.
type AzureFileShareReference struct {
// AccountName - Name of the Azure storage account.
AccountName *string `json:"accountName,omitempty"`
// AzureFileURL - URL to access the Azure File.
AzureFileURL *string `json:"azureFileUrl,omitempty"`
// Credentials - Information about the Azure storage credentials.
Credentials *AzureStorageCredentialsInfo `json:"credentials,omitempty"`
// RelativeMountPath - The relative path on the compute node where the Azure File share will be mounted. Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
RelativeMountPath *string `json:"relativeMountPath,omitempty"`
// FileMode - File mode for files on the mounted file share. Default value: 0777.
FileMode *string `json:"fileMode,omitempty"`
// DirectoryMode - File mode for directories on the mounted file share. Default value: 0777.
DirectoryMode *string `json:"directoryMode,omitempty"`
}
// AzureStorageCredentialsInfo azure storage account credentials.
type AzureStorageCredentialsInfo struct {
// AccountKey - Storage account key. One of accountKey or accountKeySecretReference must be specified.
AccountKey *string `json:"accountKey,omitempty"`
// AccountKeySecretReference - Information about KeyVault secret storing the storage account key. One of accountKey or accountKeySecretReference must be specified.
AccountKeySecretReference *KeyVaultSecretReference `json:"accountKeySecretReference,omitempty"`
}
// Caffe2Settings caffe2 job settings.
type Caffe2Settings struct {
// PythonScriptFilePath - The python script to execute.
PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
// PythonInterpreterPath - The path to the Python interpreter.
PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
// CommandLineArgs - Command line arguments that need to be passed to the python script.
CommandLineArgs *string `json:"commandLineArgs,omitempty"`
}
// CaffeSettings caffe job settings.
type CaffeSettings struct {
// ConfigFilePath - Path of the config file for the job. This property cannot be specified if pythonScriptFilePath is specified.
ConfigFilePath *string `json:"configFilePath,omitempty"`
// PythonScriptFilePath - Python script to execute. This property cannot be specified if configFilePath is specified.
PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
// PythonInterpreterPath - The path to the Python interpreter. The property can be specified only if the pythonScriptFilePath is specified.
PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
// CommandLineArgs - Command line arguments that need to be passed to the Caffe job.
CommandLineArgs *string `json:"commandLineArgs,omitempty"`
// ProcessCount - Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property
ProcessCount *int32 `json:"processCount,omitempty"`
}
// ChainerSettings chainer job settings.
type ChainerSettings struct {
// PythonScriptFilePath - The python script to execute.
PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
// PythonInterpreterPath - The path to the Python interpreter.
PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
// CommandLineArgs - Command line arguments that need to be passed to the python script.
CommandLineArgs *string `json:"commandLineArgs,omitempty"`
// ProcessCount - Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property
ProcessCount *int32 `json:"processCount,omitempty"`
}
// CloudError an error response from the Batch AI service.
type CloudError struct {
// Error - An error response from the Batch AI service.
Error *CloudErrorBody `json:"error,omitempty"`
}
// CloudErrorBody an error response from the Batch AI service.
type CloudErrorBody struct {
// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
Code *string `json:"code,omitempty"`
// Message - A message describing the error, intended to be suitable for display in a user interface.
Message *string `json:"message,omitempty"`
// Target - The target of the particular error. For example, the name of the property in error.
Target *string `json:"target,omitempty"`
// Details - A list of additional details about the error.
Details *[]CloudErrorBody `json:"details,omitempty"`
}
// Cluster information about a Cluster.
type Cluster struct {
autorest.Response `json:"-"`
// ClusterProperties - The properties associated with the Cluster.
*ClusterProperties `json:"properties,omitempty"`
// ID - The ID of the resource.
ID *string `json:"id,omitempty"`
// Name - The name of the resource.
Name *string `json:"name,omitempty"`
// Type - The type of the resource.
Type *string `json:"type,omitempty"`
}
// MarshalJSON is the custom marshaler for Cluster.
func (c Cluster) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if c.ClusterProperties != nil {
objectMap["properties"] = c.ClusterProperties
}
if c.ID != nil {
objectMap["id"] = c.ID
}
if c.Name != nil {
objectMap["name"] = c.Name
}
if c.Type != nil {
objectMap["type"] = c.Type
}
return json.Marshal(objectMap)
}
// UnmarshalJSON is the custom unmarshaler for Cluster struct.
func (c *Cluster) UnmarshalJSON(body []byte) error {
var m map[string]*json.RawMessage
err := json.Unmarshal(body, &m)
if err != nil {
return err
}
for k, v := range m {
switch k {
case "properties":
if v != nil {
var clusterProperties ClusterProperties
err = json.Unmarshal(*v, &clusterProperties)
if err != nil {
return err
}
c.ClusterProperties = &clusterProperties
}
case "id":
if v != nil {
var ID string
err = json.Unmarshal(*v, &ID)
if err != nil {
return err
}
c.ID = &ID
}
case "name":
if v != nil {
var name string
err = json.Unmarshal(*v, &name)
if err != nil {
return err
}
c.Name = &name
}
case "type":
if v != nil {
var typeVar string
err = json.Unmarshal(*v, &typeVar)
if err != nil {
return err
}
c.Type = &typeVar
}
}
}
return nil
}
// ClusterBaseProperties the properties of a Cluster.
type ClusterBaseProperties struct {
// VMSize - The size of the virtual machines in the cluster. All nodes in a cluster have the same VM size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace see Sizes for Virtual Machines (Linux). Batch AI service supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
VMSize *string `json:"vmSize,omitempty"`
// VMPriority - VM priority. Allowed values are: dedicated (default) and lowpriority. Possible values include: 'Dedicated', 'Lowpriority'
VMPriority VMPriority `json:"vmPriority,omitempty"`
// ScaleSettings - Scale settings for the cluster. Batch AI service supports manual and auto scale clusters.
ScaleSettings *ScaleSettings `json:"scaleSettings,omitempty"`
// VirtualMachineConfiguration - OS image configuration for cluster nodes. All nodes in a cluster have the same OS image.
VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
// NodeSetup - Setup to be performed on each compute node in the cluster.
NodeSetup *NodeSetup `json:"nodeSetup,omitempty"`
// UserAccountSettings - Settings for an administrator user account that will be created on each compute node in the cluster.
UserAccountSettings *UserAccountSettings `json:"userAccountSettings,omitempty"`
// Subnet - Existing virtual network subnet to put the cluster nodes in. Note, if a File Server mount configured in node setup, the File Server's subnet will be used automatically.
Subnet *ResourceID `json:"subnet,omitempty"`
}
// ClusterCreateParameters cluster creation operation.
type ClusterCreateParameters struct {
// ClusterBaseProperties - The properties of the Cluster.
*ClusterBaseProperties `json:"properties,omitempty"`
}
// MarshalJSON is the custom marshaler for ClusterCreateParameters.
func (ccp ClusterCreateParameters) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if ccp.ClusterBaseProperties != nil {
objectMap["properties"] = ccp.ClusterBaseProperties
}
return json.Marshal(objectMap)
}
// UnmarshalJSON is the custom unmarshaler for ClusterCreateParameters struct.
func (ccp *ClusterCreateParameters) UnmarshalJSON(body []byte) error {
var m map[string]*json.RawMessage
err := json.Unmarshal(body, &m)
if err != nil {
return err
}
for k, v := range m {
switch k {
case "properties":
if v != nil {
var clusterBaseProperties ClusterBaseProperties
err = json.Unmarshal(*v, &clusterBaseProperties)
if err != nil {
return err
}
ccp.ClusterBaseProperties = &clusterBaseProperties
}
}
}
return nil
}
// ClusterListResult values returned by the List Clusters operation.
type ClusterListResult struct {
autorest.Response `json:"-"`
// Value - The collection of returned Clusters.
Value *[]Cluster `json:"value,omitempty"`
// NextLink - The continuation token.
NextLink *string `json:"nextLink,omitempty"`
}
// ClusterListResultIterator provides access to a complete listing of Cluster values.
type ClusterListResultIterator struct {
i int
page ClusterListResultPage
}
// 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 *ClusterListResultIterator) 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 ClusterListResultIterator) 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 ClusterListResultIterator) Response() ClusterListResult {
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 ClusterListResultIterator) Value() Cluster {
if !iter.page.NotDone() {
return Cluster{}
}
return iter.page.Values()[iter.i]
}
// IsEmpty returns true if the ListResult contains no values.
func (clr ClusterListResult) IsEmpty() bool {
return clr.Value == nil || len(*clr.Value) == 0
}
// clusterListResultPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (clr ClusterListResult) clusterListResultPreparer() (*http.Request, error) {
if clr.NextLink == nil || len(to.String(clr.NextLink)) < 1 {
return nil, nil
}
return autorest.Prepare(&http.Request{},
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(clr.NextLink)))
}
// ClusterListResultPage contains a page of Cluster values.
type ClusterListResultPage struct {
fn func(ClusterListResult) (ClusterListResult, error)
clr ClusterListResult
}
// 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 *ClusterListResultPage) Next() error {
next, err := page.fn(page.clr)
if err != nil {
return err
}
page.clr = next
return nil
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ClusterListResultPage) NotDone() bool {
return !page.clr.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page ClusterListResultPage) Response() ClusterListResult {
return page.clr
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page ClusterListResultPage) Values() []Cluster {
if page.clr.IsEmpty() {
return nil
}
return *page.clr.Value
}
// ClusterProperties cluster properties.
type ClusterProperties struct {
// VMSize - The size of the virtual machines in the cluster. All nodes in a cluster have the same VM size.
VMSize *string `json:"vmSize,omitempty"`
// VMPriority - VM priority of cluster nodes. Possible values include: 'Dedicated', 'Lowpriority'
VMPriority VMPriority `json:"vmPriority,omitempty"`
// ScaleSettings - Scale settings of the cluster.
ScaleSettings *ScaleSettings `json:"scaleSettings,omitempty"`
// VirtualMachineConfiguration - Virtual machine configuration (OS image) of the compute nodes. All nodes in a cluster have the same OS image configuration.
VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
// NodeSetup - Setup (mount file systems, performance counters settings and custom setup task) to be performed on each compute node in the cluster.
NodeSetup *NodeSetup `json:"nodeSetup,omitempty"`
// UserAccountSettings - Administrator user account settings which can be used to SSH to compute nodes.
UserAccountSettings *UserAccountSettings `json:"userAccountSettings,omitempty"`
// Subnet - Virtual network subnet resource ID the cluster nodes belong to.
Subnet *ResourceID `json:"subnet,omitempty"`
// CreationTime - The time when the cluster was created.
CreationTime *date.Time `json:"creationTime,omitempty"`
// ProvisioningState - Provisioning state of the cluster. Possible value are: creating - Specifies that the cluster is being created. succeeded - Specifies that the cluster has been created successfully. failed - Specifies that the cluster creation has failed. deleting - Specifies that the cluster is being deleted. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateDeleting'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
// ProvisioningStateTransitionTime - Time when the provisioning state was changed.
ProvisioningStateTransitionTime *date.Time `json:"provisioningStateTransitionTime,omitempty"`
// AllocationState - Allocation state of the cluster. Possible values are: steady - Indicates that the cluster is not resizing. There are no changes to the number of compute nodes in the cluster in progress. A cluster enters this state when it is created and when no operations are being performed on the cluster to change the number of compute nodes. resizing - Indicates that the cluster is resizing; that is, compute nodes are being added to or removed from the cluster. Possible values include: 'Steady', 'Resizing'
AllocationState AllocationState `json:"allocationState,omitempty"`
// AllocationStateTransitionTime - The time at which the cluster entered its current allocation state.
AllocationStateTransitionTime *date.Time `json:"allocationStateTransitionTime,omitempty"`
// Errors - Collection of errors encountered by various compute nodes during node setup.
Errors *[]Error `json:"errors,omitempty"`
// CurrentNodeCount - The number of compute nodes currently assigned to the cluster.
CurrentNodeCount *int32 `json:"currentNodeCount,omitempty"`
// NodeStateCounts - Counts of various node states on the cluster.
NodeStateCounts *NodeStateCounts `json:"nodeStateCounts,omitempty"`
}
// ClustersCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ClustersCreateFuture struct {
azure.Future
}
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
func (future *ClustersCreateFuture) Result(client ClustersClient) (c Cluster, err error) {
var done bool
done, err = future.Done(client)
if err != nil {
err = autorest.NewErrorWithError(err, "batchai.ClustersCreateFuture", "Result", future.Response(), "Polling failure")
return
}
if !done {
err = azure.NewAsyncOpIncompleteError("batchai.ClustersCreateFuture")
return
}
sender := autorest.DecorateSender(client, autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
if c.Response.Response, err = future.GetResult(sender); err == nil && c.Response.Response.StatusCode != http.StatusNoContent {
c, err = client.CreateResponder(c.Response.Response)
if err != nil {
err = autorest.NewErrorWithError(err, "batchai.ClustersCreateFuture", "Result", c.Response.Response, "Failure responding to request")
}
}
return
}
// ClustersDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ClustersDeleteFuture struct {
azure.Future
}
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
func (future *ClustersDeleteFuture) Result(client ClustersClient) (ar autorest.Response, err error) {
var done bool
done, err = future.Done(client)
if err != nil {
err = autorest.NewErrorWithError(err, "batchai.ClustersDeleteFuture", "Result", future.Response(), "Polling failure")
return
}
if !done {
err = azure.NewAsyncOpIncompleteError("batchai.ClustersDeleteFuture")
return
}
ar.Response = future.Response()
return
}
// ClusterUpdateParameters cluster update parameters.
type ClusterUpdateParameters struct {
// ClusterUpdateProperties - The properties of the Cluster.
*ClusterUpdateProperties `json:"properties,omitempty"`
}
// MarshalJSON is the custom marshaler for ClusterUpdateParameters.
func (cup ClusterUpdateParameters) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if cup.ClusterUpdateProperties != nil {
objectMap["properties"] = cup.ClusterUpdateProperties
}
return json.Marshal(objectMap)
}
// UnmarshalJSON is the custom unmarshaler for ClusterUpdateParameters struct.
func (cup *ClusterUpdateParameters) UnmarshalJSON(body []byte) error {
var m map[string]*json.RawMessage
err := json.Unmarshal(body, &m)
if err != nil {
return err
}
for k, v := range m {
switch k {
case "properties":
if v != nil {
var clusterUpdateProperties ClusterUpdateProperties
err = json.Unmarshal(*v, &clusterUpdateProperties)
if err != nil {
return err
}
cup.ClusterUpdateProperties = &clusterUpdateProperties
}
}
}
return nil
}
// ClusterUpdateProperties the properties of a Cluster that need to be updated.
type ClusterUpdateProperties struct {
// ScaleSettings - Desired scale settings for the cluster. Batch AI service supports manual and auto scale clusters.
ScaleSettings *ScaleSettings `json:"scaleSettings,omitempty"`
}
// CNTKsettings CNTK (aka Microsoft Cognitive Toolkit) job settings.
type CNTKsettings struct {
// LanguageType - The language to use for launching CNTK (aka Microsoft Cognitive Toolkit) job. Valid values are 'BrainScript' or 'Python'.
LanguageType *string `json:"languageType,omitempty"`
// ConfigFilePath - Specifies the path of the BrainScript config file. This property can be specified only if the languageType is 'BrainScript'.
ConfigFilePath *string `json:"configFilePath,omitempty"`
// PythonScriptFilePath - Python script to execute. This property can be specified only if the languageType is 'Python'.
PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
// PythonInterpreterPath - The path to the Python interpreter. This property can be specified only if the languageType is 'Python'.
PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
// CommandLineArgs - Command line arguments that need to be passed to the python script or cntk executable.
CommandLineArgs *string `json:"commandLineArgs,omitempty"`
// ProcessCount - Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property
ProcessCount *int32 `json:"processCount,omitempty"`
}
// ContainerSettings docker container settings.
type ContainerSettings struct {
// ImageSourceRegistry - Information about docker image and docker registry to download the container from.
ImageSourceRegistry *ImageSourceRegistry `json:"imageSourceRegistry,omitempty"`
// ShmSize - Size of /dev/shm. Please refer to docker documentation for supported argument formats.
ShmSize *string `json:"shmSize,omitempty"`
}
// CustomMpiSettings custom MPI job settings.
type CustomMpiSettings struct {
// CommandLine - The command line to be executed by mpi runtime on each compute node.
CommandLine *string `json:"commandLine,omitempty"`
// ProcessCount - Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property
ProcessCount *int32 `json:"processCount,omitempty"`
}
// CustomToolkitSettings custom tool kit job settings.
type CustomToolkitSettings struct {
// CommandLine - The command line to execute on the master node.
CommandLine *string `json:"commandLine,omitempty"`
}
// DataDisks data disks settings.
type DataDisks struct {
// DiskSizeInGB - Disk size in GB for the blank data disks.
DiskSizeInGB *int32 `json:"diskSizeInGB,omitempty"`
// CachingType - Caching type for the disks. Available values are none (default), readonly, readwrite. Caching type can be set only for VM sizes supporting premium storage. Possible values include: 'None', 'Readonly', 'Readwrite'
CachingType CachingType `json:"cachingType,omitempty"`
// DiskCount - Number of data disks attached to the File Server. If multiple disks attached, they will be configured in RAID level 0.
DiskCount *int32 `json:"diskCount,omitempty"`
// StorageAccountType - Type of storage account to be used on the disk. Possible values are: Standard_LRS or Premium_LRS. Premium storage account type can only be used with VM sizes supporting premium storage. Possible values include: 'StandardLRS', 'PremiumLRS'
StorageAccountType StorageAccountType `json:"storageAccountType,omitempty"`
}
// EnvironmentVariable an environment variable definition.
type EnvironmentVariable struct {
// Name - The name of the environment variable.
Name *string `json:"name,omitempty"`
// Value - The value of the environment variable.
Value *string `json:"value,omitempty"`
}
// EnvironmentVariableWithSecretValue an environment variable with secret value definition.
type EnvironmentVariableWithSecretValue struct {
// Name - The name of the environment variable to store the secret value.
Name *string `json:"name,omitempty"`
// Value - The value of the environment variable. This value will never be reported back by Batch AI.
Value *string `json:"value,omitempty"`
// ValueSecretReference - KeyVault store and secret which contains the value for the environment variable. One of value or valueSecretReference must be provided.
ValueSecretReference *KeyVaultSecretReference `json:"valueSecretReference,omitempty"`
}
// Error an error response from the Batch AI service.
type Error struct {
// Code - An identifier of the error. Codes are invariant and are intended to be consumed programmatically.
Code *string `json:"code,omitempty"`
// Message - A message describing the error, intended to be suitable for display in a user interface.
Message *string `json:"message,omitempty"`
// Details - A list of additional details about the error.
Details *[]NameValuePair `json:"details,omitempty"`
}
// Experiment experiment information.
type Experiment struct {
autorest.Response `json:"-"`
// ExperimentProperties - The properties associated with the experiment.
*ExperimentProperties `json:"properties,omitempty"`
// ID - The ID of the resource.
ID *string `json:"id,omitempty"`
// Name - The name of the resource.
Name *string `json:"name,omitempty"`
// Type - The type of the resource.
Type *string `json:"type,omitempty"`
}
// MarshalJSON is the custom marshaler for Experiment.
func (e Experiment) MarshalJSON() ([]byte, error) {
objectMap := make(map[string]interface{})
if e.ExperimentProperties != nil {
objectMap["properties"] = e.ExperimentProperties
}
if e.ID != nil {
objectMap["id"] = e.ID
}
if e.Name != nil {
objectMap["name"] = e.Name
}
if e.Type != nil {
objectMap["type"] = e.Type
}
return json.Marshal(objectMap)
}
// UnmarshalJSON is the custom unmarshaler for Experiment struct.
func (e *Experiment) UnmarshalJSON(body []byte) error {
var m map[string]*json.RawMessage
err := json.Unmarshal(body, &m)
if err != nil {
return err
}
for k, v := range m {
switch k {
case "properties":
if v != nil {
var experimentProperties ExperimentProperties
err = json.Unmarshal(*v, &experimentProperties)
if err != nil {
return err
}
e.ExperimentProperties = &experimentProperties
}
case "id":
if v != nil {
var ID string
err = json.Unmarshal(*v, &ID)
if err != nil {
return err
}
e.ID = &ID
}
case "name":
if v != nil {
var name string
err = json.Unmarshal(*v, &name)
if err != nil {
return err
}
e.Name = &name
}
case "type":
if v != nil {
var typeVar string
err = json.Unmarshal(*v, &typeVar)
if err != nil {
return err
}
e.Type = &typeVar
}
}
}
return nil
}
// ExperimentListResult values returned by the List operation.
type ExperimentListResult struct {
autorest.Response `json:"-"`
// Value - The collection of experiments.
Value *[]Experiment `json:"value,omitempty"`
// NextLink - The continuation token.
NextLink *string `json:"nextLink,omitempty"`
}
// ExperimentListResultIterator provides access to a complete listing of Experiment values.
type ExperimentListResultIterator struct {
i int
page ExperimentListResultPage
}
// 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 *ExperimentListResultIterator) 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 ExperimentListResultIterator) 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 ExperimentListResultIterator) Response() ExperimentListResult {
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 ExperimentListResultIterator) Value() Experiment {
if !iter.page.NotDone() {
return Experiment{}
}
return iter.page.Values()[iter.i]
}
// IsEmpty returns true if the ListResult contains no values.
func (elr ExperimentListResult) IsEmpty() bool {
return elr.Value == nil || len(*elr.Value) == 0
}
// experimentListResultPreparer prepares a request to retrieve the next set of results.
// It returns nil if no more results exist.
func (elr ExperimentListResult) experimentListResultPreparer() (*http.Request, error) {
if elr.NextLink == nil || len(to.String(elr.NextLink)) < 1 {
return nil, nil
}
return autorest.Prepare(&http.Request{},
autorest.AsJSON(),
autorest.AsGet(),
autorest.WithBaseURL(to.String(elr.NextLink)))
}
// ExperimentListResultPage contains a page of Experiment values.
type ExperimentListResultPage struct {
fn func(ExperimentListResult) (ExperimentListResult, error)
elr ExperimentListResult
}
// 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 *ExperimentListResultPage) Next() error {
next, err := page.fn(page.elr)
if err != nil {
return err
}
page.elr = next
return nil
}
// NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ExperimentListResultPage) NotDone() bool {
return !page.elr.IsEmpty()
}
// Response returns the raw server response from the last page request.
func (page ExperimentListResultPage) Response() ExperimentListResult {
return page.elr
}
// Values returns the slice of values for the current page or nil if there are no values.
func (page ExperimentListResultPage) Values() []Experiment {
if page.elr.IsEmpty() {
return nil
}
return *page.elr.Value
}
// ExperimentProperties experiment properties.
type ExperimentProperties struct {
// CreationTime - Time when the Experiment was created.
CreationTime *date.Time `json:"creationTime,omitempty"`
// ProvisioningState - The provisioned state of the experiment. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateDeleting'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
// ProvisioningStateTransitionTime - The time at which the experiment entered its current provisioning state.
ProvisioningStateTransitionTime *date.Time `json:"provisioningStateTransitionTime,omitempty"`
}
// ExperimentsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExperimentsCreateFuture struct {
azure.Future
}