Enums
AccessLevel
The access level for a Metadata Entity, either public or private
Values
| Value | Description |
|---|---|
| PUBLIC | Publicly available |
| PRIVATE | Restricted to a subset of viewers |
AccessTokenDuration
The duration for which an Access Token is valid.
Values
| Value | Description |
|---|---|
| ONE_HOUR | 1 hour |
| ONE_DAY | 1 day |
| ONE_WEEK | 1 week |
| ONE_MONTH | 1 month |
| THREE_MONTHS | 3 months |
| SIX_MONTHS | 6 months |
| ONE_YEAR | 1 year |
| NO_EXPIRY | No expiry |
AccessTokenType
A type of DataHub Access Token.
Values
| Value | Description |
|---|---|
| PERSONAL | Generates a personal access token |
AssertionResultType
The result type of an assertion, success or failure.
Values
| Value | Description |
|---|---|
| SUCCESS | The assertion succeeded. |
| FAILURE | The assertion failed. |
AssertionRunStatus
The state of an assertion run, as defined within an Assertion Run Event.
Values
| Value | Description |
|---|---|
| COMPLETE | An assertion run has completed. |
AssertionStdAggregation
An "aggregation" function that can be applied to column values of a Dataset to create the input to an Assertion Operator.
Values
| Value | Description |
|---|---|
| IDENTITY | Assertion is applied on individual column value |
| MEAN | Assertion is applied on column mean |
| MEDIAN | Assertion is applied on column median |
| UNIQUE_COUNT | Assertion is applied on number of distinct values in column |
| UNIQUE_PROPOTION | Assertion is applied on proportion of distinct values in column |
| NULL_COUNT | Assertion is applied on number of null values in column |
| NULL_PROPORTION | Assertion is applied on proportion of null values in column |
| STDDEV | Assertion is applied on column std deviation |
| MIN | Assertion is applied on column min |
| MAX | Assertion is applied on column std deviation |
| SUM | Assertion is applied on column sum |
| COLUMNS | Assertion is applied on all columns |
| COLUMN_COUNT | Assertion is applied on number of columns |
| ROW_COUNT | Assertion is applied on number of rows |
| _NATIVE_ | Other |
AssertionStdOperator
A standard operator or condition that constitutes an assertion definition
Values
| Value | Description |
|---|---|
| BETWEEN | Value being asserted is between min_value and max_value |
| LESS_THAN | Value being asserted is less than max_value |
| LESS_THAN_OR_EQUAL_TO | Value being asserted is less than or equal to max_value |
| GREATER_THAN | Value being asserted is greater than min_value |
| GREATER_THAN_OR_EQUAL_TO | Value being asserted is greater than or equal to min_value |
| EQUAL_TO | Value being asserted is equal to value |
| NOT_NULL | Value being asserted is not null |
| CONTAIN | Value being asserted contains value |
| END_WITH | Value being asserted ends with value |
| START_WITH | Value being asserted starts with value |
| REGEX_MATCH | Value being asserted matches the regex value. |
| IN | Value being asserted is one of the array values |
| NOT_IN | Value being asserted is not in one of the array values. |
| _NATIVE_ | Other |
AssertionStdParameterType
The type of an AssertionStdParameter
Values
| Value | Description |
|---|---|
| STRING | A string value |
| NUMBER | A numeric value |
| LIST | A list of values. When used, the value should be formatted as a serialized JSON array. |
| SET | A set of values. When used, the value should be formatted as a serialized JSON array. |
| UNKNOWN | A value of unknown type |
AssertionType
The top-level assertion type. Currently single Dataset assertions are the only type supported.
Values
| Value | Description |
|---|---|
| DATASET |
ChangeCategoryType
Enum of CategoryTypes
Values
| Value | Description |
|---|---|
| DOCUMENTATION | When documentation has been edited |
| GLOSSARY_TERM | When glossary terms have been added or removed |
| OWNERSHIP | When ownership has been modified |
| TECHNICAL_SCHEMA | When technical schemas have been added or removed |
| TAG | When tags have been added or removed |
ChangeOperationType
Enum of types of changes
Values
| Value | Description |
|---|---|
| ADD | When an element is added |
| MODIFY | When an element is modified |
| REMOVE | When an element is removed |
ChartQueryType
The type of the Chart Query
Values
| Value | Description |
|---|---|
| SQL | Standard ANSI SQL |
| LOOKML | LookML |
ChartType
The type of a Chart Entity
Values
| Value | Description |
|---|---|
| BAR | Bar graph |
| PIE | Pie chart |
| SCATTER | Scatter plot |
| TABLE | Table |
| TEXT | Markdown formatted text |
| LINE | A line chart |
| AREA | An area chart |
| HISTOGRAM | A histogram chart |
| BOX_PLOT | A box plot chart |
| WORD_CLOUD | A word cloud chart |
| COHORT | A Cohort Analysis chart |
CorpUserStatus
The state of a CorpUser
Values
| Value | Description |
|---|---|
| ACTIVE | A User that has been provisioned and logged in |
CostType
Values
| Value | Description |
|---|---|
| ORG_COST_TYPE | Org Cost Type to which the Cost of this entity should be attributed to |
DataHubViewType
The type of a DataHub View
Values
| Value | Description |
|---|---|
| PERSONAL | A personal view - e.g. saved filters |
| GLOBAL | A global view, e.g. role view |
DataProcessInstanceRunResultType
The result of the data process run
Values
| Value | Description |
|---|---|
| SUCCESS | The run finished successfully |
| FAILURE | The run finished in failure |
| SKIPPED | The run was skipped |
| UP_FOR_RETRY | The run failed and is up for retry |
DataProcessRunStatus
The status of the data process instance
Values
| Value | Description |
|---|---|
| STARTED | The data process instance has started but not completed |
| COMPLETE | The data process instance has completed |
DatasetAssertionScope
The scope that a Dataset-level assertion applies to.
Values
| Value | Description |
|---|---|
| DATASET_COLUMN | Assertion applies to columns of a dataset. |
| DATASET_ROWS | Assertion applies to rows of a dataset. |
| DATASET_SCHEMA | Assertion applies to schema of a dataset. |
| UNKNOWN | The scope of an assertion is unknown. |
DatasetFilterType
Type of partition
Values
| Value | Description |
|---|---|
| SQL | Use a SQL string to apply the filter |
DatasetLineageType
Deprecated The type of an edge between two Datasets
Values
| Value | Description |
|---|---|
| COPY | Direct copy without modification |
| TRANSFORMED | Transformed dataset |
| VIEW | Represents a view defined on the sources |
DateInterval
For consumption by UI only
Values
| Value | Description |
|---|---|
| SECOND | |
| MINUTE | |
| HOUR | |
| DAY | |
| WEEK | |
| MONTH | |
| YEAR |
EntityType
A top level Metadata Entity Type
Values
| Value | Description |
|---|---|
| DOMAIN | A Domain containing Metadata Entities |
| DATASET | The Dataset Entity |
| CORP_USER | The CorpUser Entity |
| CORP_GROUP | The CorpGroup Entity |
| DATA_PLATFORM | The DataPlatform Entity |
| DASHBOARD | The Dashboard Entity |
| NOTEBOOK | The Notebook Entity |
| CHART | The Chart Entity |
| DATA_FLOW | The Data Flow (or Data Pipeline) Entity, |
| DATA_JOB | The Data Job (or Data Task) Entity |
| TAG | The Tag Entity |
| GLOSSARY_TERM | The Glossary Term Entity |
| GLOSSARY_NODE | The Glossary Node Entity |
| CONTAINER | A container of Metadata Entities |
| MLMODEL | The ML Model Entity |
| MLMODEL_GROUP | The MLModelGroup Entity |
| MLFEATURE_TABLE | ML Feature Table Entity |
| MLFEATURE | The ML Feature Entity |
| MLPRIMARY_KEY | The ML Primary Key Entity |
| INGESTION_SOURCE | A DataHub Managed Ingestion Source |
| EXECUTION_REQUEST | A DataHub ExecutionRequest |
| ASSERTION | A DataHub Assertion |
| DATA_PROCESS_INSTANCE | An instance of an individual run of a data job or data flow |
| DATA_PLATFORM_INSTANCE | Data Platform Instance Entity |
| ACCESS_TOKEN | A DataHub Access Token |
| TEST | A DataHub Test |
| DATAHUB_POLICY | A DataHub Policy |
| DATAHUB_ROLE | A DataHub Role |
| POST | A DataHub Post |
| SCHEMA_FIELD | A Schema Field |
| DATAHUB_VIEW | A DataHub View |
| QUERY | A dataset query |
| DATA_PRODUCT | A Data Product |
| CUSTOM_OWNERSHIP_TYPE | A Custom Ownership Type |
| INCIDENT | A DataHub incident - SaaS only |
| ROLE | " A Role from an organisation |
| STRUCTURED_PROPERTY | " An structured property on entities |
| FORM | " A form entity on entities |
| DATA_TYPE | " A data type registered to DataHub |
| ENTITY_TYPE | " A type of entity registered to DataHub |
| RESTRICTED | " A type of entity that is restricted to the user |
| OTHER | Another entity type - refer to a provided entity type urn. |
FabricType
An environment identifier for a particular Entity, ie staging or production Note that this model will soon be deprecated in favor of a more general purpose of notion of data environment
Values
| Value | Description |
|---|---|
| DEV | Designates development fabrics |
| TEST | Designates testing fabrics |
| QA | Designates quality assurance fabrics |
| UAT | Designates user acceptance testing fabrics |
| EI | Designates early integration fabrics |
| PRE | Designates pre-production fabrics |
| STG | Designates staging fabrics |
| NON_PROD | Designates non-production fabrics |
| PROD | Designates production fabrics |
| CORP | Designates corporation fabrics |
FilterOperator
Values
| Value | Description |
|---|---|
| CONTAIN | Represent the relation: String field contains value, e.g. name contains Profile |
| EQUAL | Represent the relation: field = value, e.g. platform = hdfs |
| IN |
|
| EXISTS | Represents the relation: The field exists. If the field is an array, the field is either not present or empty. |
| GREATER_THAN | Represent the relation greater than, e.g. ownerCount > 5 |
| GREATER_THAN_OR_EQUAL_TO | Represent the relation greater than or equal to, e.g. ownerCount >= 5 |
| LESS_THAN | Represent the relation less than, e.g. ownerCount < 3 |
| LESS_THAN_OR_EQUAL_TO | Represent the relation less than or equal to, e.g. ownerCount <= 3 |
FormPromptType
Enum of all form prompt types
Values
| Value | Description |
|---|---|
| STRUCTURED_PROPERTY | A structured property form prompt type. |
| FIELDS_STRUCTURED_PROPERTY | A schema field-level structured property form prompt type. |
FormType
The type of a form. This is optional on a form entity
Values
| Value | Description |
|---|---|
| VERIFICATION | This form is used for "verifying" entities as a state for governance and compliance |
| COMPLETION | This form is used to help with filling out metadata on entities |
HealthStatus
Values
| Value | Description |
|---|---|
| PASS | The Asset is in a healthy state |
| WARN | The Asset is in a warning state |
| FAIL | The Asset is in a failing (unhealthy) state |
HealthStatusType
The type of the health status
Values
| Value | Description |
|---|---|
| ASSERTIONS | Assertions status |
| INCIDENTS | Incidents status |
IntendedUserType
Values
| Value | Description |
|---|---|
| ENTERPRISE | Developed for Enterprise Users |
| HOBBY | Developed for Hobbyists |
| ENTERTAINMENT | Developed for Entertainment Purposes |
LineageDirection
Direction between two nodes in the lineage graph
Values
| Value | Description |
|---|---|
| UPSTREAM | Upstream, or left-to-right in the lineage visualization |
| DOWNSTREAM | Downstream, or right-to-left in the lineage visualization |
LogicalOperator
A Logical Operator, AND or OR.
Values
| Value | Description |
|---|---|
| AND | An AND operator. |
| OR | An OR operator. |
MediaType
The type of media
Values
| Value | Description |
|---|---|
| IMAGE | An image |
MLFeatureDataType
The data type associated with an individual Machine Learning Feature
Values
| Value | Description |
|---|---|
| USELESS | |
| NOMINAL | |
| ORDINAL | |
| BINARY | |
| COUNT | |
| TIME | |
| INTERVAL | |
| IMAGE | |
| VIDEO | |
| AUDIO | |
| TEXT | |
| MAP | |
| SEQUENCE | |
| SET | |
| CONTINUOUS | |
| BYTE | |
| UNKNOWN |
NotebookCellType
The type for a NotebookCell
Values
| Value | Description |
|---|---|
| TEXT_CELL | TEXT Notebook cell type. The cell context is text only. |
| QUERY_CELL | QUERY Notebook cell type. The cell context is query only. |
| CHART_CELL | CHART Notebook cell type. The cell content is chart only. |
OperationSourceType
Enum to define the source/reporter type for an Operation.
Values
| Value | Description |
|---|---|
| DATA_PROCESS | A data process reported the operation. |
| DATA_PLATFORM | A data platform reported the operation. |
OperationType
Enum to define the operation type when an entity changes.
Values
| Value | Description |
|---|---|
| INSERT | When data is inserted. |
| UPDATE | When data is updated. |
| DELETE | When data is deleted. |
| CREATE | When table is created. |
| ALTER | When table is altered |
| DROP | When table is dropped |
| UNKNOWN | Unknown operation |
| CUSTOM | Custom |
OriginType
Enum to define where an entity originated from.
Values
| Value | Description |
|---|---|
| NATIVE | The entity is native to DataHub. |
| EXTERNAL | The entity is external to DataHub. |
| UNKNOWN | The entity is of unknown origin. |
OwnerEntityType
Entities that are able to own other entities
Values
| Value | Description |
|---|---|
| CORP_USER | A corp user owner |
| CORP_GROUP | A corp group owner |
OwnershipSourceType
The origin of Ownership metadata associated with a Metadata Entity
Values
| Value | Description |
|---|---|
| AUDIT | Auditing system or audit logs |
| DATABASE | Database, eg GRANTS table |
| FILE_SYSTEM | File system, eg file or directory owner |
| ISSUE_TRACKING_SYSTEM | Issue tracking system, eg Jira |
| MANUAL | Manually provided by a user |
| SERVICE | Other ownership like service, eg Nuage, ACL service etc |
| SOURCE_CONTROL | SCM system, eg GIT, SVN |
| OTHER | Other sources |
OwnershipType
The type of the ownership relationship between a Person and a Metadata Entity Note that this field will soon become deprecated due to low usage
Values
| Value | Description |
|---|---|
| TECHNICAL_OWNER | A person or group who is responsible for technical aspects of the asset. |
| BUSINESS_OWNER | A person or group who is responsible for logical, or business related, aspects of the asset. |
| DATA_STEWARD | A steward, expert, or delegate responsible for the asset. |
| NONE | No specific type associated with the owner. |
| CUSTOM | Associated ownership type is a custom ownership type. Please check OwnershipTypeEntity urn for custom value. |
| DATAOWNER | A person or group that owns the data. Deprecated! This ownership type is no longer supported. Use TECHNICAL_OWNER instead. |
| DEVELOPER | A person or group that is in charge of developing the code Deprecated! This ownership type is no longer supported. Use TECHNICAL_OWNER instead. |
| DELEGATE | A person or a group that overseas the operation, eg a DBA or SRE Deprecated! This ownership type is no longer supported. Use TECHNICAL_OWNER instead. |
| PRODUCER | A person, group, or service that produces or generates the data Deprecated! This ownership type is no longer supported. Use TECHNICAL_OWNER instead. |
| STAKEHOLDER | A person or a group that has direct business interest Deprecated! Use BUSINESS_OWNER instead. |
| CONSUMER | A person, group, or service that consumes the data Deprecated! This ownership type is no longer supported. |
PartitionType
Values
| Value | Description |
|---|---|
| FULL_TABLE | |
| QUERY | |
| PARTITION |
PlatformNativeType
Deprecated, do not use this type The logical type associated with an individual Dataset
Values
| Value | Description |
|---|---|
| TABLE | Table |
| VIEW | View |
| DIRECTORY | Directory in file system |
| STREAM | Stream |
| BUCKET | Bucket in key value store |
PlatformType
The category of a specific Data Platform
Values
| Value | Description |
|---|---|
| FILE_SYSTEM | Value for a file system |
| KEY_VALUE_STORE | Value for a key value store |
| MESSAGE_BROKER | Value for a message broker |
| OBJECT_STORE | Value for an object store |
| OLAP_DATASTORE | Value for an OLAP datastore |
| QUERY_ENGINE | Value for a query engine |
| RELATIONAL_DB | Value for a relational database |
| SEARCH_ENGINE | Value for a search engine |
| OTHERS | Value for other platforms |
PolicyMatchCondition
Match condition
Values
| Value | Description |
|---|---|
| EQUALS | Whether the field matches the value |
PolicyState
The state of an Access Policy
Values
| Value | Description |
|---|---|
| DRAFT | A Policy that has not been officially created, but in progress Currently unused |
| ACTIVE | A Policy that is active and being enforced |
| INACTIVE | A Policy that is not active or being enforced |
PolicyType
The type of the Access Policy
Values
| Value | Description |
|---|---|
| METADATA | An access policy that grants privileges pertaining to Metadata Entities |
| PLATFORM | An access policy that grants top level administrative privileges pertaining to the DataHub Platform itself |
PostContentType
The type of post
Values
| Value | Description |
|---|---|
| TEXT | Text content |
| LINK | Link content |
PostType
The type of post
Values
| Value | Description |
|---|---|
| HOME_PAGE_ANNOUNCEMENT | Posts on the home page |
PropertyCardinality
The cardinality of a Structured Property determining whether one or multiple values can be applied to the entity from this property.
Values
| Value | Description |
|---|---|
| SINGLE | Only one value of this property can applied to an entity |
| MULTIPLE | Multiple values of this property can applied to an entity |
QueryLanguage
A query language / dialect.
Values
| Value | Description |
|---|---|
| SQL | Standard ANSI SQL |
QuerySource
The source of the query
Values
| Value | Description |
|---|---|
| MANUAL | The query was provided manually, e.g. from the UI. |
| SYSTEM | The query was extracted by the system, e.g. from a dashboard. |
RecommendationRenderType
Enum that defines how the modules should be rendered. There should be two frontend implementation of large and small modules per type.
Values
| Value | Description |
|---|---|
| ENTITY_NAME_LIST | Simple list of entities |
| PLATFORM_SEARCH_LIST | List of platforms |
| TAG_SEARCH_LIST | Tag search list |
| SEARCH_QUERY_LIST | A list of recommended search queries |
| GLOSSARY_TERM_SEARCH_LIST | Glossary Term search list |
| DOMAIN_SEARCH_LIST | Domain Search List |
RelationshipDirection
Direction between a source and destination node
Values
| Value | Description |
|---|---|
| INCOMING | A directed edge pointing at the source Entity |
| OUTGOING | A directed edge pointing at the destination Entity |
ScenarioType
Type of the scenario requesting recommendation
Values
| Value | Description |
|---|---|
| HOME | Recommendations to show on the users home page |
| SEARCH_RESULTS | Recommendations to show on the search results page |
| ENTITY_PROFILE | Recommendations to show on an Entity Profile page |
| SEARCH_BAR | Recommendations to show on the search bar when clicked |
SchemaFieldDataType
The type associated with a single Dataset schema field
Values
| Value | Description |
|---|---|
| BOOLEAN | A boolean type |
| FIXED | A fixed bytestring type |
| STRING | A string type |
| BYTES | A string of bytes |
| NUMBER | A number, including integers, floats, and doubles |
| DATE | A datestrings type |
| TIME | A timestamp type |
| ENUM | An enum type |
| NULL | A NULL type |
| MAP | A map collection type |
| ARRAY | An array collection type |
| UNION | An union type |
| STRUCT | An complex struct type |
SortOrder
Order for sorting
Values
| Value | Description |
|---|---|
| ASCENDING | |
| DESCENDING |
SourceCodeUrlType
Values
| Value | Description |
|---|---|
| ML_MODEL_SOURCE_CODE | MLModel Source Code |
| TRAINING_PIPELINE_SOURCE_CODE | Training Pipeline Source Code |
| EVALUATION_PIPELINE_SOURCE_CODE | Evaluation Pipeline Source Code |
StdDataType
A well-supported, standard DataHub Data Type.
Values
| Value | Description |
|---|---|
| STRING | String data type |
| NUMBER | Number data type |
| URN | Urn data type |
| RICH_TEXT | Rich text data type. Right now this is markdown only. |
| DATE | Date data type in format YYYY-MM-DD |
| OTHER | Any other data type - refer to a provided data type urn. |
SubResourceType
A type of Metadata Entity sub resource
Values
| Value | Description |
|---|---|
| DATASET_FIELD | A Dataset field or column |
TermRelationshipType
A type of Metadata Entity sub resource
Values
| Value | Description |
|---|---|
| isA | When a Term inherits from, or has an 'Is A' relationship with another Term |
| hasA | When a Term contains, or has a 'Has A' relationship with another Term |
TestResultType
The result type of a test that has been run
Values
| Value | Description |
|---|---|
| SUCCESS | The test succeeded. |
| FAILURE | The test failed. |
TimeRange
A time range used in fetching Usage statistics
Values
| Value | Description |
|---|---|
| DAY | Last day |
| WEEK | Last week |
| MONTH | Last month |
| QUARTER | Last quarter |
| YEAR | Last year |
| ALL | All time |
UserSetting
An individual setting type for a Corp User.
Values
| Value | Description |
|---|---|
| SHOW_SIMPLIFIED_HOMEPAGE | Show simplified homepage |
WindowDuration
The duration of a fixed window of time
Values
| Value | Description |
|---|---|
| DAY | A one day window |
| WEEK | A one week window |
| MONTH | A one month window |
| YEAR | A one year window |