Class 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.

Inheritance

object

Attribute

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatacatalogService.Models

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class Attribute

Properties

AssociatedRuleTypes

Declaration

[JsonProperty(PropertyName = "associatedRuleTypes", ItemConverterType = typeof(ResponseEnumConverter))]
public List<RuleType> AssociatedRuleTypes { get; set; }

Property Value

Type	Description
List<RuleType>	Rule types associated with attribute.

BusinessName

Declaration

[JsonProperty(PropertyName = "businessName")]
public string BusinessName { get; set; }

Property Value

Type	Description
string	Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.

CreatedById

Declaration

[JsonProperty(PropertyName = "createdById")]
public string CreatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who created this attribute in the data catalog.

CustomPropertyMembers

Declaration

[JsonProperty(PropertyName = "customPropertyMembers")]
public List<CustomPropertyGetUsage> CustomPropertyMembers { get; set; }

Property Value

Type	Description
List<CustomPropertyGetUsage>	The list of customized properties along with the values for this object

DatatypeEntityKey

Declaration

[JsonProperty(PropertyName = "datatypeEntityKey")]
public string DatatypeEntityKey { get; set; }

Property Value

Type	Description
string	Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	Detailed description of the attribute.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

EntityKey

Declaration

[JsonProperty(PropertyName = "entityKey")]
public string EntityKey { get; set; }

Property Value

Type	Description
string	The unique key of the parent entity.

ExternalDataType

Declaration

[JsonProperty(PropertyName = "externalDataType")]
public string ExternalDataType { get; set; }

Property Value

Type	Description
string	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.

ExternalDatatypeEntityKey

Declaration

[JsonProperty(PropertyName = "externalDatatypeEntityKey")]
public string ExternalDatatypeEntityKey { get; set; }

Property Value

Type	Description
string	External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.

ExternalKey

Declaration

[JsonProperty(PropertyName = "externalKey")]
public string ExternalKey { get; set; }

Property Value

Type	Description
string	Unique external key of this attribute in the external source system.

ExternalParentAttributeKey

Declaration

[JsonProperty(PropertyName = "externalParentAttributeKey")]
public string ExternalParentAttributeKey { get; set; }

Property Value

Type	Description
string	External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.

IsDerivedAttribute

Declaration

[JsonProperty(PropertyName = "isDerivedAttribute")]
public bool? IsDerivedAttribute { get; set; }

Property Value

Type	Description
bool?	Whether a column is derived or not.

IsIncrementalData

Declaration

[JsonProperty(PropertyName = "isIncrementalData")]
public bool? IsIncrementalData { get; set; }

Property Value

Type	Description
bool?	Property that identifies if this attribute can be used as a watermark to extract incremental data.

IsNullable

Declaration

[JsonProperty(PropertyName = "isNullable")]
public bool? IsNullable { get; set; }

Property Value

Type	Description
bool?	Property that identifies if this attribute can be assigned null values.

Key

Declaration

[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }

Property Value

Type	Description
string	Unique attribute key that is immutable.

Remarks

Required

Length

Declaration

[JsonProperty(PropertyName = "length")]
public long? Length { get; set; }

Property Value

Type	Description
long?	Max allowed length of the attribute value.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	State of the attribute.

MaxCollectionCount

Declaration

[JsonProperty(PropertyName = "maxCollectionCount")]
public int? MaxCollectionCount { get; set; }

Property Value

Type

Description

int?

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

MinCollectionCount

Declaration

[JsonProperty(PropertyName = "minCollectionCount")]
public int? MinCollectionCount { get; set; }

Property Value

Type	Description
int?	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.

ObjectRelationships

Declaration

[JsonProperty(PropertyName = "objectRelationships")]
public List<ObjectRelationship> ObjectRelationships { get; set; }

Property Value

Type	Description
List<ObjectRelationship>	List of objects and their relationships to this attribute.

ParentAttributeKey

Declaration

[JsonProperty(PropertyName = "parentAttributeKey")]
public string ParentAttributeKey { get; set; }

Property Value

Type	Description
string	Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype.

Path

Declaration

[JsonProperty(PropertyName = "path")]
public string Path { get; set; }

Property Value

Type	Description
string	Full path of the attribute.

Position

Declaration

[JsonProperty(PropertyName = "position")]
public int? Position { get; set; }

Property Value

Type	Description
int?	Position of the attribute in the record definition.

Precision

Declaration

[JsonProperty(PropertyName = "precision")]
public int? Precision { get; set; }

Property Value

Type	Description
int?	Precision of the attribute value usually applies to float data type.

Properties

Declaration

[JsonProperty(PropertyName = "properties")]
public Dictionary<string, Dictionary<string, string>> Properties { get; set; }

Property Value

Type

Description

Dictionary<string, Dictionary<string, string>>

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"}}}

Scale

Declaration

[JsonProperty(PropertyName = "scale")]
public int? Scale { get; set; }

Property Value

Type	Description
int?	Scale of the attribute value usually applies to float data type.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the attribute was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

TimeExternal

Declaration

[JsonProperty(PropertyName = "timeExternal")]
public DateTime? TimeExternal { get; set; }

Property Value

Type	Description
DateTime?	Last modified timestamp of this object in the external system.

TimeHarvested

Declaration

[JsonProperty(PropertyName = "timeHarvested")]
public DateTime? TimeHarvested { get; set; }

Property Value

Type	Description
DateTime?	The date and time the attribute was harvested, in the format defined by RFC3339.

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The last time that any change was made to the attribute. An RFC3339 formatted datetime string.

TypeKey

Declaration

[JsonProperty(PropertyName = "typeKey")]
public string TypeKey { get; set; }

Property Value

Type	Description
string	The type of the attribute. Type keys can be found via the '/types' endpoint.

UpdatedById

Declaration

[JsonProperty(PropertyName = "updatedById")]
public string UpdatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who modified this attribute in the data catalog.

Uri

Declaration

[JsonProperty(PropertyName = "uri")]
public string Uri { get; set; }

Property Value

Type	Description
string	URI to the attribute instance in the API.