Class TypeSummary
Summary data catalog type information. 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 TypeSummary
Properties
CatalogId
Declaration
[JsonProperty(PropertyName = "catalogId")]
public string CatalogId { get; set; }
Property Value
Type | Description |
---|---|
string | The data catalog's OCID. |
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | Detailed description of the type. |
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? | State of the folder. |
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. |
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. |