/
boot_volume.go
284 lines (228 loc) · 12.1 KB
/
boot_volume.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
// Copyright (c) 2016, 2018, 2024, Oracle and/or its affiliates. All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.
// Core Services API
//
// Use the Core Services API to manage resources such as virtual cloud networks (VCNs),
// compute instances, and block storage volumes. For more information, see the console
// documentation for the Networking (https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/overview.htm),
// Compute (https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm), and
// Block Volume (https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/overview.htm) services.
// The required permissions are documented in the
// Details for the Core Services (https://docs.cloud.oracle.com/iaas/Content/Identity/Reference/corepolicyreference.htm) article.
//
package core
import (
"encoding/json"
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// BootVolume A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see
// Overview of Boot Volumes (https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/bootvolumes.htm).
// To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
// talk to an administrator. If you're an administrator who needs to write policies to give users access, see
// Getting Started with Policies (https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
// **Warning:** Oracle recommends that you avoid using any confidential information when you
// supply string values using the API.
type BootVolume struct {
// The availability domain of the boot volume.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The OCID of the compartment that contains the boot volume.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The boot volume's Oracle ID (OCID).
Id *string `mandatory:"true" json:"id"`
// The current state of a boot volume.
LifecycleState BootVolumeLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The size of the volume in MBs. The value must be a multiple of 1024.
// This field is deprecated. Please use sizeInGBs.
SizeInMBs *int64 `mandatory:"true" json:"sizeInMBs"`
// The date and time the boot volume was created. Format defined
// by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Defined tags for this resource. Each key is predefined and scoped to a
// namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no
// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The image OCID used to create the boot volume.
ImageId *string `mandatory:"false" json:"imageId"`
// Specifies whether the boot volume's data has finished copying
// from the source boot volume or boot volume backup.
IsHydrated *bool `mandatory:"false" json:"isHydrated"`
// The number of volume performance units (VPUs) that will be applied to this boot volume per GB,
// representing the Block Volume service's elastic performance options.
// See Block Volume Performance Levels (https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.
// Allowed values:
// * `10`: Represents Balanced option.
// * `20`: Represents Higher Performance option.
// * `30`-`120`: Represents the Ultra High Performance option.
// For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.
VpusPerGB *int64 `mandatory:"false" json:"vpusPerGB"`
// The size of the boot volume in GBs.
SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`
SourceDetails BootVolumeSourceDetails `mandatory:"false" json:"sourceDetails"`
// The OCID of the source volume group.
VolumeGroupId *string `mandatory:"false" json:"volumeGroupId"`
// The OCID of the Vault service master encryption key assigned to the boot volume.
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated.
// Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.
IsAutoTuneEnabled *bool `mandatory:"false" json:"isAutoTuneEnabled"`
// The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
AutoTunedVpusPerGB *int64 `mandatory:"false" json:"autoTunedVpusPerGB"`
// The list of boot volume replicas of this boot volume
BootVolumeReplicas []BootVolumeReplicaInfo `mandatory:"false" json:"bootVolumeReplicas"`
// The list of autotune policies enabled for this volume.
AutotunePolicies []AutotunePolicy `mandatory:"false" json:"autotunePolicies"`
}
func (m BootVolume) String() string {
return common.PointerString(m)
}
// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m BootVolume) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingBootVolumeLifecycleStateEnum(string(m.LifecycleState)); !ok && m.LifecycleState != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleState: %s. Supported values are: %s.", m.LifecycleState, strings.Join(GetBootVolumeLifecycleStateEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// UnmarshalJSON unmarshals from json
func (m *BootVolume) UnmarshalJSON(data []byte) (e error) {
model := struct {
DefinedTags map[string]map[string]interface{} `json:"definedTags"`
SystemTags map[string]map[string]interface{} `json:"systemTags"`
DisplayName *string `json:"displayName"`
FreeformTags map[string]string `json:"freeformTags"`
ImageId *string `json:"imageId"`
IsHydrated *bool `json:"isHydrated"`
VpusPerGB *int64 `json:"vpusPerGB"`
SizeInGBs *int64 `json:"sizeInGBs"`
SourceDetails bootvolumesourcedetails `json:"sourceDetails"`
VolumeGroupId *string `json:"volumeGroupId"`
KmsKeyId *string `json:"kmsKeyId"`
IsAutoTuneEnabled *bool `json:"isAutoTuneEnabled"`
AutoTunedVpusPerGB *int64 `json:"autoTunedVpusPerGB"`
BootVolumeReplicas []BootVolumeReplicaInfo `json:"bootVolumeReplicas"`
AutotunePolicies []autotunepolicy `json:"autotunePolicies"`
AvailabilityDomain *string `json:"availabilityDomain"`
CompartmentId *string `json:"compartmentId"`
Id *string `json:"id"`
LifecycleState BootVolumeLifecycleStateEnum `json:"lifecycleState"`
SizeInMBs *int64 `json:"sizeInMBs"`
TimeCreated *common.SDKTime `json:"timeCreated"`
}{}
e = json.Unmarshal(data, &model)
if e != nil {
return
}
var nn interface{}
m.DefinedTags = model.DefinedTags
m.SystemTags = model.SystemTags
m.DisplayName = model.DisplayName
m.FreeformTags = model.FreeformTags
m.ImageId = model.ImageId
m.IsHydrated = model.IsHydrated
m.VpusPerGB = model.VpusPerGB
m.SizeInGBs = model.SizeInGBs
nn, e = model.SourceDetails.UnmarshalPolymorphicJSON(model.SourceDetails.JsonData)
if e != nil {
return
}
if nn != nil {
m.SourceDetails = nn.(BootVolumeSourceDetails)
} else {
m.SourceDetails = nil
}
m.VolumeGroupId = model.VolumeGroupId
m.KmsKeyId = model.KmsKeyId
m.IsAutoTuneEnabled = model.IsAutoTuneEnabled
m.AutoTunedVpusPerGB = model.AutoTunedVpusPerGB
m.BootVolumeReplicas = make([]BootVolumeReplicaInfo, len(model.BootVolumeReplicas))
copy(m.BootVolumeReplicas, model.BootVolumeReplicas)
m.AutotunePolicies = make([]AutotunePolicy, len(model.AutotunePolicies))
for i, n := range model.AutotunePolicies {
nn, e = n.UnmarshalPolymorphicJSON(n.JsonData)
if e != nil {
return e
}
if nn != nil {
m.AutotunePolicies[i] = nn.(AutotunePolicy)
} else {
m.AutotunePolicies[i] = nil
}
}
m.AvailabilityDomain = model.AvailabilityDomain
m.CompartmentId = model.CompartmentId
m.Id = model.Id
m.LifecycleState = model.LifecycleState
m.SizeInMBs = model.SizeInMBs
m.TimeCreated = model.TimeCreated
return
}
// BootVolumeLifecycleStateEnum Enum with underlying type: string
type BootVolumeLifecycleStateEnum string
// Set of constants representing the allowable values for BootVolumeLifecycleStateEnum
const (
BootVolumeLifecycleStateProvisioning BootVolumeLifecycleStateEnum = "PROVISIONING"
BootVolumeLifecycleStateRestoring BootVolumeLifecycleStateEnum = "RESTORING"
BootVolumeLifecycleStateAvailable BootVolumeLifecycleStateEnum = "AVAILABLE"
BootVolumeLifecycleStateTerminating BootVolumeLifecycleStateEnum = "TERMINATING"
BootVolumeLifecycleStateTerminated BootVolumeLifecycleStateEnum = "TERMINATED"
BootVolumeLifecycleStateFaulty BootVolumeLifecycleStateEnum = "FAULTY"
)
var mappingBootVolumeLifecycleStateEnum = map[string]BootVolumeLifecycleStateEnum{
"PROVISIONING": BootVolumeLifecycleStateProvisioning,
"RESTORING": BootVolumeLifecycleStateRestoring,
"AVAILABLE": BootVolumeLifecycleStateAvailable,
"TERMINATING": BootVolumeLifecycleStateTerminating,
"TERMINATED": BootVolumeLifecycleStateTerminated,
"FAULTY": BootVolumeLifecycleStateFaulty,
}
var mappingBootVolumeLifecycleStateEnumLowerCase = map[string]BootVolumeLifecycleStateEnum{
"provisioning": BootVolumeLifecycleStateProvisioning,
"restoring": BootVolumeLifecycleStateRestoring,
"available": BootVolumeLifecycleStateAvailable,
"terminating": BootVolumeLifecycleStateTerminating,
"terminated": BootVolumeLifecycleStateTerminated,
"faulty": BootVolumeLifecycleStateFaulty,
}
// GetBootVolumeLifecycleStateEnumValues Enumerates the set of values for BootVolumeLifecycleStateEnum
func GetBootVolumeLifecycleStateEnumValues() []BootVolumeLifecycleStateEnum {
values := make([]BootVolumeLifecycleStateEnum, 0)
for _, v := range mappingBootVolumeLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetBootVolumeLifecycleStateEnumStringValues Enumerates the set of values in String for BootVolumeLifecycleStateEnum
func GetBootVolumeLifecycleStateEnumStringValues() []string {
return []string{
"PROVISIONING",
"RESTORING",
"AVAILABLE",
"TERMINATING",
"TERMINATED",
"FAULTY",
}
}
// GetMappingBootVolumeLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingBootVolumeLifecycleStateEnum(val string) (BootVolumeLifecycleStateEnum, bool) {
enum, ok := mappingBootVolumeLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}