Namespace Oci.DatacatalogService.Models

Classes

AsynchronousExportDataAssetDetails

Details needed by the Data Asset export request.

AsynchronousExportDataAssetResult

Details about the job which performs an export.

AsynchronousExportGlossaryDetails

Details needed by the glossary export request.

AsynchronousExportGlossaryResult

Details about the job which performs an export.

AsynchronousExportRequestDetails

Details for an export request.

AsynchronousExportResult

Details about the job which performs an export.

AttachCatalogPrivateEndpointDetails

Information about the attaching the private endpoint resource to a catalog

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.

AttributeCollection

Results of an attributes listing. Attributes describe an item of data with name and datatype.

AttributeTag

Represents an association of an entity attribute to a term.

AttributeTagCollection

Results of an attribute tags listing. Attribnute tags allow association of business terms with attributes.

BasePermissionsSummary

Permissions object sent as part of the response.

BaseTag

Represents the association of an object to a term. Tags are immutable.

BaseTagSummary

Represents the association of an object to a term.

Catalog

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

CatalogPrivateEndpoint

A private network reverse connection creates a connection from service to customer subnet over a private network.

CatalogPrivateEndpointSummary

A private network reverse connection creates a connection from service to customer subnet over a private network.

ChangeCatalogCompartmentDetails

Information about the change compartment

ChangeCatalogPrivateEndpointCompartmentDetails

Information about the change compartment for the private endpoint resource

ChangeMetastoreCompartmentDetails

Information about a change in metastore compartment.

Connection

Detailed representation of a connection to a data asset, minus any sensitive properties.

ConnectionAliasSummary

Summary representation of database aliases parsed from the file metadata.

ConnectionCollection

Results of a connections listing. Each member of the result is a summary representation of a connection to a data asset.

ConnectionSummary

Summary representation of a connection to a data asset.

CreateAttributeDetails

Properties used in attribute create operations.

CreateCatalogDetails

The information about a new data catalog.

CreateCatalogPrivateEndpointDetails

Information about the new private endpoint resource

CreateConnectionDetails

Properties used in connection create operations.

CreateCustomPropertyDetails

Properties used in custom property create operations.

CreateDataAssetDetails

Properties used in data asset create operations.

CreateEntityDetails

Properties used in data entity create operations.

CreateFolderDetails

Properties used in folder create operations.

CreateGlossaryDetails

Properties used in glossary create operations.

Representation of a job definition Resource. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. The list of objects is usually specified through a combination of object type, regular expressions, or specific names of objects and a sample size for the data harvested.

CreateJobDetails

Properties used to create a job.

CreateJobExecutionDetails

Properties for creating a new job execution.

CreateMetastoreDetails

Information about a new metastore.

CreateNamespaceDetails

Properties used in custom property create operations.

CreatePatternDetails

Properties used in pattern create operations.

CreateTagDetails

Properties used in tag create operations.

CreateTermDetails

Properties used in term create operations.

CreateTermRelationshipDetails

Properties used in term relationship create operations.

CustomProperty

Custom Property Definition

CustomPropertyCollection

Results of a custom properties listing. A custom property is an user defined attribute tied to the first class object of data catalog

CustomPropertyGetUsage

Details of a single custom property

CustomPropertySetUsage

Details of a single custom property.

CustomPropertySummary

Summary of a custom property

CustomPropertyTypeUsage

Object which describes the indivial object stats for every custom property

DataAsset

Data asset representation. A physical store, or stream, of data known to the data catalog and containing one or many data entities, possibly in an organized structure of folders. A data asset is often synonymous with a 'System', such as a database, or may be a file container or a message stream.

DataAssetCollection

Results of a data assets listing. A data asset is often synonymous with a 'System', such as a database, or may be a file container or a message stream.

DataAssetExportScope

Scope of asset export, which consists of a container object (bucket, folder, schema, etc) within the asset, and types of child objects contained by that object to be included. objectKey - Key of the container object to be exported. For example, key of schema_1. exportTypeIds - Type key(s) of objects within the container object to be exported. For example, type key of table or view.

DataAssetPermissionsSummary

Permissions object for data assets.

DataAssetSummary

Summary of a data asset. A physical store, or stream, of data known to the data catalog and containing one or many data entities, possibly in an organized structure of folders. A data asset is often synonymous with a 'System', such as a database, or may be a file container or a message stream.

DataAssetTag

Represents an association of a data asset to a term.

DataAssetTagCollection

Results of a data asset tag listing. Data asset tags represent an association of a data asset to a term.

DataAssetTagSummary

Summary of a data asset tag.

DataSelectorPatternDetails

List of pattern Ids. Used in the addition and removal of patterns in data assets.

DerivedLogicalEntities

Entities derived from the application of a pattern to a list of file paths.

DetachCatalogPrivateEndpointDetails

Information about the detaching the private endpoint resource from a catalog

Entity

Data entity details. A representation of data with a set of attributes, normally representing a single business entity. Synonymous with 'table' or 'view' in a database, or a single logical file structure that one or many files may match.

EntityCollection

Results of a data entities listing. Data entities are representation of a dataset with a set of attributes.

EntityLineage

Lineage for a data entity.

EntitySummary

Summary of an data entity. A representation of data with a set of attributes, normally representing a single business entity. Synonymous with 'table' or 'view' in a database, or a single logical file structure that one or many files may match.

EntityTag

Represents an association of an entity to a term.

EntityTagCollection

Results of an entity tags listing. Entity tags allow assciation of business terms with entities.

EntityTagSummary

Summary of an entity tag.

EventConfig

Describes an event configuration, for a given object type and property. Primarily, whether a property change will result in an event being emitted.

ExportDataAssetDetails

The details of what needs to be exported.

FacetedSearchAggregation

Aggregation/facets on properties of data object.

FacetedSearchCustomProperty

Details about custom property

FacetedSearchDateFilterRequest

Object with date filter criteria

FacetedSearchFilterRequest

Object with details about filter criteria.

FacetedSearchSortRequest

Object with sort criteria details

FacetedSearchStringFilterRequest

Object with string filter criteria

FetchEntityLineageDetails

The information needed to obtain desired lineage.

Folder

A generic term used in the data catalog for an external organization concept used for a collection of data entities or processes within a data asset. This term is an internal term which models multiple external types of folder, such as file directories, database schemas, and so on. Some data assets, such as Object Store containers, may contain many levels of folders.

FolderCollection

Results of a folders listing. Folders are external organization concept that groups data entities.

FolderSummary

Summary of a folder. A generic term used in the data catalog for an external organization concept used for a collection of data entities or processes within a data asset. This term is an internal term which models multiple external types of folder, such as file directories, database schemas, and so on. Some data assets, such as Object Store containers, may contain many levels of folders.

FolderTag

Represents an association of a folder to a term.

FolderTagCollection

Results of a folders tag listing. Folder tags allow association of folder objects to business terms.

FolderTagSummary

Summary of a folder tag.

Glossary

Full glossary details. A glossary of business terms, such as 'Customer', 'Account', 'Contact' , 'Address', or 'Product', with definitions, used to provide common meaning across disparate data assets. Business glossaries may be hierarchical where some terms may contain child terms to allow them to be used as 'taxonomies'. By linking data assets, data entities, and attributes to glossaries and glossary terms, the glossary can act as a way of organizing data catalog objects in a hierarchy to make a large number of objects more navigable and easier to consume. Objects in the data aatalog, such as data assets or data entities, may be linked to any level in the glossary, so that the glossary can be used to browse the available data according to the business model of the organization.

GlossaryCollection

Results of a glossaries listing. Glossary is an organizing concept for business terms to provide a unified semantic model across disparate data assets.

GlossaryPermissionsSummary

Permissions object for glosssaries.

GlossarySummary

Summary of a glossary. A glossary of business terms, such as 'Customer', 'Account', 'Contact', 'Address', or 'Product', with definitions, used to provide common meaning across disparate data assets. Business glossaries may be hierarchical where some terms may contain child terms to allow them to be used as 'taxonomies'. By linking data assets, data entities, and attributes to glossaries and glossary terms, the glossary can act as a way of organizing data catalog objects in a hierarchy to make a large number of objects more navigable and easier to consume. Objects in the data catalog, such as data assets or data entities, may be linked to any level in the glossary, so that the glossary can be used to browse the available data according to the business model of the organization.

GlossaryTreeElement

Glossary tree element with child terms.

ImportConnectionDetails

Import connection from the connection metadata and oracle wallet file.

ImportDataAssetDetails

Specifies the file contents to be imported.

ImportDataAssetJobResult

Information about a data asset import operation.

ImportGlossaryDetails

Import glossary from the contents of the glossary definition file.

ImportLineageDetails

Specifies the lineage contents to be imported.

ImportLineageJobResult

Information about lineage import operation.

Job

Details of a job. Jobs are scheduled instances of a job definition.

JobCollection

Results of a jobs listing. Jobs are scheduled instances of a job definition.

JobDefinition

Representation of a job definition resource. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. The list of objects is usually specified through a combination of object type, regular expressions, or specific names of objects and a sample size for the data harvested.

JobDefinitionCollection

Results of a job definition listing. Job definitions are resources that describe the scope and type of jobs (eg: harvest, profiling, sampling) that are defined by users in the system.

JobDefinitionPermissionsSummary

Permissions object for job definitions.

JobDefinitionScope

Defines the rules or criteria based on which the scope for job definition is circumscribed.

JobDefinitionSummary

A list of job definition resources. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. The list of objects is usually specified through a combination of object type, regular expressions, or specific names of objects and a sample size for the data harvested.

JobExecution

A job execution is a unit of work being executed on behalf of a job.

JobExecutionCollection

Results of a job executions listing. Job executions are execution instances of a scheduled job.

JobExecutionSummary

A list of job executions. A job execution is a unit of work being executed on behalf of a job.

JobLog

Job log details. A job log is an audit log record inserted during the lifecycle of a job execution instance.

JobLogCollection

Results of a job logs Listing. A job log is an audit log record inserted during the lifecycle of a job execution instance.

JobLogSummary

A list of job execution logs. A job log is an audit log record inserted during the lifecycle of a job execution instance. There can be one or more logs for an execution instance.

JobMetric

A set of metrics are collected periodically to assess the state and performance characteristics of the execution instance of a job. The metrics are grouped based on their category and sub categories and aggregated based on their batch information.

JobMetricCollection

Results of a job metrics listing. Job metrics are datum about a job execution in key value pairs.

JobMetricSummary

Job metric summary.

JobSummary

Details of a job. Jobs are scheduled instances of a job definition.

LineageObject

Object describing an individual element of object lineage.

LineageRelationship

Declares how two elements of object lineage are related.

Metastore

A Data Catalog Metastore provides a centralized metastore repository for use by other OCI services.

MetastoreSummary

Summary of a metastore.

Namespace

Namespace Definition

NamespaceCollection

Results of a namespaces listing. A namespace is an unique name tied to the first class object of data catalog which will be used to create a custom property

NamespaceSummary

Summary of a namespace

ObjectLineage

Lineage for an object.

ObjectLineageRequestDetails

Details needed by a lineage fetch request.

ObjectRelationship

Details regarding a specific object and its relationship to the referencing object.

ObjectStorageObjectReference

A reference to an Object Storage object.

ParseConnectionDetails

Parse connections from the connection metadata and Oracle wallet file. An error will be returned if more than one of connectionPayload, walletSecretId or walletSecretName are present in the request.

Pattern

A pattern is a data selector or filter which can provide a singular, logical entity view aggregating multiple physical data artifacts for ease of use.

PatternCollection

Results of a pattern listing. Patterns are used in entity harvesting.

PatternSummary

Summary of a pattern. A pattern is a data selector or filter which can provide a singular, logical entity view aggregating multiple physical data artifacts for ease of use.

ProcessRecommendationDetails

Details of recommendation to be processed.

PropertyDefinition

Details of a single type property.

RecommendationCollection

Results of a get recommendation.

RecommendationDetails

Details of a recommendation.

RemoveResourceLockDetails

ResourceLock

Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.

RuleAttribute

Object that defines a usage of an attribute in the context of a rule. Example: For a UNIQUEKEY rule, declares the attribute in a table whose value must be unique.

RuleCollection

Results of an rule listing. Rules describe an item of data with name and ruletype.

RuleSummary

A list of rule resources. One or more rules can be defined for a data entity. Each rule can be defined on one or more attributes of the data entity.

SearchCriteria

Search Query object that allows complex search predicates that cannot be expressed through simple query params.

SearchResult

The search result object is the definition of an element that is returned as part of search. It contains basic information about the object such as key, name and description. The search result also contains the list of tags for each object along with other contextual information like the data asset root, folder, or entity parents.

SearchResultCollection

The list of search result items matching the criteria returned from the search operation. Search errors and messages, if any , will be part of the standard error response.

SearchTagSummary

Represents the association of an object to a term. Returned as part of search result.

SearchTermSummary

Summary of a term associated with an object. This is a brief summary returned as part of the search result.

SuggestListItem

Details of a potential match returned from the suggest operation for the given input text. by the limit parameter.

SuggestResults

The list of potential matches returned from the suggest operation for the given input text. The size of the list will be determined by the limit parameter.

Term

Full term definition. A defined business term in a business glossary. As well as a term definition, simple format rules for attributes mapping to the term (for example, the expected data type and length restrictions) may be stated at the term level. Nesting of terms to support a hierarchy is supported by default.

TermAssociatedObject

Projection of an object that is tagged to a term.

TermCollection

Results of a terms listing. Terms are defined in business glossary and are used in tagging catalog objects.

TermRelationship

Full term relationship definition. Business term relationship between two terms in a business glossary.

TermRelationshipCollection

Results of a terms relationship listing. Term relationships are associations between two terms in business glossary.

TermRelationshipSummary

Summary of a term relationship. Business term relationship between two terms in a business glossary.

TermSummary

Summary of a term. A defined business term in a business glossary. As well as a term definition, simple format rules for attributes mapping to the term (for example, the expected data type and length restrictions) may be stated at the term level.

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.

TypeCollection

Results of a types listing. Types define the basic type of catalog objects and are immutable.

TypeCustomPropertyDetails

Array of custom property IDs for which we have to associate the custom property to the type

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.

UpdateAttributeDetails

Properties used in attribute update operations.

UpdateCatalogDetails

The information to be updated for catalog resource.

UpdateCatalogPrivateEndpointDetails

Information about the modified private endpoint resource

UpdateConnectionDetails

Properties used in connection update operations.

UpdateCustomPropertyDetails

Properties used in custom atrribute update operations.

UpdateDataAssetDetails

Properties used in data asset update operations.

UpdateEntityDetails

Properties used in entity update operations.

UpdateFolderDetails

Properties used in folder update operations.

UpdateGlossaryDetails

Properties used in glossary update operations.

UpdateJobDefinitionDetails

Update information for a job definition resource.

UpdateJobDetails

Job properties that can be updated.

UpdateMetastoreDetails

Information to be updated for an existing metastore.

UpdateNamespaceDetails

Properties used in namespace update operations.

UpdatePatternDetails

Properties used in pattern update operations.

UpdateTermDetails

Properties used in term update operations.

UpdateTermRelationshipDetails

Properties used in term relationship update operations.

UploadCredentialsDetails

Upload credential file and connection metadata.

ValidateConnectionDetails

Validate connection from the connection metadata or oracle wallet file.

ValidateConnectionResult

Details regarding the validation of a connection resource.

ValidatePatternDetails

Validate pattern using the expression and file list.

ValidatePatternResult

Details regarding the validation of a pattern resource.

WorkRequest

A description of workrequest status.

WorkRequestError

An error encountered while executing a work request.

WorkRequestLog

A log message from the execution of a work request.

WorkRequestResource

A resource created or operated on by a work request.

Enums

AddResourceLockDetails.TypeEnum

ConnectionResult

Result from connection test and validation. SUCCEEDED - The connection is valid and tested successfully. FAILED - The connection validation failed. This could be due to incorrect or insufficient credentials or invalid connection metadata.

CustomPropertyDataType

Enum Representing various data types allowed for the custom property TEXT - String data type RICH_TEXT - Rich text to hold long descriptions and formatted values NUMBER - Numeric Data type BOOLEAN - Boolean type with allowed values of true or false DATE - Date data type

DataAssetImportExportTypeFilter

Type of Data Asset import and export as described below. ALL - Includes all supported elements of the data asset enumerated by the other type filters. CUSTOM_PROPERTY_VALUES - Includes custom property values set on the objects within the export scope.

EventConfigStatus

Enum representing whether or not to emit an event when a relevant action (e.g. modifying a custom property value) is performed by the user on this type. ENABLED - Event is emitted. DISABLED - Event is not emitted.

FacetedSearchAggregation.PropertyTypeEnum

FacetedSearchSortRequest.SortOrderEnum

HarvestStatus

Harvest state of the object indicates the completeness of the metadata definition of the object in the catalog. COMPLETE - The object's metadata is harvested successfully including properties, relationships, and its children. ERROR - There is an error during the harvest process. This could be due to failure in the harvest process, or invalid or currupted data. IN-PROGRESS - The harvest is currently in progress. This might imply a successful shallow harvest and a deep harvest is currently in progress. DEFERRED - The dependencies are incomplete and the resolution of the metadata is deferred until all information is available for the object.

JobExecutionState

Common execution states for jobs in data catalog. CREATED - Job has been created but yet to start execution. It will transition to IN_PROGRESS when resources are available for execution. IN_PROGRESS - Job is currently executing. INACTIVE - Job has been paused by the worker. This could be due to resource contention or window management. FAILED - Job has failed due to errors during execution. SUCCEEDED - Job has successfully completed execution. CANCELED - Job has been aborted by the worker due to a user request. SUCCEEDED_WITH_WARNINGS - Job has successfully completed execution with one or more warnings.

JobLifecycleState

Lifecycle state for jobs. ACTIVE - The job is active and will execute based on it's schedule information. INACTIVE - The job is inactive and will not execute based on it's schedule until it is ACTIVE. EXPIRED - The job's schedule has expired and will not result in any further executions. This is a terminal state.

JobScheduleType

Type of job schedule. SCHEDULED - The job will execute at a later time based on a schedule. IMMEDIATE - The job will execute as soon as possible.

JobType

Type of job as described below. HARVEST - Harvest jobs are metadata crawlers that extract schema from data assets. PROFILING - Profiling jobs are data profilers that extract metrics about data like histograms, distribution, min, max, avg and so on. SAMPLING - Sampling jobs extract a small subset of data for profiling and viewing. PREVIEW - Preview jobs are metadata crawlers but allow users to filter and view metadata entities in data assets. IMPORT - Import jobs import metadata in data catalog repository from a data catalog exported file. EXPORT - Export jobs export data catalog metadata for imports into other data catalog repositories. IMPORT_GLOSSARY - Job type to import glossary metadata from a file. EXPORT_GLOSSARY - Job type to export glossary metadata to a file. ASYNC_DELETE - Job type for asynchronous bulk delete on data assets, folders and data entities. PURGE - Job type for cleaning up schedules, executions and logs of a Job. IMPORT_DATA_ASSET - Job type to import technical objects to a data asset. CREATE_SCAN_PROXY - Job type to create scan proxy resource for RAC enabled data asset. ASYNC_EXPORT_GLOSSARY - Job type to export glossary metadata to a file asynchronously. ASYNC_EXPORT_DATA_ASSET - Job type to export data assets metadata to a file asynchronously.

LifecycleState

Common lifecycle states for resources in data catalog: CREATING - The resource is being created and may not be usable until the entire metadata is defined. UPDATING - The resource is being updated and may not be usable until all changes are commited. DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access. INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons. DELETED - The resource has been deleted and isn't available. FAILED - The resource is in a failed state due to validation or other errors. MOVING - The resource is being moved to another compartment (action changeCompartment)

LineageDirection

Indicates the direction for lineage fetch. It is one of upstream (or source objects), downstream (or target objects), both. Corresponding enums are: UPSTREAM - Source objects. DOWNSTREAM - Target objects. BOTH - Both source and target objects.

RecommendationResourceType

Data Catalog resource type which can be used in recommendations.

DATA_ENTITY
ATTRIBUTE
TERM
CATEGORY

RecommendationStatus

Status of a recommendation.

ACCEPTED : The recommendation was approved by the user.
REJECTED : The recommendation was declined by the user.
INFERRED : The recommendation was proposed by the system.

RecommendationType

Type of recommendation.

LINK_GLOSSARY_TERM : Create a tag linking the source object to a glossary term.

RemoveResourceLockDetails.TypeEnum

ResourceLock.TypeEnum

RuleOriginType

Origin type for the given rule. SOURCE - Represents rule is harvested and is as defined in source system. USER - Represents user defined rules at data catalog system. PROFILING - Represents rules which are inferred via profiling.

RuleType

Type of rule as described below. PRIMARYKEY - Primary key constraint defined in the source database. FOREIGNKEY - Foreign key constraint defined in the source database. UNIQUEKEY - Unique key constraint defined in the source database.

TermWorkflowStatus

A term workflow is a sequence of steps or tasks usually done by a data steward as part of the governance lifecycle. Business terms cannot be used for tagging unless they are APPROVED by the busines term owner (usually a data steward). By default, most terms, when created, are in the NEW status unless specified otherwise. NEW - This is the default workflow status when a term is newly created. The owner can override this status during the creation. APPROVED - This term is ready for use. It can be used to tag data assets, data entities, attributes, and other taggable resources. UNDER_REVIEW - The term is currently under review and cannot be used until it is in APPROVED status. ESCALATED - The review of this term is escalated to fast track for use in tagging.