Class CreateAttributeDetails
Properties used in attribute create operations.
Inherited Members
Namespace: Oci.DatacatalogService.Models
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class CreateAttributeDetails
Properties
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. |
CustomPropertyMembers
Declaration
[JsonProperty(PropertyName = "customPropertyMembers")]
public List<CustomPropertySetUsage> CustomPropertyMembers { get; set; }
Property Value
Type | Description |
---|---|
List<CustomPropertySetUsage> | The list of customized properties along with the values for this object |
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | Detailed description of the attribute. |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[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. |
Remarks
Required
ExternalDataType
Declaration
[Required(ErrorMessage = "ExternalDataType is required.")]
[JsonProperty(PropertyName = "externalDataType")]
public string ExternalDataType { get; set; }
Property Value
Type | Description |
---|---|
string | Data type of the attribute as defined in the external system. |
Remarks
Required
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. |
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. |
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. |
Length
Declaration
[JsonProperty(PropertyName = "length")]
public long? Length { get; set; }
Property Value
Type | Description |
---|---|
long? | Max allowed length of the attribute value. |
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. |
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. To determine the set of required and optional properties for an attribute type, a query can be done on '/types?type=attribute' that returns a collection of all attribute types. The appropriate attribute type, which will include definitions of all of it's properties, can be identified from this collection. 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. |
TimeExternal
Declaration
[Required(ErrorMessage = "TimeExternal is required.")]
[JsonProperty(PropertyName = "timeExternal")]
public DateTime? TimeExternal { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Last modified timestamp of this object in the external system. |
Remarks
Required
TypeKey
Declaration
[JsonProperty(PropertyName = "typeKey")]
public string TypeKey { get; set; }
Property Value
Type | Description |
---|---|
string | Type key of the object. Type keys can be found via the '/types' endpoint. |