/
volume_backup.go
275 lines (228 loc) · 12.7 KB
/
volume_backup.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
// 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 (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// VolumeBackup A point-in-time copy of a volume that can then be used to create a new block volume
// or recover a block volume. For more information, see
// Overview of Cloud Volume Storage (https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/overview.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 VolumeBackup struct {
// The OCID of the compartment that contains the volume backup.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the volume backup.
Id *string `mandatory:"true" json:"id"`
// The current state of a volume backup.
LifecycleState VolumeBackupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the volume backup was created. This is the time the actual point-in-time image
// of the volume data was taken. Format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The type of a volume backup.
Type VolumeBackupTypeEnum `mandatory:"true" json:"type"`
// 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"`
// The date and time the volume backup will expire and be automatically deleted.
// Format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). This parameter will always be present for backups that
// were created automatically by a scheduled-backup policy. For manually created backups,
// it will be absent, signifying that there is no expiration time and the backup will
// last forever until manually deleted.
ExpirationTime *common.SDKTime `mandatory:"false" json:"expirationTime"`
// 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 OCID of the Vault service key which is the master encryption key for the volume backup.
// For more information about the Vault service and encryption keys, see
// Overview of Vault service (https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and
// Using Keys (https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).
KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
// The size of the volume, in GBs.
SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`
// 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:"false" json:"sizeInMBs"`
// Specifies whether the backup was created manually, or via scheduled backup policy.
SourceType VolumeBackupSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
// The OCID of the source volume backup.
SourceVolumeBackupId *string `mandatory:"false" json:"sourceVolumeBackupId"`
// The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
TimeRequestReceived *common.SDKTime `mandatory:"false" json:"timeRequestReceived"`
// The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space
// consumed on the volume and whether the backup is full or incremental.
UniqueSizeInGBs *int64 `mandatory:"false" json:"uniqueSizeInGBs"`
// The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space
// consumed on the volume and whether the backup is full or incremental.
// This field is deprecated. Please use uniqueSizeInGBs.
UniqueSizeInMbs *int64 `mandatory:"false" json:"uniqueSizeInMbs"`
// The OCID of the volume.
VolumeId *string `mandatory:"false" json:"volumeId"`
}
func (m VolumeBackup) 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 VolumeBackup) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingVolumeBackupLifecycleStateEnum(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(GetVolumeBackupLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingVolumeBackupTypeEnum(string(m.Type)); !ok && m.Type != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Type: %s. Supported values are: %s.", m.Type, strings.Join(GetVolumeBackupTypeEnumStringValues(), ",")))
}
if _, ok := GetMappingVolumeBackupSourceTypeEnum(string(m.SourceType)); !ok && m.SourceType != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for SourceType: %s. Supported values are: %s.", m.SourceType, strings.Join(GetVolumeBackupSourceTypeEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// VolumeBackupLifecycleStateEnum Enum with underlying type: string
type VolumeBackupLifecycleStateEnum string
// Set of constants representing the allowable values for VolumeBackupLifecycleStateEnum
const (
VolumeBackupLifecycleStateCreating VolumeBackupLifecycleStateEnum = "CREATING"
VolumeBackupLifecycleStateAvailable VolumeBackupLifecycleStateEnum = "AVAILABLE"
VolumeBackupLifecycleStateTerminating VolumeBackupLifecycleStateEnum = "TERMINATING"
VolumeBackupLifecycleStateTerminated VolumeBackupLifecycleStateEnum = "TERMINATED"
VolumeBackupLifecycleStateFaulty VolumeBackupLifecycleStateEnum = "FAULTY"
VolumeBackupLifecycleStateRequestReceived VolumeBackupLifecycleStateEnum = "REQUEST_RECEIVED"
)
var mappingVolumeBackupLifecycleStateEnum = map[string]VolumeBackupLifecycleStateEnum{
"CREATING": VolumeBackupLifecycleStateCreating,
"AVAILABLE": VolumeBackupLifecycleStateAvailable,
"TERMINATING": VolumeBackupLifecycleStateTerminating,
"TERMINATED": VolumeBackupLifecycleStateTerminated,
"FAULTY": VolumeBackupLifecycleStateFaulty,
"REQUEST_RECEIVED": VolumeBackupLifecycleStateRequestReceived,
}
var mappingVolumeBackupLifecycleStateEnumLowerCase = map[string]VolumeBackupLifecycleStateEnum{
"creating": VolumeBackupLifecycleStateCreating,
"available": VolumeBackupLifecycleStateAvailable,
"terminating": VolumeBackupLifecycleStateTerminating,
"terminated": VolumeBackupLifecycleStateTerminated,
"faulty": VolumeBackupLifecycleStateFaulty,
"request_received": VolumeBackupLifecycleStateRequestReceived,
}
// GetVolumeBackupLifecycleStateEnumValues Enumerates the set of values for VolumeBackupLifecycleStateEnum
func GetVolumeBackupLifecycleStateEnumValues() []VolumeBackupLifecycleStateEnum {
values := make([]VolumeBackupLifecycleStateEnum, 0)
for _, v := range mappingVolumeBackupLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetVolumeBackupLifecycleStateEnumStringValues Enumerates the set of values in String for VolumeBackupLifecycleStateEnum
func GetVolumeBackupLifecycleStateEnumStringValues() []string {
return []string{
"CREATING",
"AVAILABLE",
"TERMINATING",
"TERMINATED",
"FAULTY",
"REQUEST_RECEIVED",
}
}
// GetMappingVolumeBackupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingVolumeBackupLifecycleStateEnum(val string) (VolumeBackupLifecycleStateEnum, bool) {
enum, ok := mappingVolumeBackupLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// VolumeBackupSourceTypeEnum Enum with underlying type: string
type VolumeBackupSourceTypeEnum string
// Set of constants representing the allowable values for VolumeBackupSourceTypeEnum
const (
VolumeBackupSourceTypeManual VolumeBackupSourceTypeEnum = "MANUAL"
VolumeBackupSourceTypeScheduled VolumeBackupSourceTypeEnum = "SCHEDULED"
)
var mappingVolumeBackupSourceTypeEnum = map[string]VolumeBackupSourceTypeEnum{
"MANUAL": VolumeBackupSourceTypeManual,
"SCHEDULED": VolumeBackupSourceTypeScheduled,
}
var mappingVolumeBackupSourceTypeEnumLowerCase = map[string]VolumeBackupSourceTypeEnum{
"manual": VolumeBackupSourceTypeManual,
"scheduled": VolumeBackupSourceTypeScheduled,
}
// GetVolumeBackupSourceTypeEnumValues Enumerates the set of values for VolumeBackupSourceTypeEnum
func GetVolumeBackupSourceTypeEnumValues() []VolumeBackupSourceTypeEnum {
values := make([]VolumeBackupSourceTypeEnum, 0)
for _, v := range mappingVolumeBackupSourceTypeEnum {
values = append(values, v)
}
return values
}
// GetVolumeBackupSourceTypeEnumStringValues Enumerates the set of values in String for VolumeBackupSourceTypeEnum
func GetVolumeBackupSourceTypeEnumStringValues() []string {
return []string{
"MANUAL",
"SCHEDULED",
}
}
// GetMappingVolumeBackupSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingVolumeBackupSourceTypeEnum(val string) (VolumeBackupSourceTypeEnum, bool) {
enum, ok := mappingVolumeBackupSourceTypeEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// VolumeBackupTypeEnum Enum with underlying type: string
type VolumeBackupTypeEnum string
// Set of constants representing the allowable values for VolumeBackupTypeEnum
const (
VolumeBackupTypeFull VolumeBackupTypeEnum = "FULL"
VolumeBackupTypeIncremental VolumeBackupTypeEnum = "INCREMENTAL"
)
var mappingVolumeBackupTypeEnum = map[string]VolumeBackupTypeEnum{
"FULL": VolumeBackupTypeFull,
"INCREMENTAL": VolumeBackupTypeIncremental,
}
var mappingVolumeBackupTypeEnumLowerCase = map[string]VolumeBackupTypeEnum{
"full": VolumeBackupTypeFull,
"incremental": VolumeBackupTypeIncremental,
}
// GetVolumeBackupTypeEnumValues Enumerates the set of values for VolumeBackupTypeEnum
func GetVolumeBackupTypeEnumValues() []VolumeBackupTypeEnum {
values := make([]VolumeBackupTypeEnum, 0)
for _, v := range mappingVolumeBackupTypeEnum {
values = append(values, v)
}
return values
}
// GetVolumeBackupTypeEnumStringValues Enumerates the set of values in String for VolumeBackupTypeEnum
func GetVolumeBackupTypeEnumStringValues() []string {
return []string{
"FULL",
"INCREMENTAL",
}
}
// GetMappingVolumeBackupTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingVolumeBackupTypeEnum(val string) (VolumeBackupTypeEnum, bool) {
enum, ok := mappingVolumeBackupTypeEnumLowerCase[strings.ToLower(val)]
return enum, ok
}