-
Notifications
You must be signed in to change notification settings - Fork 80
/
dataset.go
299 lines (236 loc) · 12.9 KB
/
dataset.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
// Copyright (c) 2016, 2018, 2023, 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.
// Data Labeling API
//
// Use Data Labeling API to create Annotations on Images, Texts & Documents, and generate snapshots.
//
package datalabelingservicedataplane
import (
"encoding/json"
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// Dataset A dataset is a logical collection of records. The dataset contains all the information necessary to describe a record's source, format, the type of annotations allowed for the record, and the labels allowed on annotations.
type Dataset struct {
// The OCID of the Dataset.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment of the resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the resource was created, in the timestamp format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the resource was last updated, in the timestamp format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The state of a dataset.
// CREATING - The dataset is being created. It will transition to ACTIVE when it is ready for labeling.
// ACTIVE - The dataset is ready for labeling.
// UPDATING - The dataset is being updated. It and its related resources may be unavailable for other updates until it returns to ACTIVE.
// NEEDS_ATTENTION - A dataset updation operation has failed due to validation or other errors and needs attention.
// DELETING - The dataset and its related resources are being deleted.
// DELETED - The dataset has been deleted and is no longer available.
// FAILED - The dataset has failed due to validation or other errors.
LifecycleState DatasetLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The annotation format name required for labeling records.
AnnotationFormat *string `mandatory:"true" json:"annotationFormat"`
DatasetSourceDetails DatasetSourceDetails `mandatory:"true" json:"datasetSourceDetails"`
DatasetFormatDetails DatasetFormatDetails `mandatory:"true" json:"datasetFormatDetails"`
LabelSet *LabelSet `mandatory:"true" json:"labelSet"`
// A user-friendly display name for the resource.
DisplayName *string `mandatory:"false" json:"displayName"`
// A user provided description of the dataset
Description *string `mandatory:"false" json:"description"`
// A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in FAILED or NEEDS_ATTENTION state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The sub-state of the dataset.
// IMPORT_DATASET - The dataset is being imported.
LifecycleSubstate DatasetLifecycleSubstateEnum `mandatory:"false" json:"lifecycleSubstate,omitempty"`
InitialRecordGenerationConfiguration *InitialRecordGenerationConfiguration `mandatory:"false" json:"initialRecordGenerationConfiguration"`
InitialImportDatasetConfiguration *InitialImportDatasetConfiguration `mandatory:"false" json:"initialImportDatasetConfiguration"`
// The labeling instructions for human labelers in rich text format
LabelingInstructions *string `mandatory:"false" json:"labelingInstructions"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The usage of system tag keys. These predefined keys are scoped to namespaces.
// For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
AdditionalProperties map[string]string `mandatory:"false" json:"additionalProperties"`
}
func (m Dataset) 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 Dataset) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingDatasetLifecycleStateEnum(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(GetDatasetLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingDatasetLifecycleSubstateEnum(string(m.LifecycleSubstate)); !ok && m.LifecycleSubstate != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleSubstate: %s. Supported values are: %s.", m.LifecycleSubstate, strings.Join(GetDatasetLifecycleSubstateEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// UnmarshalJSON unmarshals from json
func (m *Dataset) UnmarshalJSON(data []byte) (e error) {
model := struct {
DisplayName *string `json:"displayName"`
Description *string `json:"description"`
LifecycleDetails *string `json:"lifecycleDetails"`
LifecycleSubstate DatasetLifecycleSubstateEnum `json:"lifecycleSubstate"`
InitialRecordGenerationConfiguration *InitialRecordGenerationConfiguration `json:"initialRecordGenerationConfiguration"`
InitialImportDatasetConfiguration *InitialImportDatasetConfiguration `json:"initialImportDatasetConfiguration"`
LabelingInstructions *string `json:"labelingInstructions"`
FreeformTags map[string]string `json:"freeformTags"`
DefinedTags map[string]map[string]interface{} `json:"definedTags"`
SystemTags map[string]map[string]interface{} `json:"systemTags"`
AdditionalProperties map[string]string `json:"additionalProperties"`
Id *string `json:"id"`
CompartmentId *string `json:"compartmentId"`
TimeCreated *common.SDKTime `json:"timeCreated"`
TimeUpdated *common.SDKTime `json:"timeUpdated"`
LifecycleState DatasetLifecycleStateEnum `json:"lifecycleState"`
AnnotationFormat *string `json:"annotationFormat"`
DatasetSourceDetails datasetsourcedetails `json:"datasetSourceDetails"`
DatasetFormatDetails datasetformatdetails `json:"datasetFormatDetails"`
LabelSet *LabelSet `json:"labelSet"`
}{}
e = json.Unmarshal(data, &model)
if e != nil {
return
}
var nn interface{}
m.DisplayName = model.DisplayName
m.Description = model.Description
m.LifecycleDetails = model.LifecycleDetails
m.LifecycleSubstate = model.LifecycleSubstate
m.InitialRecordGenerationConfiguration = model.InitialRecordGenerationConfiguration
m.InitialImportDatasetConfiguration = model.InitialImportDatasetConfiguration
m.LabelingInstructions = model.LabelingInstructions
m.FreeformTags = model.FreeformTags
m.DefinedTags = model.DefinedTags
m.SystemTags = model.SystemTags
m.AdditionalProperties = model.AdditionalProperties
m.Id = model.Id
m.CompartmentId = model.CompartmentId
m.TimeCreated = model.TimeCreated
m.TimeUpdated = model.TimeUpdated
m.LifecycleState = model.LifecycleState
m.AnnotationFormat = model.AnnotationFormat
nn, e = model.DatasetSourceDetails.UnmarshalPolymorphicJSON(model.DatasetSourceDetails.JsonData)
if e != nil {
return
}
if nn != nil {
m.DatasetSourceDetails = nn.(DatasetSourceDetails)
} else {
m.DatasetSourceDetails = nil
}
nn, e = model.DatasetFormatDetails.UnmarshalPolymorphicJSON(model.DatasetFormatDetails.JsonData)
if e != nil {
return
}
if nn != nil {
m.DatasetFormatDetails = nn.(DatasetFormatDetails)
} else {
m.DatasetFormatDetails = nil
}
m.LabelSet = model.LabelSet
return
}
// DatasetLifecycleStateEnum Enum with underlying type: string
type DatasetLifecycleStateEnum string
// Set of constants representing the allowable values for DatasetLifecycleStateEnum
const (
DatasetLifecycleStateCreating DatasetLifecycleStateEnum = "CREATING"
DatasetLifecycleStateUpdating DatasetLifecycleStateEnum = "UPDATING"
DatasetLifecycleStateActive DatasetLifecycleStateEnum = "ACTIVE"
DatasetLifecycleStateNeedsAttention DatasetLifecycleStateEnum = "NEEDS_ATTENTION"
DatasetLifecycleStateDeleting DatasetLifecycleStateEnum = "DELETING"
DatasetLifecycleStateDeleted DatasetLifecycleStateEnum = "DELETED"
DatasetLifecycleStateFailed DatasetLifecycleStateEnum = "FAILED"
)
var mappingDatasetLifecycleStateEnum = map[string]DatasetLifecycleStateEnum{
"CREATING": DatasetLifecycleStateCreating,
"UPDATING": DatasetLifecycleStateUpdating,
"ACTIVE": DatasetLifecycleStateActive,
"NEEDS_ATTENTION": DatasetLifecycleStateNeedsAttention,
"DELETING": DatasetLifecycleStateDeleting,
"DELETED": DatasetLifecycleStateDeleted,
"FAILED": DatasetLifecycleStateFailed,
}
var mappingDatasetLifecycleStateEnumLowerCase = map[string]DatasetLifecycleStateEnum{
"creating": DatasetLifecycleStateCreating,
"updating": DatasetLifecycleStateUpdating,
"active": DatasetLifecycleStateActive,
"needs_attention": DatasetLifecycleStateNeedsAttention,
"deleting": DatasetLifecycleStateDeleting,
"deleted": DatasetLifecycleStateDeleted,
"failed": DatasetLifecycleStateFailed,
}
// GetDatasetLifecycleStateEnumValues Enumerates the set of values for DatasetLifecycleStateEnum
func GetDatasetLifecycleStateEnumValues() []DatasetLifecycleStateEnum {
values := make([]DatasetLifecycleStateEnum, 0)
for _, v := range mappingDatasetLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetDatasetLifecycleStateEnumStringValues Enumerates the set of values in String for DatasetLifecycleStateEnum
func GetDatasetLifecycleStateEnumStringValues() []string {
return []string{
"CREATING",
"UPDATING",
"ACTIVE",
"NEEDS_ATTENTION",
"DELETING",
"DELETED",
"FAILED",
}
}
// GetMappingDatasetLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingDatasetLifecycleStateEnum(val string) (DatasetLifecycleStateEnum, bool) {
enum, ok := mappingDatasetLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// DatasetLifecycleSubstateEnum Enum with underlying type: string
type DatasetLifecycleSubstateEnum string
// Set of constants representing the allowable values for DatasetLifecycleSubstateEnum
const (
DatasetLifecycleSubstateImportDataset DatasetLifecycleSubstateEnum = "IMPORT_DATASET"
)
var mappingDatasetLifecycleSubstateEnum = map[string]DatasetLifecycleSubstateEnum{
"IMPORT_DATASET": DatasetLifecycleSubstateImportDataset,
}
var mappingDatasetLifecycleSubstateEnumLowerCase = map[string]DatasetLifecycleSubstateEnum{
"import_dataset": DatasetLifecycleSubstateImportDataset,
}
// GetDatasetLifecycleSubstateEnumValues Enumerates the set of values for DatasetLifecycleSubstateEnum
func GetDatasetLifecycleSubstateEnumValues() []DatasetLifecycleSubstateEnum {
values := make([]DatasetLifecycleSubstateEnum, 0)
for _, v := range mappingDatasetLifecycleSubstateEnum {
values = append(values, v)
}
return values
}
// GetDatasetLifecycleSubstateEnumStringValues Enumerates the set of values in String for DatasetLifecycleSubstateEnum
func GetDatasetLifecycleSubstateEnumStringValues() []string {
return []string{
"IMPORT_DATASET",
}
}
// GetMappingDatasetLifecycleSubstateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingDatasetLifecycleSubstateEnum(val string) (DatasetLifecycleSubstateEnum, bool) {
enum, ok := mappingDatasetLifecycleSubstateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}