Class Catalog

A data catalog enables you to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.

Inheritance

object

Catalog

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 Catalog

Properties

AttachedCatalogPrivateEndpoints

Declaration

[JsonProperty(PropertyName = "attachedCatalogPrivateEndpoints")]
public List<string> AttachedCatalogPrivateEndpoints { get; set; }

Property Value

Type	Description
List<string>	The list of private reverse connection endpoints attached to the catalog

CompartmentId

Declaration

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

Property Value

Type	Description
string	Compartment identifier.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration

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

Property Value

Type	Description
string	Data catalog identifier, which can be renamed.

FreeformTags

Declaration

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

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id

Declaration

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

Property Value

Type	Description
string	OCID of the data catalog instance.

Remarks

Required

LifecycleDetails

Declaration

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

Property Value

Type	Description
string	An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.

LifecycleState

Declaration

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

Property Value

Type	Description
LifecycleState?	The current state of the data catalog resource.

Locks

Declaration

[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }

Property Value

Type	Description
List<ResourceLock>	Locks associated with this resource.

NumberOfObjects

Declaration

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

Property Value

Type	Description
int?	The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.

ServiceApiUrl

Declaration

[JsonProperty(PropertyName = "serviceApiUrl")]
public string ServiceApiUrl { get; set; }

Property Value

Type	Description
string	The REST front endpoint URL to the data catalog instance.

ServiceConsoleUrl

Declaration

[JsonProperty(PropertyName = "serviceConsoleUrl")]
public string ServiceConsoleUrl { get; set; }

Property Value

Type	Description
string	The console front endpoint URL to the data catalog instance.

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	The time the data catalog was created. An RFC3339 formatted datetime string.

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The time the data catalog was updated. An RFC3339 formatted datetime string.