Class Type
Full data catalog type definition. Fully defines a type of the data catalog. All types are statically defined in the system and are immutable. It isn't possible to create new types or update existing types via the API.
Inherited Members
Namespace: Oci.DatacatalogService.Models
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class Type
Properties
CatalogId
Declaration
[JsonProperty(PropertyName = "catalogId")]
public string CatalogId { get; set; }
Property Value
Type | Description |
---|---|
string | The data catalog's OCID. |
CustomProperties
Declaration
[JsonProperty(PropertyName = "customProperties")]
public List<CustomPropertySummary> CustomProperties { get; set; }
Property Value
Type | Description |
---|---|
List<CustomPropertySummary> | Custom properties associated with this Type. |
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | Detailed description of the type. |
ExternalTypeName
Declaration
[JsonProperty(PropertyName = "externalTypeName")]
public string ExternalTypeName { get; set; }
Property Value
Type | Description |
---|---|
string | Mapping type equivalence in the external system. |
IsApproved
Declaration
[JsonProperty(PropertyName = "isApproved")]
public bool? IsApproved { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates whether the type is approved for use as a classifying object. |
IsInternal
Declaration
[JsonProperty(PropertyName = "isInternal")]
public bool? IsInternal { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates whether the type is internal, making it unavailable for use by metadata elements. |
IsTag
Declaration
[JsonProperty(PropertyName = "isTag")]
public bool? IsTag { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates whether the type can be used for tagging metadata elements. |
Key
Declaration
[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }
Property Value
Type | Description |
---|---|
string | Unique type key that is immutable. |
Remarks
Required
LifecycleState
Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
LifecycleState? | The current state of the type. |
Name
Declaration
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | The immutable name of the type. |
ParentTypeKey
Declaration
[JsonProperty(PropertyName = "parentTypeKey")]
public string ParentTypeKey { get; set; }
Property Value
Type | Description |
---|---|
string | Unique key of the parent type. |
ParentTypeName
Declaration
[JsonProperty(PropertyName = "parentTypeName")]
public string ParentTypeName { get; set; }
Property Value
Type | Description |
---|---|
string | Name of the parent type. |
Properties
Declaration
[JsonProperty(PropertyName = "properties")]
public Dictionary<string, List<PropertyDefinition>> Properties { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, List<PropertyDefinition>> | A map of arrays which defines the type specific properties, both required and optional. The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the "default" category. Example: { "properties": { "default": { "attributes:": [ { "name": "host", "type": "string", "isRequired": true, "isUpdatable": false }, ... ] } } } |
TypeCategory
Declaration
[JsonProperty(PropertyName = "typeCategory")]
public string TypeCategory { get; set; }
Property Value
Type | Description |
---|---|
string | Indicates the category this type belongs to. For instance, data assets, connections. |
Uri
Declaration
[JsonProperty(PropertyName = "uri")]
public string Uri { get; set; }
Property Value
Type | Description |
---|---|
string | URI to the type instance in the API. |