-
Notifications
You must be signed in to change notification settings - Fork 80
/
attribute.go
164 lines (121 loc) · 8.19 KB
/
attribute.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
// 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 Catalog API
//
// Use the Data Catalog APIs to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.
// For more information, see Data Catalog (https://docs.oracle.com/iaas/data-catalog/home.htm).
//
package datacatalog
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// Attribute Details of an entity attribute. An attribute of a data entity describing an item of data,
// with a name and data type. Synonymous with 'column' in a database.
type Attribute struct {
// Unique attribute key that is immutable.
Key *string `mandatory:"true" json:"key"`
// A user-friendly display name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.
BusinessName *string `mandatory:"false" json:"businessName"`
// Detailed description of the attribute.
Description *string `mandatory:"false" json:"description"`
// The unique key of the parent entity.
EntityKey *string `mandatory:"false" json:"entityKey"`
// State of the attribute.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,
// see service documentation for details.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The date and time the attribute was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2019-03-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The last time that any change was made to the attribute. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// OCID of the user who created this attribute in the data catalog.
CreatedById *string `mandatory:"false" json:"createdById"`
// OCID of the user who modified this attribute in the data catalog.
UpdatedById *string `mandatory:"false" json:"updatedById"`
// Data type of the attribute as defined in the external system. Type mapping across systems can be achieved
// through term associations across domains in the ontology. The attribute can also be tagged to the datatype in
// the domain ontology to resolve any ambiguity arising from type name similarity that can occur with user
// defined types.
ExternalDataType *string `mandatory:"false" json:"externalDataType"`
// Unique external key of this attribute in the external source system.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// Property that identifies if this attribute can be used as a watermark to extract incremental data.
IsIncrementalData *bool `mandatory:"false" json:"isIncrementalData"`
// Property that identifies if this attribute can be assigned null values.
IsNullable *bool `mandatory:"false" json:"isNullable"`
// The type of the attribute. Type keys can be found via the '/types' endpoint.
TypeKey *string `mandatory:"false" json:"typeKey"`
// The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
MinCollectionCount *int `mandatory:"false" json:"minCollectionCount"`
// The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
// For type specifications in systems that specify only "capacity" without upper or lower bound , this property can also be used to just mean "capacity".
// Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in Xml , maxItems in Json
MaxCollectionCount *int `mandatory:"false" json:"maxCollectionCount"`
// Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
DatatypeEntityKey *string `mandatory:"false" json:"datatypeEntityKey"`
// External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
ExternalDatatypeEntityKey *string `mandatory:"false" json:"externalDatatypeEntityKey"`
// Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype.
ParentAttributeKey *string `mandatory:"false" json:"parentAttributeKey"`
// External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.
ExternalParentAttributeKey *string `mandatory:"false" json:"externalParentAttributeKey"`
// Max allowed length of the attribute value.
Length *int64 `mandatory:"false" json:"length"`
// Position of the attribute in the record definition.
Position *int `mandatory:"false" json:"position"`
// Precision of the attribute value usually applies to float data type.
Precision *int `mandatory:"false" json:"precision"`
// Scale of the attribute value usually applies to float data type.
Scale *int `mandatory:"false" json:"scale"`
// Last modified timestamp of this object in the external system.
TimeExternal *common.SDKTime `mandatory:"false" json:"timeExternal"`
// The date and time the attribute was harvested, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeHarvested *common.SDKTime `mandatory:"false" json:"timeHarvested"`
// List of objects and their relationships to this attribute.
ObjectRelationships []ObjectRelationship `mandatory:"false" json:"objectRelationships"`
// Whether a column is derived or not.
IsDerivedAttribute *bool `mandatory:"false" json:"isDerivedAttribute"`
// URI to the attribute instance in the API.
Uri *string `mandatory:"false" json:"uri"`
// Full path of the attribute.
Path *string `mandatory:"false" json:"path"`
// The list of customized properties along with the values for this object
CustomPropertyMembers []CustomPropertyGetUsage `mandatory:"false" json:"customPropertyMembers"`
// A map of maps that contains the properties which are specific to the attribute type. Each attribute type
// definition defines it's set of required and optional properties. The map keys are category names and the
// values are maps of property name to property value. Every property is contained inside of a category. Most
// attributes have required properties within the "default" category.
// Example: `{"properties": { "default": { "key1": "value1"}}}`
Properties map[string]map[string]string `mandatory:"false" json:"properties"`
// Rule types associated with attribute.
AssociatedRuleTypes []RuleTypeEnum `mandatory:"false" json:"associatedRuleTypes,omitempty"`
}
func (m Attribute) 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 Attribute) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingLifecycleStateEnum(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(GetLifecycleStateEnumStringValues(), ",")))
}
for _, val := range m.AssociatedRuleTypes {
if _, ok := GetMappingRuleTypeEnum(string(val)); !ok && val != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for AssociatedRuleTypes: %s. Supported values are: %s.", val, strings.Join(GetRuleTypeEnumStringValues(), ",")))
}
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}