mirror of
https://github.com/datahub-project/datahub.git
synced 2025-11-24 08:45:43 +00:00
16027 lines
2.5 MiB
16027 lines
2.5 MiB
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-1.1.0 plugin-docs plugin-id-default docs-doc-id-python-sdk/models" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.3">
|
||
<title data-rh="true">Models | DataHub</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.datahub.com/docs/1.1.0/python-sdk/models"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="1.1.0"><meta data-rh="true" name="docusaurus_tag" content="docs-default-1.1.0"><meta data-rh="true" name="docsearch:version" content="1.1.0"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-1.1.0"><meta data-rh="true" property="og:title" content="Models | DataHub"><meta data-rh="true" name="description" content="\n\n\n\n\nclass datahub.metadata.schemaclasses.AccessClass(roles=None)\nBases\nroles (Optional[List[RoleAssociationClass]])\n\n\n\n\nproperty roles object\nThe various access levels\n\n\nPRIVATE = 'PRIVATE'\n\n\n\nPUBLIC = 'PUBLIC'\n\n\n\n\nclass datahub.metadata.schemaclasses.ActorsClass(users=None)\nBases\nusers (Optional[List[RoleUserClass]])\n\n\n\n\nproperty users DictWrapper\nArray field type.\n\nParameters None | List[str]\nList of types this array holds.\n\n\n\n\nclass datahub.metadata.schemaclasses.AspectBag\nBases AccessClass\n\n\n\nactors AssertionActionsClass\n\n\n\nassertionInfo AssertionKeyClass\n\n\n\nassertionRunEvent BrowsePathsClass\n\n\n\nbrowsePathsV2 BusinessAttributeInfoClass\n\n\n\nbusinessAttributeKey BusinessAttributesClass\n\n\n\nchartInfo ChartKeyClass\n\n\n\nchartQuery ChartUsageStatisticsClass\n\n\n\ncontainer ContainerKeyClass\n\n\n\ncontainerProperties CorpGroupEditableInfoClass\n\n\n\ncorpGroupInfo CorpGroupKeyClass\n\n\n\ncorpUserCredentials CorpUserEditableInfoClass\n\n\n\ncorpUserInfo CorpUserKeyClass\n\n\n\ncorpUserSettings CorpUserStatusClass\n\n\n\ncost DashboardInfoClass\n\n\n\ndashboardKey DashboardUsageStatisticsClass\n\n\n\ndataContractKey DataContractPropertiesClass\n\n\n\ndataContractStatus DataFlowInfoClass\n\n\n\ndataFlowKey DataHubAccessTokenInfoClass\n\n\n\ndataHubAccessTokenKey DataHubActionKeyClass\n\n\n\ndataHubConnectionDetails DataHubConnectionKeyClass\n\n\n\ndataHubExecutionRequestInput ExecutionRequestKeyClass\n\n\n\ndataHubExecutionRequestResult ExecutionRequestSignalClass\n\n\n\ndataHubIngestionSourceInfo DataHubIngestionSourceKeyClass\n\n\n\ndataHubOpenAPISchemaKey DataHubPersonaInfoClass\n\n\n\ndataHubPersonaKey DataHubPolicyInfoClass\n\n\n\ndataHubPolicyKey DataHubRetentionConfigClass\n\n\n\ndataHubRetentionKey DataHubRoleInfoClass\n\n\n\ndataHubRoleKey DataHubSecretKeyClass\n\n\n\ndataHubSecretValue DataHubStepStateKeyClass\n\n\n\ndataHubStepStateProperties DataHubUpgradeKeyClass\n\n\n\ndataHubUpgradeRequest DataHubUpgradeResultClass\n\n\n\ndataHubViewInfo DataHubViewKeyClass\n\n\n\ndataJobInfo DataJobInputOutputClass\n\n\n\ndataJobKey DataPlatformInfoClass\n\n\n\ndataPlatformInstance DataPlatformInstanceKeyClass\n\n\n\ndataPlatformInstanceProperties DataPlatformKeyClass\n\n\n\ndataProcessInfo DataProcessInstanceInputClass\n\n\n\ndataProcessInstanceKey DataProcessInstanceOutputClass\n\n\n\ndataProcessInstanceProperties DataProcessInstanceRelationshipsClass\n\n\n\ndataProcessInstanceRunEvent DataProcessKeyClass\n\n\n\ndataProductKey DataProductPropertiesClass\n\n\n\ndataTransformLogic DataTypeInfoClass\n\n\n\ndataTypeKey DatahubIngestionCheckpointClass\n\n\n\ndatahubIngestionRunSummary DatasetDeprecationClass\n\n\n\ndatasetKey DatasetProfileClass\n\n\n\ndatasetProperties DatasetUpstreamLineageClass\n\n\n\ndatasetUsageStatistics DeprecationClass\n\n\n\ndisplayProperties DocumentationClass\n\n\n\ndomainKey DomainPropertiesClass\n\n\n\ndomains DynamicFormAssignmentClass\n\n\n\neditableChartProperties EditableContainerPropertiesClass\n\n\n\neditableDashboardProperties EditableDataFlowPropertiesClass\n\n\n\neditableDataJobProperties EditableDatasetPropertiesClass\n\n\n\neditableERModelRelationshipProperties EditableMLFeaturePropertiesClass\n\n\n\neditableMlFeatureTableProperties EditableMLModelGroupPropertiesClass\n\n\n\neditableMlModelProperties EditableMLPrimaryKeyPropertiesClass\n\n\n\neditableNotebookProperties EditableSchemaMetadataClass\n\n\n\nembed EntityTypeInfoClass\n\n\n\nentityTypeKey ERModelRelationshipKeyClass\n\n\n\nerModelRelationshipProperties FormInfoClass\n\n\n\nformKey FormsClass\n\n\n\nglobalSettingsInfo GlobalSettingsKeyClass\n\n\n\nglobalTags GlossaryNodeInfoClass\n\n\n\nglossaryNodeKey GlossaryRelatedTermsClass\n\n\n\nglossaryTermInfo GlossaryTermKeyClass\n\n\n\nglossaryTerms GroupMembershipClass\n\n\n\nicebergCatalogInfo IcebergWarehouseInfoClass\n\n\n\nincidentInfo IncidentKeyClass\n\n\n\nincidentSource IncidentsSummaryClass\n\n\n\ninputFields InstitutionalMemoryClass\n\n\n\nintendedUse InviteTokenClass\n\n\n\ninviteTokenKey MLFeatureKeyClass\n\n\n\nmlFeatureProperties MLFeatureTableKeyClass\n\n\n\nmlFeatureTableProperties MLHyperParamClass\n\n\n\nmlMetric CaveatsAndRecommendationsClass\n\n\n\nmlModelDeploymentKey MLModelDeploymentPropertiesClass\n\n\n\nmlModelEthicalConsiderations EvaluationDataClass\n\n\n\nmlModelFactorPrompts MLModelGroupKeyClass\n\n\n\nmlModelGroupProperties MLModelKeyClass\n\n\n\nmlModelMetrics MLModelPropertiesClass\n\n\n\nmlModelQuantitativeAnalyses TrainingDataClass\n\n\n\nmlPrimaryKeyKey MLPrimaryKeyPropertiesClass\n\n\n\nmlTrainingRunProperties NativeGroupMembershipClass\n\n\n\nnotebookContent NotebookInfoClass\n\n\n\nnotebookKey OperationClass\n\n\n\norigin OwnershipClass\n\n\n\nownershipTypeInfo OwnershipTypeKeyClass\n\n\n\npartitionsSummary PlatformResourceInfoClass\n\n\n\nplatformResourceKey PostInfoClass\n\n\n\npostKey StructuredPropertyDefinitionClass\n\n\n\nqueryKey QueryPropertiesClass\n\n\n\nquerySubjects QueryUsageStatisticsClass\n\n\n\nroleKey RoleMembershipClass\n\n\n\nroleProperties SchemaFieldAliasesClass\n\n\n\nschemaFieldKey SchemaMetadataClass\n\n\n\nschemafieldInfo SiblingsClass\n\n\n\nslackUserInfo SourceCodeClass\n\n\n\nstatus StructuredPropertiesClass\n\n\n\nstructuredPropertyKey StructuredPropertySettingsClass\n\n\n\nsubTypes SystemMetadataClass\n\n\n\ntagKey TagPropertiesClass\n\n\n\ntelemetryClientId TelemetryKeyClass\n\n\n\ntestInfo TestKeyClass\n\n\n\ntestResults UpstreamLineageClass\n\n\n\nversionInfo VersionPropertiesClass\n\n\n\nversionSetKey VersionSetPropertiesClass\n\n\n\nviewProperties DictWrapper\nThe Actions about an Assertion.\nIn the future, we\u2019ll likely extend this model to support additional\nparameters or options related to the assertion actions.\n\nParameters str | AssertionActionTypeClass\nThe type of the Action\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionActionTypeClass\nBases Aspect\nThe Actions about an Assertion\n\nParameters List[AssertionActionClass]\nActions to be executed on failed assertion run.\n\n\n\nproperty onSuccess Aspect\nInformation about an assertion\n\nParameters None | CustomAssertionInfoClass\nA Custom Assertion definition. This field is populated when type is CUSTOM.\n\n\n\nproperty customProperties None | DatasetAssertionInfoClass\nA Dataset Assertion definition. This field is populated when the type is DATASET.\n\n\n\nproperty description None | str\nURL where the reference exist\n\n\n\nproperty fieldAssertion None | FreshnessAssertionInfoClass\nAn Freshness Assertion definition. This field is populated when the type is FRESHNESS.\n\n\n\nproperty lastUpdated None | SchemaAssertionInfoClass\nAn schema Assertion definition. This field is populated when the type is DATASCHEMA\n\n\n\nproperty source None | SqlAssertionInfoClass\nA SQL Assertion definition. This field is populated when the type is SQL.\n\n\n\nproperty type None | VolumeAssertionInfoClass\nAn Volume Assertion definition. This field is populated when the type is VOLUME.\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionKeyClass(assertionId)\nBases\nassertionId (str)\n\n\n\n\nproperty assertionId DictWrapper\nThe result of running an assertion\n\nParameters None | float\nObserved aggregate value for evaluated batch\n\n\n\nproperty error None | str\nExternal URL where full results are available. Only present when assertion source is not native.\n\n\n\nproperty missingCount None | Dict[str, str]\nOther results of evaluation\n\n\n\nproperty rowCount str | AssertionResultTypeClass\nThe final result, e.g. either SUCCESS, FAILURE, or ERROR.\n\n\n\nproperty unexpectedCount DictWrapper\nAn error encountered when evaluating an AssertionResult\n\nParameters None | Dict[str, str]\nAdditional metadata depending on the type of error\n\n\n\nproperty type object\n\n\nCUSTOMSQLERROR = 'CUSTOMSQLERROR'\n\n\n\nFIELDASSERTIONERROR = 'FIELDASSERTIONERROR'\n\n\n\nINSUFFICIENTDATA = 'INSUFFICIENTDATA'\n\n\n\nINVALIDPARAMETERS = 'INVALIDPARAMETERS'\n\n\n\nINVALIDSOURCETYPE = 'INVALIDSOURCETYPE'\n\n\n\nSOURCECONNECTIONERROR = 'SOURCECONNECTIONERROR'\n\n\n\nSOURCEQUERYFAILED = 'SOURCEQUERYFAILED'\n\n\n\nUNKNOWNERROR = 'UNKNOWNERROR'\n\n\n\nUNSUPPORTEDPLATFORM = 'UNSUPPORTEDPLATFORM'\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionResultTypeClass\nBases Aspect\nAn event representing the current status of evaluating an assertion on a batch.\nAssertionRunEvent should be used for reporting the status of a run as an assertion evaluation progresses.\n\nParameters ClassVar[str] = 'timeseries'\n\n\n\nproperty asserteeUrn str\n\n\n\nproperty batchSpec None | TimeWindowSizeClass\nGranularity of the event if applicable\n\n\n\nproperty messageId PartitionSpecClass | None\nThe optional partition specification.\n\n\n\nproperty result str\nNative (platform-specific) identifier for this run\n\n\n\nproperty runtimeContext str | AssertionRunStatusClass\nThe status of the assertion run as per this timeseries event.\n\n\n\nproperty timestampMillis object\nThe lifecycle status of an assertion run.\n\n\nCOMPLETE = 'COMPLETE'\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionSourceClass(type, created=None)\nBases\n\ntype (Union[str, AssertionSourceTypeClass])\ncreated (Optional[AuditStampClass])\n\n\n\n\n\nproperty created str | AssertionSourceTypeClass\nThe type of the Assertion Source\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionSourceTypeClass\nBases object\nThe function that is applied to the aggregation input (schema, rows, column values) before evaluating an operator.\n\n\nCOLUMNS = 'COLUMNS'\n\n\n\nCOLUMNCOUNT = 'COLUMNCOUNT'\n\n\n\nIDENTITY = 'IDENTITY'\n\n\n\nMAX = 'MAX'\n\n\n\nMEAN = 'MEAN'\n\n\n\nMEDIAN = 'MEDIAN'\n\n\n\nMIN = 'MIN'\n\n\n\nNULLCOUNT = 'NULLCOUNT'\n\n\n\nNULLPROPORTION = 'NULLPROPORTION'\n\n\n\nROWCOUNT = 'ROWCOUNT'\n\n\n\nSTDDEV = 'STDDEV'\n\n\n\nSUM = 'SUM'\n\n\n\nUNIQUECOUNT = 'UNIQUECOUNT'\n\n\n\nUNIQUEPROPORTION = 'UNIQUEPROPORTION'\n\n\n\nUNIQUEPROPOTION = 'UNIQUEPROPOTION'\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionStdOperatorClass\nBases DictWrapper\nSingle parameter for AssertionStdOperators.\n\nParameters str | AssertionStdParameterTypeClass\nThe type of the parameter\n\n\n\nproperty value object\n\n\nLIST = 'LIST'\n\n\n\nNUMBER = 'NUMBER'\n\n\n\nSET = 'SET'\n\n\n\nSTRING = 'STRING'\n\n\n\nUNKNOWN = 'UNKNOWN'\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionStdParametersClass(value=None, maxValue=None, minValue=None)\nBases\n\nvalue (Optional[AssertionStdParameterClass])\nmaxValue (Optional[AssertionStdParameterClass])\nminValue (Optional[AssertionStdParameterClass])\n\n\n\n\n\nproperty maxValue None | AssertionStdParameterClass\nThe minValue parameter of an assertion\n\n\n\nproperty value object\n\n\nCUSTOM = 'CUSTOM'\n\n\n\nDATASET = 'DATASET'\n\n\n\nDATASCHEMA = 'DATASCHEMA'\n\n\n\nFIELD = 'FIELD'\n\n\n\nFRESHNESS = 'FRESHNESS'\n\n\n\nSQL = 'SQL'\n\n\n\nVOLUME = 'VOLUME'\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionValueChangeTypeClass\nBases DictWrapper\nData captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage.\n\nParameters str\nThe entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change.\n\n\n\nproperty impersonator None | str\nwas the change created by an automated process, or manually.\n\nType int\nWhen did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent.\n\n\n\n\nclass datahub.metadata.schemaclasses.AzkabanJobTypeClass\nBases DictWrapper\nBaseData record\n\nParameters str\nWhat dataset were used in the MLModel?\n\n\n\nproperty motivation None | List[str]\nHow was the data preprocessed (e.g., tokenization of sentences, cropping of images, any filtering such as dropping images without faces)?\n\n\n\n\nclass datahub.metadata.schemaclasses.BatchSpecClass(customProperties=None, nativeBatchId=None, query=None, limit=None)\nBases\n\ncustomProperties (Optional[Dict[str, str]])\nnativeBatchId (Optional[str])\nquery (Optional[str])\nlimit (Optional[int])\n\n\n\n\n\nproperty customProperties None | int\nAny limit to the number of rows in the batch, if applied\n\n\n\nproperty nativeBatchId None | str\nA query that identifies a batch of data\n\n\n\n\nclass datahub.metadata.schemaclasses.BinaryJsonSchemaClass(schema)\nBases\nschema (str)\n\n\n\n\nproperty schema DictWrapper\nBoolean field type.\n\n\n\nclass datahub.metadata.schemaclasses.BrowsePathEntryClass(id, urn=None)\nBases\n\nid (str)\nurn (Optional[str])\n\n\n\n\n\nproperty id None | str\nOptional urn pointing to some entity in DataHub\n\n\n\n\nclass datahub.metadata.schemaclasses.BrowsePathsClass(paths)\nBases\npaths (List[str])\n\n\n\n\nproperty paths \u2018prod/snowflake/datasetName\u2019\n\n\n\n\nclass datahub.metadata.schemaclasses.BrowsePathsV2Class(path)\nBases\npath (List[BrowsePathEntryClass])\n\n\n\n\nproperty path DictWrapper\n\nParameters str\nUrn of the applied businessAttribute\n\n\n\n\nclass datahub.metadata.schemaclasses.BusinessAttributeInfoClass(fieldPath, name, description=None, globalTags=None, glossaryTerms=None, customProperties=None, created=None, lastModified=None, deleted=None, type=None)\nBases\n\nfieldPath (str)\nname (str)\ndescription (Optional[str])\nglobalTags (Optional[GlobalTagsClass])\nglossaryTerms (Optional[GlossaryTermsClass])\ncustomProperties (Optional[Dict[str, str]])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ntype (Optional[SchemaFieldDataTypeClass])\n\n\n\n\n\nproperty created Dict[str, str]\nCustom property bag.\n\n\n\nproperty deleted None | str\nDescription\n\n\n\nproperty fieldPath None | GlobalTagsClass\nTags associated with the field\n\n\n\nproperty glossaryTerms AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\nproperty name None | SchemaFieldDataTypeClass\n\n\n\n\nclass datahub.metadata.schemaclasses.BusinessAttributeKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nBusinessAttribute aspect used for applying it to an entity\n\nParameters None | BusinessAttributeAssociationClass\nBusiness Attribute for this field.\n\n\n\n\nclass datahub.metadata.schemaclasses.BytesTypeClass\nBases object\n\n\nDAY = 'DAY'\n\n\n\nHOUR = 'HOUR'\n\n\n\nMINUTE = 'MINUTE'\n\n\n\nMONTH = 'MONTH'\n\n\n\nQUARTER = 'QUARTER'\n\n\n\nSECOND = 'SECOND'\n\n\n\nWEEK = 'WEEK'\n\n\n\nYEAR = 'YEAR'\n\n\n\n\nclass datahub.metadata.schemaclasses.CaveatDetailsClass(needsFurtherTesting=None, caveatDescription=None, groupsNotRepresented=None)\nBases\n\nneedsFurtherTesting (Optional[bool])\ncaveatDescription (Optional[str])\ngroupsNotRepresented (Optional[List[str]])\n\n\n\n\n\nproperty caveatDescription Given gender classes are binary (male/not male), which we include as male/female. Further work needed to evaluate across a spectrum of genders.\n\n\n\nproperty groupsNotRepresented None | bool\nDid the results suggest any further testing?\n\n\n\n\nclass datahub.metadata.schemaclasses.CaveatsAndRecommendationsClass(caveats=None, recommendations=None, idealDatasetCharacteristics=None)\nBases\n\ncaveats (Optional[CaveatDetailsClass])\nrecommendations (Optional[str])\nidealDatasetCharacteristics (Optional[List[str]])\n\n\n\n\n\nproperty caveats None | List[str]\nIdeal characteristics of an evaluation dataset for this MLModel\n\n\n\nproperty recommendations DictWrapper\nData captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into various lifecycle stages, and who acted to move it into those lifecycle stages. The recommended best practice is to include this record in your record schema, and annotate its fields as @readOnly in your resource. See linkedin/rest.li\n\nParameters AuditStampClass\nAn AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.\n\n\n\nproperty deleted AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\n\nclass datahub.metadata.schemaclasses.ChangeTypeClass\nBases DictWrapper\nChart cell in a notebook, which will present content in chart format\n\nParameters str\nUnique id for the cell. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as \u2018querybook.com/notebook/773/?cellId=1234\u2019\n\n\n\nproperty cellTitle ChangeAuditStampsClass\nCaptures information about who created/last modified/deleted this Notebook cell and when\n\n\n\n\nclass datahub.metadata.schemaclasses.ChartInfoClass(title, description, lastModified, customProperties=None, externalUrl=None, chartUrl=None, inputs=None, inputEdges=None, type=None, access=None, lastRefreshed=None)\nBases\n\ntitle (str)\ndescription (str)\nlastModified (ChangeAuditStampsClass)\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\nchartUrl (Optional[str])\ninputs (Optional[List[str]])\ninputEdges (Optional[List[EdgeClass]])\ntype (Union[None, str, ChartTypeClass])\naccess (Union[None, str, AccessLevelClass])\nlastRefreshed (Optional[int])\n\n\n\n\n\nproperty access None | str\nURL for the chart. This could be used as an external link on DataHub to allow users access/view the chart\n\n\n\nproperty customProperties str\nDetailed description about the chart\n\n\n\nproperty externalUrl None | List[EdgeClass]\nData sources for the chart\n\n\n\nproperty inputs ChangeAuditStampsClass\nCaptures information about who created/last modified/deleted this chart and when\n\n\n\nproperty lastRefreshed str\nTitle of the chart\n\n\n\nproperty type Aspect\nKey for a Chart\n\nParameters str\nUnique id for the chart. This id should be globally unique for a dashboarding tool even when there are multiple deployments of it. As an example, chart URL could be used here for Looker such as \u2018looker.linkedin.com/looks/1234\u2019\n\n\n\nproperty dashboardTool Aspect\nInformation for chart query which is used for getting data of the chart\n\nParameters str\nRaw query to build a chart from input datasets\n\n\n\nproperty type object\n\n\nLOOKML = 'LOOKML'\n\n\n\nSQL = 'SQL'\n\n\n\n\nclass datahub.metadata.schemaclasses.ChartSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[ChartKeyClass, ChartInfoClass, ChartQueryClass, EditableChartPropertiesClass, OwnershipClass, StatusClass, GlobalTagsClass, BrowsePathsClass, GlossaryTermsClass, InstitutionalMemoryClass, DataPlatformInstanceClass, BrowsePathsV2Class]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.ChartTypeClass\nBases Aspect\nExperimental (Subject to breaking change) \u2013 Stats corresponding to chart\u2019s usage.\nIf this aspect represents the latest snapshot of the statistics about a Chart, the eventGranularity field should be null.\nIf this aspect represents a bucketed window of usage statistics (e.g. over a day), then the eventGranularity field should be set accordingly.\n\nParameters ClassVar[str] = 'timeseries'\n\n\n\nproperty eventGranularity None | str\nThe optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.\n\n\n\nproperty partitionSpec int\nThe event timestamp field as epoch at UTC in milli seconds.\n\n\n\nproperty uniqueUserCount None | List[ChartUserUsageCountsClass]\nUsers within this bucket, with frequency counts\n\n\n\nproperty viewsCount DictWrapper\nRecords a single user\u2019s usage counts for a given resource\n\nParameters str\nThe unique id of the user.\n\n\n\nproperty viewsCount object\nThe matching condition in a filter criterion\n\n\nANCESTORSINCL = 'ANCESTORSINCL'\n\n\n\nCONTAIN = 'CONTAIN'\n\n\n\nDESCENDANTSINCL = 'DESCENDANTSINCL'\n\n\n\nENDWITH = 'ENDWITH'\n\n\n\nEQUAL = 'EQUAL'\n\n\n\nEXISTS = 'EXISTS'\n\n\n\nGREATERTHAN = 'GREATERTHAN'\n\n\n\nGREATERTHANOREQUALTO = 'GREATERTHANOREQUALTO'\n\n\n\nIEQUAL = 'IEQUAL'\n\n\n\nIN = 'IN'\n\n\n\nISNULL = 'ISNULL'\n\n\n\nLESSTHAN = 'LESSTHAN'\n\n\n\nLESSTHANOREQUALTO = 'LESSTHANOREQUALTO'\n\n\n\nRELATEDINCL = 'RELATEDINCL'\n\n\n\nSTARTWITH = 'STARTWITH'\n\n\n\n\nclass datahub.metadata.schemaclasses.ConjunctiveCriterionClass(and)\nBases\nand (List[CriterionClass])\n\n\n\n\nproperty and Aspect\nLink from an asset to its parent container\n\nParameters str\nThe parent container of an asset\n\n\n\n\nclass datahub.metadata.schemaclasses.ContainerKeyClass(guid=None)\nBases\nguid (Optional[str])\n\n\n\n\nproperty guid Aspect\nInformation about a Asset Container as received from a 3rd party source system\n\nParameters None | TimeStampClass\nA timestamp documenting when the asset was created in the source Data Platform (not on DataHub)\n\n\n\nproperty customProperties None | str\nDescription of the Asset Container as it exists inside a source system\n\n\n\nproperty env None | str\nURL where the reference exist\n\n\n\nproperty lastModified str\nDisplay name of the Asset Container\n\n\n\nproperty qualifiedName Aspect\nGroup information that can be edited from UI\n\nParameters None | str\nA description of the group\n\n\n\nproperty email str\nA URL which points to a picture which user wants to set as the photo for the group\n\n\n\nproperty slack Aspect\nInformation about a Corp Group ingested from a third party source\n\nParameters List[str]\nowners of this group\nDeprecated! Replaced by Ownership aspect.\n\n\n\nproperty created None | str\nA description of the group.\n\n\n\nproperty displayName None | str\nemail of this group\n\n\n\nproperty groups List[str]\nList of ldap urn in this group.\nDeprecated! Replaced by GroupMembership aspect.\n\n\n\nproperty slack Aspect\nKey for a CorpGroup\n\nParameters str\nThe URL-encoded name of the AD/LDAP group. Serves as a globally unique identifier within DataHub.\n\n\n\n\nclass datahub.metadata.schemaclasses.CorpGroupSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[CorpGroupKeyClass, CorpGroupInfoClass, GlobalTagsClass, StatusClass]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.CorpUserAppearanceSettingsClass(showSimplifiedHomepage=None, showThemeV2=None)\nBases\n\nshowSimplifiedHomepage (Optional[bool])\nshowThemeV2 (Optional[bool])\n\n\n\n\n\nproperty showSimplifiedHomepage None | bool\nFlag controlling whether the V2 UI for DataHub is shown.\n\n\n\n\nclass datahub.metadata.schemaclasses.CorpUserCredentialsClass(salt, hashedPassword, passwordResetToken=None, passwordResetTokenExpirationTimeMillis=None)\nBases\n\nsalt (str)\nhashedPassword (str)\npasswordResetToken (Optional[str])\npasswordResetTokenExpirationTimeMillis (Optional[int])\n\n\n\n\n\nproperty hashedPassword None | str\nOptional token needed to reset a user\u2019s password. Can only be set by the admin.\n\n\n\nproperty passwordResetTokenExpirationTimeMillis str\nSalt used to hash password\n\n\n\n\nclass datahub.metadata.schemaclasses.CorpUserEditableInfoClass(aboutMe=None, teams=None, skills=None, pictureLink=None, displayName=None, title=None, platforms=None, persona=None, slack=None, phone=None, email=None, informationSources=None)\nBases\n\naboutMe (Optional[str])\nteams (Optional[List[str]])\nskills (Optional[List[str]])\npictureLink (Optional[str])\ndisplayName (Optional[str])\ntitle (Optional[str])\nplatforms (Optional[List[str]])\npersona (Optional[str])\nslack (Optional[str])\nphone (Optional[str])\nemail (Optional[str])\ninformationSources (Optional[List[str]])\n\n\n\n\n\nproperty aboutMe None | str\nDataHub-native display name\n\n\n\nproperty email None | List[str]\nInformation sources that have been used to populate this CorpUserEditableInfo.\nThese include platform resources, such as Slack members or Looker users.\nThey can also refer to other semantic urns in the future.\n\n\n\nproperty persona None | str\nPhone number to contact the user\n\n\n\nproperty pictureLink None | List[str]\nThe platforms that the user commonly works with\n\n\n\nproperty skills None | str\nSlack handle for the user\n\n\n\nproperty teams None | str\nDataHub-native Title, e.g. \u2018Software Engineer\u2019\n\n\n\n\nclass datahub.metadata.schemaclasses.CorpUserInfoClass(active, customProperties=None, displayName=None, email=None, title=None, managerUrn=None, departmentId=None, departmentName=None, firstName=None, lastName=None, fullName=None, countryCode=None, system=None)\nBases\n\nactive (bool)\ncustomProperties (Optional[Dict[str, str]])\ndisplayName (Optional[str])\nemail (Optional[str])\ntitle (Optional[str])\nmanagerUrn (Optional[str])\ndepartmentId (Optional[int])\ndepartmentName (Optional[str])\nfirstName (Optional[str])\nlastName (Optional[str])\nfullName (Optional[str])\ncountryCode (Optional[str])\nsystem (Optional[bool])\n\n\n\n\n\nproperty active\nDeprecated! Use CorpUserStatus instead. Whether the corpUser is active, ref\n\nType None | str\ntwo uppercase letters country code. e.g. US\n\n\n\nproperty customProperties None | int\ndepartment id this user belong to\n\n\n\nproperty departmentName None | str\ndisplayName of this user , e.g. Hang Zhang(DataHQ)\n\n\n\nproperty email None | str\nfirst name of this user\n\n\n\nproperty fullName None | str\nlast name of this user\n\n\n\nproperty managerUrn bool | None\nWhether the corpUser is a system user.\n\n\n\nproperty title Aspect\nKey for a CorpUser\n\nParameters str\nThe name of the AD/LDAP user.\n\n\n\n\nclass datahub.metadata.schemaclasses.CorpUserSettingsClass(appearance, views=None, notificationSettings=None)\nBases\n\nappearance (CorpUserAppearanceSettingsClass)\nviews (Optional[CorpUserViewsSettingsClass])\nnotificationSettings (Optional[NotificationSettingsClass])\n\n\n\n\n\nproperty appearance None | NotificationSettingsClass\nNotification settings for a user\n\n\n\nproperty views DictWrapper\nA metadata snapshot for a specific CorpUser entity.\n\nParameters List[CorpUserKeyClass | CorpUserInfoClass | CorpUserEditableInfoClass | CorpUserStatusClass | GroupMembershipClass | GlobalTagsClass | StatusClass]\nThe list of metadata aspects associated with the CorpUser. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nThe status of the user, e.g. provisioned, active, suspended, etc.\n\nParameters AuditStampClass\nAudit stamp containing who last modified the status and when.\n\n\n\nproperty status DictWrapper\nSettings related to the \u2018Views\u2019 feature.\n\nParameters None | str\nThe default View which is selected for the user.\nIf none is chosen, then this value will be left blank.\n\n\n\n\nclass datahub.metadata.schemaclasses.CostClass(costType, cost)\nBases\n\ncostType (Union[str, CostTypeClass])\ncost (CostCostClass)\n\n\n\n\n\nproperty cost str | CostTypeClass\n\n\n\n\nclass datahub.metadata.schemaclasses.CostCostClass(fieldDiscriminator, costId=None, costCode=None)\nBases\n\nfieldDiscriminator (Union[str, CostCostDiscriminatorClass])\ncostId (Optional[float])\ncostCode (Optional[str])\n\n\n\n\n\nproperty costCode None | float\n\n\n\nproperty fieldDiscriminator object\n\n\ncostCode = 'costCode'\n\n\n\ncostId = 'costId'\n\n\n\n\nclass datahub.metadata.schemaclasses.CostTypeClass\nBases DictWrapper\nA criterion for matching a field with given value\n\nParameters str | ConditionClass\nThe condition for the criterion, e.g. EQUAL, STARTWITH\n\n\n\nproperty field bool\nWhether the condition should be negated\n\n\n\nproperty value List[str]\nValues. one of which the intended field should match\nNote, if values is set, the above \u201cvalue\u201d field will be ignored\n\n\n\n\nclass datahub.metadata.schemaclasses.CustomAssertionInfoClass(type, entity, field=None, logic=None)\nBases\n\ntype (str)\nentity (str)\nfield (Optional[str])\nlogic (Optional[str])\n\n\n\n\n\nproperty entity None | str\ndataset schema field targeted by this assertion.\nThis field is expected to be provided if the assertion is on dataset field\n\n\n\nproperty logic str\nThe type of custom assertion.\nThis is how your assertion will appear categorized in DataHub UI.\n\n\n\n\nclass datahub.metadata.schemaclasses.DashboardInfoClass(title, description, lastModified, customProperties=None, externalUrl=None, charts=None, chartEdges=None, datasets=None, datasetEdges=None, dashboards=None, dashboardUrl=None, access=None, lastRefreshed=None)\nBases\n\ntitle (str)\ndescription (str)\nlastModified (ChangeAuditStampsClass)\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\ncharts (Optional[List[str]])\nchartEdges (Optional[List[EdgeClass]])\ndatasets (Optional[List[str]])\ndatasetEdges (Optional[List[EdgeClass]])\ndashboards (Optional[List[EdgeClass]])\ndashboardUrl (Optional[str])\naccess (Union[None, str, AccessLevelClass])\nlastRefreshed (Optional[int])\n\n\n\n\n\nproperty access None | List[EdgeClass]\nCharts in a dashboard\n\n\n\nproperty charts Dict[str, str]\nCustom property bag.\n\n\n\nproperty dashboardUrl List[EdgeClass]\nDashboards included by this dashboard.\nSome dashboard entities (e.g. PowerBI Apps) can contain other dashboards.\nThe Edge\u2019s sourceUrn should never be set, as it will always be the base dashboard.\n\n\n\nproperty datasetEdges List[str]\nDatasets consumed by a dashboard\nDeprecated! Use datasetEdges instead.\n\n\n\nproperty description None | str\nURL where the reference exist\n\n\n\nproperty lastModified None | int\nThe time when this dashboard last refreshed\n\n\n\nproperty title Aspect\nKey for a Dashboard\n\nParameters str\nUnique id for the dashboard. This id should be globally unique for a dashboarding tool even when there are multiple deployments of it. As an example, dashboard URL could be used here for Looker such as \u2018looker.linkedin.com/dashboards/1234\u2019\n\n\n\nproperty dashboardTool DictWrapper\nA metadata snapshot for a specific Dashboard entity.\n\nParameters List[DashboardKeyClass | DashboardInfoClass | EditableDashboardPropertiesClass | OwnershipClass | StatusClass | GlobalTagsClass | BrowsePathsClass | GlossaryTermsClass | InstitutionalMemoryClass | DataPlatformInstanceClass | BrowsePathsV2Class]\nThe list of metadata aspects associated with the dashboard. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nExperimental (Subject to breaking change) \u2013 Stats corresponding to dashboard\u2019s usage.\nIf this aspect represents the latest snapshot of the statistics about a Dashboard, the eventGranularity field should be null.\nIf this aspect represents a bucketed window of usage statistics (e.g. over a day), then the eventGranularity field should be set accordingly.\n\nParameters ClassVar[str] = 'timeseries'\n\n\n\nproperty eventGranularity None | int\nThe total number of dashboard executions (refreshes / syncs)\n\n\n\nproperty favoritesCount None | int\nLast viewed at\nThis should not be set in cases where statistics are windowed.\n\n\n\nproperty messageId PartitionSpecClass | None\nThe optional partition specification.\n\n\n\nproperty timestampMillis None | int\nUnique user count\n\n\n\nproperty userCounts None | int\nThe total number of times dashboard has been viewed\n\n\n\n\nclass datahub.metadata.schemaclasses.DashboardUserUsageCountsClass(user, viewsCount=None, executionsCount=None, usageCount=None, userEmail=None)\nBases\n\nuser (str)\nviewsCount (Optional[int])\nexecutionsCount (Optional[int])\nusageCount (Optional[int])\nuserEmail (Optional[str])\n\n\n\n\n\nproperty executionsCount None | int\nNormalized numeric metric representing user\u2019s dashboard usage \u2013 the number of times the user executed or viewed the dashboard.\n\n\n\nproperty user None | str\nIf useremail is set, we attempt to resolve the user\u2019s urn upon ingest\n\n\n\nproperty viewsCount Aspect\nKey for a Data Contract\n\nParameters str\nUnique id for the contract\n\n\n\n\nclass datahub.metadata.schemaclasses.DataContractPropertiesClass(entity, schema=None, freshness=None, dataQuality=None, rawContract=None)\nBases\n\nentity (str)\nschema (Optional[List[SchemaContractClass]])\nfreshness (Optional[List[FreshnessContractClass]])\ndataQuality (Optional[List[DataQualityContractClass]])\nrawContract (Optional[str])\n\n\n\n\n\nproperty dataQuality str\nThe entity that this contract is associated with. Currently, we only support Dataset contracts, but\nin the future we may also support Data Product level contracts.\n\n\n\nproperty freshness None | str\nYAML-formatted contract definition\n\n\n\nproperty schema object\n\n\nACTIVE = 'ACTIVE'\n\n\n\nPENDING = 'PENDING'\n\n\n\n\nclass datahub.metadata.schemaclasses.DataContractStatusClass(state, customProperties=None)\nBases\n\nstate (Union[str, DataContractStateClass])\ncustomProperties (Optional[Dict[str, str]])\n\n\n\n\n\nproperty customProperties str | DataContractStateClass\nThe latest state of the data contract\n\n\n\n\nclass datahub.metadata.schemaclasses.DataFlowInfoClass(name, customProperties=None, externalUrl=None, description=None, project=None, created=None, lastModified=None, env=None)\nBases\n\nname (str)\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\ndescription (Optional[str])\nproject (Optional[str])\ncreated (Optional[TimeStampClass])\nlastModified (Optional[TimeStampClass])\nenv (Union[None, str, FabricTypeClass])\n\n\n\n\n\nproperty created Dict[str, str]\nCustom property bag.\n\n\n\nproperty description None | str | FabricTypeClass\nEnvironment for this flow\n\n\n\nproperty externalUrl None | TimeStampClass\nA timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)\n\n\n\nproperty name None | str\nOptional project/namespace associated with the flow\n\n\n\n\nclass datahub.metadata.schemaclasses.DataFlowKeyClass(orchestrator, flowId, cluster)\nBases\n\norchestrator (str)\nflowId (str)\ncluster (str)\n\n\n\n\n\nproperty cluster str\nUnique Identifier of the data flow\n\n\n\nproperty orchestrator DictWrapper\nA metadata snapshot for a specific DataFlow entity.\n\nParameters List[DataFlowKeyClass | DataFlowInfoClass | EditableDataFlowPropertiesClass | OwnershipClass | StatusClass | GlobalTagsClass | BrowsePathsClass | GlossaryTermsClass | InstitutionalMemoryClass | DataPlatformInstanceClass | BrowsePathsV2Class]\nThe list of metadata aspects associated with the data flow. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nInformation about a DataHub Access Token\n\nParameters str\nUrn of the actor to which this access token belongs to.\n\n\n\nproperty createdAt None | str\nDescription of the token if defined.\n\n\n\nproperty expiresAt str\nUser defined name for the access token if defined.\n\n\n\nproperty ownerUrn Aspect\nKey for a DataHub Access Token\n\nParameters str\nAccess token\u2019s SHA-256 hashed JWT signature\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubActionKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\nInformation used to filter DataHub actors.\n\nParameters bool\nWhether the filter should apply to all groups.\n\n\n\nproperty allUsers None | List[str]\nA specific set of groups to apply the policy to (disjunctive)\n\n\n\nproperty resourceOwners None | List[str]\nDefine type of ownership for the policy\n\n\n\nproperty roles None | List[str]\nA specific set of users to apply the policy to (disjunctive)\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubConnectionDetailsClass(type, name=None, json=None)\nBases\n\ntype (Union[str, DataHubConnectionDetailsTypeClass])\nname (Optional[str])\njson (Optional[DataHubJsonConnectionClass])\n\n\n\n\n\nproperty json None | str\nDisplay name of the connection\n\n\n\nproperty type object\n\n\nJSON = 'JSON'\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubConnectionKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\n\nParameters None | bool\nWhether or not to run this ingestion source in debug mode\n\n\n\nproperty executorId None | Dict[str, str]\nExtra arguments for the ingestion run.\n\n\n\nproperty recipe None | str\nThe PyPI version of the datahub CLI to use when executing a recipe\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubIngestionSourceInfoClass(name, type, config, platform=None, schedule=None, source=None)\nBases\n\nname (str)\ntype (str)\nconfig (DataHubIngestionSourceConfigClass)\nplatform (Optional[str])\nschedule (Optional[DataHubIngestionSourceScheduleClass])\nsource (Optional[DataHubIngestionSourceSourceClass])\n\n\n\n\n\nproperty config str\nThe display name of the ingestion source\n\n\n\nproperty platform None | DataHubIngestionSourceScheduleClass\nThe schedule on which the ingestion source is executed\n\n\n\nproperty source str\nThe type of the source itself, e.g. mysql, bigquery, bigquery-usage. Should match the recipe.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubIngestionSourceKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\nThe schedule associated with an ingestion source.\n\nParameters str\nA cron-formatted execution interval, as a cron string, e.g. * * * * *\n\n\n\nproperty timezone DictWrapper\n\nParameters str | DataHubIngestionSourceSourceTypeClass\nThe source type of the ingestion source\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubIngestionSourceSourceTypeClass\nBases DictWrapper\nA set of connection details consisting of an encrypted JSON blob.\n\nParameters str\nThe encrypted JSON connection details.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubOpenAPISchemaKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nPlaceholder aspect for persona type info\n\n\n\nclass datahub.metadata.schemaclasses.DataHubPersonaKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nInformation about a DataHub (UI) access policy.\n\nParameters DataHubActorFilterClass\nThe actors that the policy applies to.\n\n\n\nproperty description str\nDisplay name of the Policy\n\n\n\nproperty editable None | int\nTimestamp when the policy was last updated\n\n\n\nproperty privileges None | DataHubResourceFilterClass\nThe resource that the policy applies to. Not required for some \u2018Platform\u2019 privileges.\n\n\n\nproperty state str\nThe type of policy\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubPolicyKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\nA metadata snapshot for DataHub Access Policy data.\n\nParameters List[DataHubPolicyKeyClass | DataHubPolicyInfoClass]\nThe list of metadata aspects associated with the DataHub access policy.\n\n\n\nproperty urn DictWrapper\nInformation used to filter DataHub resource.\n\nParameters bool\nWhether the policy should be applied to all assets matching the filter.\n\n\n\nproperty filter None | List[str]\nA specific set of resources to apply the policy to, e.g. asset urns\n\n\n\nproperty type Aspect\n\nParameters RetentionClass\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubRetentionKeyClass(entityName, aspectName)\nBases\n\nentityName (str)\naspectName (str)\n\n\n\n\n\nproperty aspectName str\nEntity name to apply retention to. (or empty) for applying defaults.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubRetentionSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[DataHubRetentionKeyClass, DataHubRetentionConfigClass]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubRoleInfoClass(name, description, editable=None)\nBases\n\nname (str)\ndescription (str)\neditable (Optional[bool])\n\n\n\n\n\nproperty description bool\nWhether the role should be editable via the UI\n\n\n\nproperty name Aspect\nKey for a DataHub Role\n\nParameters str\nA unique id for the DataHub role record. Generated on the server side at role creation time.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubSearchConfigClass(fieldName=None, fieldType=None, queryByDefault=None, enableAutocomplete=None, addToFilters=None, addHasValuesToFilters=None, filterNameOverride=None, hasValuesFilterNameOverride=None, boostScore=None, hasValuesFieldName=None, numValuesFieldName=None, weightsPerFieldValue=None, fieldNameAliases=None)\nBases\n\nfieldName (Optional[str])\nfieldType (Union[None, str, SearchFieldTypeClass])\nqueryByDefault (Optional[bool])\nenableAutocomplete (Optional[bool])\naddToFilters (Optional[bool])\naddHasValuesToFilters (Optional[bool])\nfilterNameOverride (Optional[str])\nhasValuesFilterNameOverride (Optional[str])\nboostScore (Optional[float])\nhasValuesFieldName (Optional[str])\nnumValuesFieldName (Optional[str])\nweightsPerFieldValue (Optional[Dict[str, float]])\nfieldNameAliases (Optional[List[str]])\n\n\n\n\n\nproperty addHasValuesToFilters bool\nWhether or not to add field to filters.\n\n\n\nproperty boostScore bool\nWhether we should use the field for default autocomplete\n\n\n\nproperty fieldName None | List[str]\n(Optional) Aliases for this given field that can be used for sorting etc.\n\n\n\nproperty fieldType None | str\nDisplay name of the filter\n\n\n\nproperty hasValuesFieldName None | str\nDisplay name of the has values filter\n\n\n\nproperty numValuesFieldName bool\nWhether we should match the field for the default search query\n\n\n\nproperty weightsPerFieldValue Aspect\nKey for a DataHub Secret\n\nParameters str\nA unique id for the Secret\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubSecretValueClass(name, value, description=None, created=None)\nBases\n\nname (str)\nvalue (str)\ndescription (Optional[str])\ncreated (Optional[AuditStampClass])\n\n\n\n\n\nproperty created None | str\nDescription of the secret\n\n\n\nproperty name str\nThe AES-encrypted value of the DataHub secret.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubStepStateKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nThe properties associated with a DataHub step state\n\nParameters AuditStampClass\nAudit stamp describing the last person to update it.\n\n\n\nproperty properties Aspect\nKey for a DataHubUpgrade\n\nParameters str\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubUpgradeRequestClass(timestampMs, version)\nBases\n\ntimestampMs (int)\nversion (str)\n\n\n\n\n\nproperty timestampMs str\nVersion of this upgrade\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubUpgradeResultClass(timestampMs, state=None, result=None)\nBases\n\ntimestampMs (int)\nstate (Union[str, DataHubUpgradeStateClass, None])\nresult (Optional[Dict[str, str]])\n\n\n\n\n\nproperty result str | DataHubUpgradeStateClass | None\nUpgrade state UpgradeResult.Result\n\n\n\nproperty timestampMs object\n\n\nABORTED = 'ABORTED'\n\n\n\nFAILED = 'FAILED'\n\n\n\nINPROGRESS = 'INPROGRESS'\n\n\n\nSUCCEEDED = 'SUCCEEDED'\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubViewDefinitionClass(entityTypes, filter)\nBases\n\nentityTypes (List[str])\nfilter (FilterClass)\n\n\n\n\n\nproperty entityTypes FilterClass\nThe filter criteria, which represents the view itself\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubViewInfoClass(name, type, definition, created, lastModified, description=None)\nBases Understand whether an entity type filter is required.\n\nParameters AuditStampClass\nAudit stamp capturing the time and actor who created the View.\n\n\n\nproperty definition None | str\nDescription of the view\n\n\n\nproperty lastModified str\nThe name of the View\n\n\n\nproperty type Aspect\nKey for a DataHub View\n\nParameters str\nA unique id for the View\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubViewTypeClass\nBases Aspect\nInformation about a Data processing job\n\nParameters None | TimeStampClass\nA timestamp documenting when the asset was created in the source Data Platform (not on DataHub)\n\n\n\nproperty customProperties None | str\nJob description\n\n\n\nproperty env None | str\nURL where the reference exist\n\n\n\nproperty flowUrn None | TimeStampClass\nA timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)\n\n\n\nproperty name None | str | JobStatusClass\nStatus of the job - Deprecated for Data Process Instance model.\n\n\n\nproperty type AzkabanJobType is deprecated. Please use strings instead.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataJobInputOutputClass(inputDatasets, outputDatasets, inputDatasetEdges=None, outputDatasetEdges=None, inputDatajobs=None, inputDatajobEdges=None, inputDatasetFields=None, outputDatasetFields=None, fineGrainedLineages=None)\nBases\n\ninputDatasets (List[str])\noutputDatasets (List[str])\ninputDatasetEdges (Optional[List[EdgeClass]])\noutputDatasetEdges (Optional[List[EdgeClass]])\ninputDatajobs (Optional[List[str]])\ninputDatajobEdges (Optional[List[EdgeClass]])\ninputDatasetFields (Optional[List[str]])\noutputDatasetFields (Optional[List[str]])\nfineGrainedLineages (Optional[List[FineGrainedLineageClass]])\n\n\n\n\n\nproperty fineGrainedLineages None | List[EdgeClass]\nInput datajobs that this data job depends on\n\n\n\nproperty inputDatajobs None | List[EdgeClass]\nInput datasets consumed by the data job during processing\n\n\n\nproperty inputDatasetFields List[str]\nInput datasets consumed by the data job during processing\nDeprecated! Use inputDatasetEdges instead.\n\n\n\nproperty outputDatasetEdges None | List[str]\nFields of the output datasets this job writes to\n\n\n\nproperty outputDatasets Aspect\nKey for a Data Job\n\nParameters str\nStandardized data processing flow urn representing the flow for the job\n\n\n\nproperty jobId DictWrapper\nA metadata snapshot for a specific DataJob entity.\n\nParameters List[DataJobKeyClass | DataJobInfoClass | DataJobInputOutputClass | EditableDataJobPropertiesClass | OwnershipClass | StatusClass | GlobalTagsClass | BrowsePathsClass | GlossaryTermsClass | InstitutionalMemoryClass | DataPlatformInstanceClass | BrowsePathsV2Class]\nThe list of metadata aspects associated with the data job. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nInformation about a data platform\n\nParameters str\nThe delimiter in the dataset names on the data platform, e.g. \u2018/\u2019 for HDFS and \u2018.\u2019 for Oracle\n\n\n\nproperty displayName None | str\nThe URL for a logo associated with the platform\n\n\n\nproperty name str | PlatformTypeClass\nPlatform type this data platform describes\n\n\n\n\nclass datahub.metadata.schemaclasses.DataPlatformInstanceClass(platform, instance=None)\nBases\n\nplatform (str)\ninstance (Optional[str])\n\n\n\n\n\nproperty instance str\nData Platform\n\n\n\n\nclass datahub.metadata.schemaclasses.DataPlatformInstanceKeyClass(platform, instance)\nBases\n\nplatform (str)\ninstance (str)\n\n\n\n\n\nproperty instance str\nData platform urn associated with the instance\n\n\n\n\nclass datahub.metadata.schemaclasses.DataPlatformInstancePropertiesClass(customProperties=None, externalUrl=None, name=None, description=None)\nBases\n\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\nname (Optional[str])\ndescription (Optional[str])\n\n\n\n\n\nproperty customProperties None | str\nDocumentation of the Data Platform Instance\n\n\n\nproperty externalUrl None | str\nDisplay name of the Data Platform Instance\n\n\n\n\nclass datahub.metadata.schemaclasses.DataPlatformKeyClass(platformName)\nBases\nplatformName (str)\n\n\n\n\nproperty platformName DictWrapper\nA metadata snapshot for a specific dataplatform entity.\n\nParameters List[DataPlatformKeyClass | DataPlatformInfoClass]\nThe list of metadata aspects associated with the data platform. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nThe inputs and outputs of this data process\n\nParameters None | List[str]\nthe inputs of the data process\n\n\n\nproperty outputs Aspect\nInformation about the inputs datasets of a Data process\n\nParameters None | List[EdgeClass]\nInput assets consumed by the data process instance, with additional metadata.\nCounts as lineage.\nWill eventually deprecate the inputs field.\n\n\n\nproperty inputs Aspect\nKey for an Asset DataProcessInstance\n\nParameters str\nA unique id for the DataProcessInstance . Should be separate from the name used for displaying a DataProcessInstance.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProcessInstanceOutputClass(outputs, outputEdges=None)\nBases\n\noutputs (List[str])\noutputEdges (Optional[List[EdgeClass]])\n\n\n\n\n\nproperty outputEdges List[str]\nOutput assets produced\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProcessInstancePropertiesClass(name, created, customProperties=None, externalUrl=None, type=None)\nBases\n\nname (str)\ncreated (AuditStampClass)\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\ntype (Union[None, str, DataProcessTypeClass])\n\n\n\n\n\nproperty created Dict[str, str]\nCustom property bag.\n\n\n\nproperty externalUrl str\nProcess name\n\n\n\nproperty type Aspect\nInformation about Data process relationships\n\nParameters None | str\nThe parent DataProcessInstance where it belongs to.\nIf it is a Airflow Task then it should belong to an Airflow Dag run as well\nwhich will be another DataProcessInstance\n\n\n\nproperty parentTemplate List[str]\nInput DataProcessInstance which triggered this dataprocess instance\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProcessInstanceRunEventClass(timestampMillis, status, eventGranularity=None, partitionSpec=None, messageId=None, externalUrl=None, attempt=None, result=None, durationMillis=None)\nBases\n\ntimestampMillis (int)\nstatus (Union[str, DataProcessRunStatusClass])\neventGranularity (Optional[TimeWindowSizeClass])\npartitionSpec (Optional[PartitionSpecClass])\nmessageId (Optional[str])\nexternalUrl (Optional[str])\nattempt (Optional[int])\nresult (Optional[DataProcessInstanceRunResultClass])\ndurationMillis (Optional[int])\n\n\n\n\n\nASPECTTYPE None | int\nReturn the try number that this Instance Run is in\n\n\n\nproperty durationMillis None | TimeWindowSizeClass\nGranularity of the event if applicable\n\n\n\nproperty externalUrl None | str\nThe optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.\n\n\n\nproperty partitionSpec None | DataProcessInstanceRunResultClass\nThe final result of the Data Processing run.\n\n\n\nproperty status int\nThe event timestamp field as epoch at UTC in milli seconds.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProcessInstanceRunResultClass(type, nativeResultType)\nBases\n\ntype (Union[str, RunResultTypeClass])\nnativeResultType (str)\n\n\n\n\n\nproperty nativeResultType str | RunResultTypeClass\nThe final result, e.g. SUCCESS, FAILURE, SKIPPED, or UPFORRETRY.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProcessKeyClass(name, orchestrator, origin)\nBases\n\nname (str)\norchestrator (str)\norigin (Union[str, FabricTypeClass])\n\n\n\n\n\nproperty name str\nStandardized Orchestrator where data process is defined.\nTODO str | FabricTypeClass\nFabric type where dataset belongs to or where it was generated.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProcessRunStatusClass\nBases DictWrapper\nA metadata snapshot for a specific Data process entity.\n\nParameters List[DataProcessKeyClass | OwnershipClass | DataProcessInfoClass | StatusClass]\nThe list of metadata aspects associated with the data process. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn object\n\n\nBATCHADHOC = 'BATCHADHOC'\n\n\n\nBATCHSCHEDULED = 'BATCHSCHEDULED'\n\n\n\nSTREAMING = 'STREAMING'\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProductAssociationClass(destinationUrn, sourceUrn=None, created=None, lastModified=None, properties=None, outputPort=None)\nBases\n\ndestinationUrn (str)\nsourceUrn (Optional[str])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\nproperties (Optional[Dict[str, str]])\noutputPort (Optional[bool])\n\n\n\n\n\nproperty created str\nUrn of the destination of this relationship edge.\n\n\n\nproperty lastModified bool\nIf set to true, this asset is an output port of the Data Product.\n\n\n\nproperty properties None | str\nUrn of the source of this relationship edge.\nIf not specified, assumed to be the entity that this aspect belongs to.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProductKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nThe main properties of a Data Product\n\nParameters None | List[DataProductAssociationClass]\nA list of assets that are part of this Data Product\n\n\n\nproperty customProperties None | str\nDocumentation of the dataset\n\n\n\nproperty externalUrl None | str\nDisplay name of the Data Product\n\n\n\n\nclass datahub.metadata.schemaclasses.DataQualityContractClass(assertion)\nBases\nassertion (str)\n\n\n\n\nproperty assertion DictWrapper\nInformation about a transformation. It may be a query,\n\nParameters None | QueryStatementClass\nThe data transform may be defined by a query statement\n\n\n\n\nclass datahub.metadata.schemaclasses.DataTransformLogicClass(transforms)\nBases\ntransforms (List[DataTransformClass])\n\n\n\n\nproperty transforms Aspect\n\nParameters None | str\nAn optional description for the data type.\n\n\n\nproperty displayName str\nThe qualified name for the data type. Usually a unique namespace + name, e.g. datahub.string\n\n\n\n\nclass datahub.metadata.schemaclasses.DataTypeKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nCheckpoint of a datahub ingestion run for a given job.\n\nParameters ClassVar[str] = 'timeseries'\n\n\n\nproperty config None | TimeWindowSizeClass\nGranularity of the event if applicable\n\n\n\nproperty messageId PartitionSpecClass | None\nThe optional partition specification.\n\n\n\nproperty pipelineName str\nThe id of the instance against which the ingestion pipeline ran.\ne.g. str\nThe run identifier of this job.\n\n\n\nproperty state int\nThe event timestamp field as epoch at UTC in milli seconds.\n\n\n\n\nclass datahub.metadata.schemaclasses.DatahubIngestionRunSummaryClass(timestampMillis, pipelineName, platformInstanceId, runId, runStatus, eventGranularity=None, partitionSpec=None, messageId=None, numWorkUnitsCommitted=None, numWorkUnitsCreated=None, numEvents=None, numEntities=None, numAspects=None, numSourceAPICalls=None, totalLatencySourceAPICalls=None, numSinkAPICalls=None, totalLatencySinkAPICalls=None, numWarnings=None, numErrors=None, numEntitiesSkipped=None, config=None, customsummary=None, softwareVersion=None, systemHostName=None, operatingSystemName=None, numProcessors=None, totalMemory=None, availableMemory=None)\nBases\n\ntimestampMillis (int)\npipelineName (str)\nplatformInstanceId (str)\nrunId (str)\nrunStatus (Union[str, JobStatusClass])\neventGranularity (Optional[TimeWindowSizeClass])\npartitionSpec (Optional[PartitionSpecClass])\nmessageId (Optional[str])\nnumWorkUnitsCommitted (Optional[int])\nnumWorkUnitsCreated (Optional[int])\nnumEvents (Optional[int])\nnumEntities (Optional[int])\nnumAspects (Optional[int])\nnumSourceAPICalls (Optional[int])\ntotalLatencySourceAPICalls (Optional[int])\nnumSinkAPICalls (Optional[int])\ntotalLatencySinkAPICalls (Optional[int])\nnumWarnings (Optional[int])\nnumErrors (Optional[int])\nnumEntitiesSkipped (Optional[int])\nconfig (Optional[str])\ncustomsummary (Optional[str])\nsoftwareVersion (Optional[str])\nsystemHostName (Optional[str])\noperatingSystemName (Optional[str])\nnumProcessors (Optional[int])\ntotalMemory (Optional[int])\navailableMemory (Optional[int])\n\n\n\n\n\nASPECTTYPE None | int\nThe available memory on the host the ingestion pipeline ran on.\n\n\n\nproperty config None | str\nCustom value.\n\n\n\nproperty eventGranularity None | str\nThe optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.\n\n\n\nproperty numAspects None | int\nThe total number of entities produced (unique entity urns).\n\n\n\nproperty numEntitiesSkipped None | int\nNumber of errors generated.\n\n\n\nproperty numEvents None | int\nThe number of processors on the host the ingestion pipeline ran on.\n\n\n\nproperty numSinkAPICalls None | int\nTotal number of source API calls.\n\n\n\nproperty numWarnings None | int\nThe number of workunits written to sink.\n\n\n\nproperty numWorkUnitsCreated None | str\nThe os the ingestion pipeline ran on.\n\n\n\nproperty partitionSpec str\nThe name of the pipeline that ran ingestion, a stable unique user provided identifier.\ne.g. mysnowflake1-to-datahub.\n\n\n\nproperty platformInstanceId Bigquery project ids, MySQL hostnames etc.\n\n\n\nproperty runId str | JobStatusClass\nRun Status - Succeeded/Skipped/Failed etc.\n\n\n\nproperty softwareVersion None | str\nThe hostname the ingestion pipeline ran on.\n\n\n\nproperty timestampMillis None | int\nTotal latency across all sink API calls.\n\n\n\nproperty totalLatencySourceAPICalls None | int\nThe total amount of memory on the host the ingestion pipeline ran on.\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetAssertionInfoClass(dataset, scope, operator, fields=None, aggregation=None, parameters=None, nativeType=None, nativeParameters=None, logic=None)\nBases\n\ndataset (str)\nscope (Union[str, DatasetAssertionScopeClass])\noperator (Union[str, AssertionStdOperatorClass])\nfields (Optional[List[str]])\naggregation (Union[None, str, AssertionStdAggregationClass])\nparameters (Optional[AssertionStdParametersClass])\nnativeType (Optional[str])\nnativeParameters (Optional[Dict[str, str]])\nlogic (Optional[str])\n\n\n\n\n\nproperty aggregation str\nThe dataset targeted by this assertion.\n\n\n\nproperty fields None | str\n\n\n\nproperty nativeParameters None | str\nNative assertion type\n\n\n\nproperty operator None | AssertionStdParametersClass\nStandard parameters required for the assertion. e.g. minvalue, maxvalue, value, columns\n\n\n\nproperty scope object\n\n\nDATASETCOLUMN = 'DATASETCOLUMN'\n\n\n\nDATASETROWS = 'DATASETROWS'\n\n\n\nDATASETSCHEMA = 'DATASETSCHEMA'\n\n\n\nDATASETSTORAGESIZE = 'DATASETSTORAGESIZE'\n\n\n\nUNKNOWN = 'UNKNOWN'\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetDeprecationClass(deprecated, note, decommissionTime=None, actor=None)\nBases\n\ndeprecated (bool)\nnote (str)\ndecommissionTime (Optional[int])\nactor (Optional[str])\n\n\n\n\n\nproperty actor None | int\nThe time user plan to decommission this dataset.\n\n\n\nproperty deprecated str\nAdditional information about the dataset deprecation plan, such as the wiki, doc, RB.\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetFieldForeignKeyClass(parentDataset, currentFieldPaths, parentField)\nBases\n\nparentDataset (str)\ncurrentFieldPaths (List[str])\nparentField (str)\n\n\n\n\n\nproperty currentFieldPaths str\ndataset that stores the resource.\n\n\n\nproperty parentField DictWrapper\nRepresentation of mapping between fields in source dataset to the field in destination dataset\n\nParameters AuditStampClass\nAudit stamp containing who reported the field mapping and when\n\n\n\nproperty destinationField List[str]\nSource fields from which the fine grained lineage is derived\n\n\n\nproperty transformation DictWrapper\nStats corresponding to fields in a dataset\n\nParameters None | List[ValueFrequencyClass]\n\n\n\nproperty fieldPath None | HistogramClass\n\n\n\nproperty max None | str\n\n\n\nproperty median None | str\n\n\n\nproperty nullCount None | float\n\n\n\nproperty quantiles None | List[str]\n\n\n\nproperty stdev None | int\n\n\n\nproperty uniqueProportion DictWrapper\nRecords field-level usage counts for a given dataset\n\nParameters int\nNumber of times the field has been used.\n\n\n\nproperty fieldPath DictWrapper\nA definition of filters that should be used when\nquerying an external Dataset or Table.\nNote that this models should NOT be used for working with\nsearch / filter on DataHub Platform itself.\n\nParameters None | str\nThe raw where clause string which will be used for monitoring.\nRequired if the type is SQL.\n\n\n\nproperty type object\n\n\nSQL = 'SQL'\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetKeyClass(platform, name, origin)\nBases\n\nplatform (str)\nname (str)\norigin (Union[str, FabricTypeClass])\n\n\n\n\n\nproperty name str | FabricTypeClass\nFabric type where dataset belongs to or where it was generated.\n\n\n\nproperty platform object\nThe various types of supported dataset lineage\n\n\nCOPY = 'COPY'\n\n\n\nTRANSFORMED = 'TRANSFORMED'\n\n\n\nVIEW = 'VIEW'\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetProfileClass(timestampMillis, eventGranularity=None, partitionSpec=None, messageId=None, rowCount=None, columnCount=None, fieldProfiles=None, sizeInBytes=None)\nBases\n\ntimestampMillis (int)\neventGranularity (Optional[TimeWindowSizeClass])\npartitionSpec (Optional[PartitionSpecClass])\nmessageId (Optional[str])\nrowCount (Optional[int])\ncolumnCount (Optional[int])\nfieldProfiles (Optional[List[DatasetFieldProfileClass]])\nsizeInBytes (Optional[int])\n\n\n\n\n\nASPECTTYPE None | int\nThe total number of columns (or schema fields)\n\n\n\nproperty eventGranularity None | List[DatasetFieldProfileClass]\nProfiles for each column (or schema field)\n\n\n\nproperty messageId PartitionSpecClass | None\nThe optional partition specification.\n\n\n\nproperty rowCount None | int\nStorage size in bytes\n\n\n\nproperty timestampMillis Aspect\nProperties associated with a Dataset\n\nParameters None | TimeStampClass\nA timestamp documenting when the asset was created in the source Data Platform (not on DataHub)\n\n\n\nproperty customProperties None | str\nDocumentation of the dataset\n\n\n\nproperty externalUrl None | TimeStampClass\nA timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)\n\n\n\nproperty name None | str\nFully-qualified name of the Dataset\n\n\n\nproperty tags None | str\n///dir/filename. Uri should not include any environment specific properties. Some datasets might not have a standardized uri, which makes this field optional (i.e. kafka topic).\n\nType\n///data/tracking/PageViewEvent, file\n\n\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[DatasetKeyClass, DatasetPropertiesClass, EditableDatasetPropertiesClass, DatasetDeprecationClass, DatasetUpstreamLineageClass, UpstreamLineageClass, InstitutionalMemoryClass, OwnershipClass, StatusClass, SchemaMetadataClass, EditableSchemaMetadataClass, GlobalTagsClass, GlossaryTermsClass, BrowsePathsClass, DataPlatformInstanceClass, ViewPropertiesClass, BrowsePathsV2Class]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetUpstreamLineageClass(fieldMappings)\nBases\nfieldMappings (List[DatasetFieldMappingClass])\n\n\n\n\nproperty fieldMappings Aspect\nStats corresponding to dataset\u2019s usage.\n\nParameters ClassVar[str] = 'timeseries'\n\n\n\nproperty eventGranularity None | List[DatasetFieldUsageCountsClass]\nField-level usage stats\n\n\n\nproperty messageId PartitionSpecClass | None\nThe optional partition specification.\n\n\n\nproperty timestampMillis None | List[str]\nFrequent SQL queries; mostly makes sense for datasets in SQL databases\n\n\n\nproperty totalSqlQueries None | int\nUnique user count\n\n\n\nproperty userCounts DictWrapper\nRecords a single user\u2019s usage counts for a given resource\n\nParameters int\nNumber of times the dataset has been used by the user.\n\n\n\nproperty user None | str\nIf useremail is set, we attempt to resolve the user\u2019s urn upon ingest\n\n\n\n\nclass datahub.metadata.schemaclasses.DateTypeClass\nBases object\nModel endpoint statuses\n\n\nCREATING = 'CREATING'\n\n\n\nDELETING = 'DELETING'\n\n\n\nFAILED = 'FAILED'\n\n\n\nINSERVICE = 'INSERVICE'\n\n\n\nOUTOFSERVICE = 'OUTOFSERVICE'\n\n\n\nROLLINGBACK = 'ROLLINGBACK'\n\n\n\nUNKNOWN = 'UNKNOWN'\n\n\n\nUPDATING = 'UPDATING'\n\n\n\n\nclass datahub.metadata.schemaclasses.DeprecationClass(deprecated, note, actor, decommissionTime=None, replacement=None)\nBases\n\ndeprecated (bool)\nnote (str)\nactor (str)\ndecommissionTime (Optional[int])\nreplacement (Optional[str])\n\n\n\n\n\nproperty actor None | int\nThe time user plan to decommission this entity.\n\n\n\nproperty deprecated str\nAdditional information about the entity deprecation plan, such as the wiki, doc, RB.\n\n\n\nproperty replacement Aspect\nProperties related to how the entity is displayed in the Datahub UI\n\nParameters None | str\nThe color associated with the entity in Hex. For example #FFFFFF.\n\n\n\nproperty icon DictWrapper\n\nParameters bool\n\n\n\nproperty config None | str\n\nThe version of the configuration schema that has been used to serializethe config.\n\n\nIf not provided, the version is assumed to be the latest version.\n\n\n\nproperty enabled DictWrapper\nProperties of applied documentation including the attribution of the doc\n\nParameters None | MetadataAttributionClass\nInformation about who, why, and how this metadata was applied\n\n\n\nproperty documentation Aspect\nAspect used for storing all applicable documentations on assets.\nThis aspect supports multiple documentations from different sources.\nThere is an implicit assumption that there is only one documentation per\n\nsource.\n\n\nFor example, if there are two documentations from the same source, thelatest one will overwrite the previous one.\n\nIf there are two documentations from different sources, both will bestored.\n\n\nFuture evolution considerations\ndocumentations (List[DocumentationAssociationClass])\n\n\n\n\nproperty documentations Aspect\nKey for an Asset Domain\n\nParameters str\nA unique id for the domain. Should be separate from the name used for displaying a Domain.\n\n\n\n\nclass datahub.metadata.schemaclasses.DomainPropertiesClass(name, customProperties=None, description=None, created=None, parentDomain=None)\nBases\n\nname (str)\ncustomProperties (Optional[Dict[str, str]])\ndescription (Optional[str])\ncreated (Optional[AuditStampClass])\nparentDomain (Optional[str])\n\n\n\n\n\nproperty created Dict[str, str]\nCustom property bag.\n\n\n\nproperty description str\nDisplay name of the Domain\n\n\n\nproperty parentDomain\nOptional\n\n\n\n\n\n\nclass datahub.metadata.schemaclasses.DomainsClass(domains)\nBases\ndomains (List[str])\n\n\n\n\nproperty domains Aspect\nInformation about how a form is assigned to entities dynamically. Provide a filter to\nmatch a set of entities instead of explicitly applying a form to specific entities.\n\nParameters FilterClass\nThe filter applied when assigning this form to entities. Entities that match this filter\nwill have this form applied to them. Right now this filter only supports filtering by\nplatform, entity type, container, and domain through the UI.\n\n\n\n\nclass datahub.metadata.schemaclasses.ERModelRelationshipCardinalityClass\nBases Aspect\nKey for a ERModelRelationship\n\nParameters str\n\n\n\n\nclass datahub.metadata.schemaclasses.ERModelRelationshipPropertiesClass(name, source, destination, relationshipFieldMappings, customProperties=None, created=None, lastModified=None, cardinality=None)\nBases\n\nname (str)\nsource (str)\ndestination (str)\nrelationshipFieldMappings (List[RelationshipFieldMappingClass])\ncustomProperties (Optional[Dict[str, str]])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ncardinality (Union[str, ERModelRelationshipCardinalityClass, None])\n\n\n\n\n\nproperty cardinality None | AuditStampClass\nA timestamp documenting when the asset was created in the source Data Platform (not on DataHub)\n\n\n\nproperty customProperties str\nSecond dataset in the erModelRelationship (no directionality)\n\n\n\nproperty lastModified str\nName of the ERModelRelation\n\n\n\nproperty relationshipFieldMappings str\nFirst dataset in the erModelRelationship (no directionality)\n\n\n\n\nclass datahub.metadata.schemaclasses.EdgeClass(destinationUrn, sourceUrn=None, created=None, lastModified=None, properties=None)\nBases\n\ndestinationUrn (str)\nsourceUrn (Optional[str])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\nproperties (Optional[Dict[str, str]])\n\n\n\n\n\nproperty created str\nUrn of the destination of this relationship edge.\n\n\n\nproperty lastModified None | Dict[str, str]\nA generic properties bag that allows us to store specific information on this graph edge.\n\n\n\nproperty sourceUrn Aspect\nStores editable changes made to properties. This separates changes made from\ningestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines\n\nParameters AuditStampClass\nAn AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.\n\n\n\nproperty deleted None | str\nEdited documentation of the chart\n\n\n\nproperty lastModified Aspect\nEditable information about an Asset Container as defined on the DataHub Platform\n\nParameters None | str\nDescription of the Asset Container as its received on the DataHub Platform\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableDashboardPropertiesClass(created=None, lastModified=None, deleted=None, description=None)\nBases\n\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ndescription (Optional[str])\n\n\n\n\n\nproperty created None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty description AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableDataFlowPropertiesClass(created=None, lastModified=None, deleted=None, description=None)\nBases\n\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ndescription (Optional[str])\n\n\n\n\n\nproperty created None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty description AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableDataJobPropertiesClass(created=None, lastModified=None, deleted=None, description=None)\nBases\n\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ndescription (Optional[str])\n\n\n\n\n\nproperty created None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty description AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableDatasetPropertiesClass(created=None, lastModified=None, deleted=None, description=None, name=None)\nBases\n\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ndescription (Optional[str])\nname (Optional[str])\n\n\n\n\n\nproperty created None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty description AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\nproperty name Aspect\nEditableERModelRelationProperties stores editable changes made to erModelRelationship properties. This separates changes made from\ningestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines\n\nParameters AuditStampClass\nAn AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.\n\n\n\nproperty deleted None | str\nDocumentation of the erModelRelationship\n\n\n\nproperty lastModified None | str\nDisplay name of the ERModelRelation\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableMLFeaturePropertiesClass(description=None)\nBases\ndescription (Optional[str])\n\n\n\n\nproperty description Aspect\nProperties associated with a MLFeatureTable editable from the ui\n\nParameters None | str\nDocumentation of the MLFeatureTable\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableMLModelGroupPropertiesClass(description=None)\nBases\ndescription (Optional[str])\n\n\n\n\nproperty description Aspect\nProperties associated with a ML Model editable from the UI\n\nParameters None | str\nDocumentation of the ml model\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableMLPrimaryKeyPropertiesClass(description=None)\nBases\ndescription (Optional[str])\n\n\n\n\nproperty description Aspect\nStores editable changes made to properties. This separates changes made from\ningestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines\nNote\n\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ndescription (Optional[str])\n\n\n\n\n\nproperty created None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty description AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableSchemaFieldInfoClass(fieldPath, description=None, globalTags=None, glossaryTerms=None)\nBases\n\nfieldPath (str)\ndescription (Optional[str])\nglobalTags (Optional[GlobalTagsClass])\nglossaryTerms (Optional[GlossaryTermsClass])\n\n\n\n\n\nproperty description str\nFieldPath uniquely identifying the SchemaField this metadata is associated with\n\n\n\nproperty globalTags None | GlossaryTermsClass\nGlossary terms associated with the field\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableSchemaMetadataClass(editableSchemaFieldInfo, created=None, lastModified=None, deleted=None)\nBases\n\neditableSchemaFieldInfo (List[EditableSchemaFieldInfoClass])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\n\n\n\n\n\nproperty created None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty editableSchemaFieldInfo AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\n\nclass datahub.metadata.schemaclasses.EmailNotificationSettingsClass(email)\nBases\nemail (str)\n\n\n\n\nproperty email Aspect\nInformation regarding rendering an embed for an asset.\n\nParameters None | str\nAn embed URL to be rendered inside of an iframe.\n\n\n\n\nclass datahub.metadata.schemaclasses.EntityChangeEventClass(entityType, entityUrn, category, operation, auditStamp, version, modifier=None, parameters=None)\nBases\n\nentityType (str)\nentityUrn (str)\ncategory (str)\noperation (str)\nauditStamp (AuditStampClass)\nversion (int)\nmodifier (Optional[str])\nparameters (Optional[ParametersClass])\n\n\n\n\n\nproperty auditStamp str\nThe category type (TAG, GLOSSARYTERM, OWNERSHIP, TECHNICALSCHEMA, etc). This is used to determine what the rest of the schema will look like.\n\n\n\nproperty entityType str\nThe urn of the entity which was affected.\n\n\n\nproperty modifier str\nThe operation type. This is used to determine what the rest of the schema will look like.\n\n\n\nproperty parameters int\nThe version of the event type, incremented in integers.\n\n\n\n\nclass datahub.metadata.schemaclasses.EntityTypeInfoClass(qualifiedName, displayName=None, description=None)\nBases\n\nqualifiedName (str)\ndisplayName (Optional[str])\ndescription (Optional[str])\n\n\n\n\n\nproperty description\nA description for the Entity Type\n\n\n\n\n\nproperty displayName str\nThe fully qualified name for the entity type, which usually consists of a namespace\nplus an identifier or name, e.g. datahub.dataset\n\n\n\n\nclass datahub.metadata.schemaclasses.EntityTypeKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\nEnum field type.\n\n\n\nclass datahub.metadata.schemaclasses.EspressoSchemaClass(documentSchema, tableSchema)\nBases\n\ndocumentSchema (str)\ntableSchema (str)\n\n\n\n\n\nproperty documentSchema str\nThe espresso table schema definition.\n\n\n\n\nclass datahub.metadata.schemaclasses.EthicalConsiderationsClass(data=None, humanLife=None, mitigations=None, risksAndHarms=None, useCases=None)\nBases\n\ndata (Optional[List[str]])\nhumanLife (Optional[List[str]])\nmitigations (Optional[List[str]])\nrisksAndHarms (Optional[List[str]])\nuseCases (Optional[List[str]])\n\n\n\n\n\nproperty data None | List[str]\nIs the MLModel intended to inform decisions about matters central to human life or flourishing - e.g., health or safety? Or could it be used in such a way?\n\n\n\nproperty mitigations None | List[str]\nWhat risks may be present in MLModel usage? Try to identify the potential recipients, likelihood, and magnitude of harms. If these cannot be determined, note that they were considered but remain unknown.\n\n\n\nproperty useCases Aspect\nAll referenced datasets would ideally point to any set of documents that provide visibility into the source and composition of the dataset.\n\nParameters List[BaseDataClass]\nDetails on the dataset(s) used for the quantitative analyses in the MLModel\n\n\n\n\nclass datahub.metadata.schemaclasses.ExecutionRequestInputClass(task, args, executorId, source, requestedAt, actorUrn=None)\nBases Determine who is responsible for emitting execution request success or failure. Executor?\n\nParameters None | str\nUrn of the actor who created this execution request.\n\n\n\nproperty args str\nspecify a specific executor to route the request to. If none is provided, a \u201cdefault\u201d executor is used.\n\nType int\nTime at which the execution request input was created\n\n\n\nproperty source str\nThe name of the task to execute, for example RUNINGEST\n\n\n\n\nclass datahub.metadata.schemaclasses.ExecutionRequestKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nThe result of an execution request\n\nParameters None | int\nDuration in milliseconds\n\n\n\nproperty report None | int\nTime at which the request was created\n\n\n\nproperty status None | StructuredExecutionReportClass\nA structured report if available.\n\n\n\n\nclass datahub.metadata.schemaclasses.ExecutionRequestSignalClass(signal, createdAt, executorId=None)\nBases\n\nsignal (str)\ncreatedAt (AuditStampClass)\nexecutorId (Optional[str])\n\n\n\n\n\nproperty createdAt None | str\nspecify a specific executor to route the request to. If none is provided, a \u201cdefault\u201d executor is used.\n\nType str\nThe signal to issue, e.g. KILL\n\n\n\n\nclass datahub.metadata.schemaclasses.ExecutionRequestSourceClass(type, ingestionSource=None)\nBases\n\ntype (str)\ningestionSource (Optional[str])\n\n\n\n\n\nproperty ingestionSource str\nThe type of the execution request source, e.g. INGESTIONSOURCE\n\n\n\n\nclass datahub.metadata.schemaclasses.FabricTypeClass\nBases DictWrapper\nAttributes defining a Field Assertion.\n\nParameters str\nThe entity targeted by this Field check.\n\n\n\nproperty fieldMetricAssertion None | FieldValuesAssertionClass\nThe definition of an assertion that validates individual values of a field / column for a set of rows.\nThis type of assertion verifies that each column value meets a particular requirement.\n\n\n\nproperty filter str | FieldAssertionTypeClass\nThe type of the field assertion being monitored.\n\n\n\n\nclass datahub.metadata.schemaclasses.FieldAssertionTypeClass\nBases DictWrapper\nInformation about the status of a particular prompt for a specific schema field\non an entity.\n\nParameters str\nThe field path on a schema field.\n\n\n\nproperty lastModified DictWrapper\nAttributes defining a field metric assertion, which asserts an expectation against\na common metric derived from the set of field / column values, for example\n\nfield (SchemaFieldSpecClass)\nmetric (Union[str, FieldMetricTypeClass])\noperator (Union[str, AssertionStdOperatorClass])\nparameters (Optional[AssertionStdParametersClass])\n\n\n\n\n\nproperty field str | FieldMetricTypeClass\nThe specific metric to assert against. This is the value that\nwill be obtained by applying a standard operation, such as an aggregation,\nto the selected field.\n\n\n\nproperty operator None | AssertionStdParametersClass\nStandard parameters required for the assertion. e.g. minvalue, maxvalue, value, columns\n\n\n\n\nclass datahub.metadata.schemaclasses.FieldMetricTypeClass\nBases DictWrapper\nDefinition of a transform applied to the values of a column / field.\nNote that the applicability of a field transform ultimately depends on the native type\nof the field / column.\nModel has single field to permit extension.\n\nParameters str | FieldTransformTypeClass\nThe type of the field transform, e.g. the transformation\nfunction / operator to apply.\n\n\n\n\nclass datahub.metadata.schemaclasses.FieldTransformTypeClass\nBases DictWrapper\nRecords field-level usage counts for a given resource\n\nParameters int\n\n\n\nproperty fieldName DictWrapper\nAttributes defining a field values assertion, which asserts that the values for a field / column\nof a dataset / table matches a set of expectations.\nIn other words, this type of assertion acts as a semantic constraint applied to fields for a specific column.\nTODO Determine whether we need an \u201coperator\u201d that can be applied to the field.\n\nParameters bool\nWhether to ignore or allow nulls when running the values assertion. (i.e.\nconsider only non-null values) using operators OTHER than the ISNULL operator.\nDefaults to true, allowing null values.\n\n\n\nproperty failThreshold SchemaFieldSpecClass\nThe field under evaluation\n\n\n\nproperty operator None | AssertionStdParametersClass\nStandard parameters required for the assertion. e.g. minvalue, maxvalue, value, columns\n\n\n\nproperty transform DictWrapper\n\nParameters str | FieldValuesFailThresholdTypeClass\nThe type of failure threshold. Either based on the number\nof column values (rows) that fail the expectations, or the percentage\nof the total rows under consideration.\n\n\n\nproperty value object\n\n\nCOUNT = 'COUNT'\n\n\n\nPERCENTAGE = 'PERCENTAGE'\n\n\n\n\nclass datahub.metadata.schemaclasses.FilterClass(or=None, criteria=None)\nBases\n\nor (Optional[List[ConjunctiveCriterionClass]])\ncriteria (Optional[List[CriterionClass]])\n\n\n\n\n\nproperty criteria None | List[ConjunctiveCriterionClass]\nA list of disjunctive criterion for the filter. (or operation to combine filters)\n\n\n\n\nclass datahub.metadata.schemaclasses.FineGrainedLineageClass(upstreamType, downstreamType, upstreams=None, downstreams=None, transformOperation=None, confidenceScore=None, query=None)\nBases\n\nupstreamType (Union[str, FineGrainedLineageUpstreamTypeClass])\ndownstreamType (Union[str, FineGrainedLineageDownstreamTypeClass])\nupstreams (Optional[List[str]])\ndownstreams (Optional[List[str]])\ntransformOperation (Optional[str])\nconfidenceScore (Optional[float])\nquery (Optional[str])\n\n\n\n\n\nproperty confidenceScore str | FineGrainedLineageDownstreamTypeClass\nThe type of downstream field(s)\n\n\n\nproperty downstreams None | str\nThe query that was used to generate this lineage.\nPresent only if the lineage was generated from a detected query.\n\n\n\nproperty transformOperation str | FineGrainedLineageUpstreamTypeClass\nThe type of upstream entity\n\n\n\nproperty upstreams object\nThe type of downstream field(s) in a fine-grained lineage\n\n\nFIELD = 'FIELD'\n\n\n\nFIELDSET = 'FIELDSET'\n\n\n\n\nclass datahub.metadata.schemaclasses.FineGrainedLineageUpstreamTypeClass\nBases DictWrapper\nAttributes defining a relative fixed interval SLA schedule.\n\nParameters int\nHow many units. Defaults to 1.\n\n\n\nproperty unit DictWrapper\nFixed field type.\n\n\n\nclass datahub.metadata.schemaclasses.ForeignKeyConstraintClass(name, foreignFields, sourceFields, foreignDataset)\nBases\n\nname (str)\nforeignFields (List[str])\nsourceFields (List[str])\nforeignDataset (str)\n\n\n\n\n\nproperty foreignDataset List[str]\nFields the constraint maps to on the foreign dataset\n\n\n\nproperty name List[str]\nFields the constraint maps to on the source dataset\n\n\n\n\nclass datahub.metadata.schemaclasses.ForeignKeySpecClass(foreignKey)\nBases\nforeignKey (Union[DatasetFieldForeignKeyClass, UrnForeignKeyClass])\n\n\n\n\nproperty foreignKey DictWrapper\n\nParameters None | List[str]\nSpecific set of groups that are targeted by this form assignment.\n\nType bool\nWhether the form should be assigned to the owners of assets that it is applied to.\nThis is the default.\n\n\n\nproperty users\nOptional\n\n\n\n\n\n\nclass datahub.metadata.schemaclasses.FormAssociationClass(urn, incompletePrompts=None, completedPrompts=None)\nBases\n\nurn (str)\nincompletePrompts (Optional[List[FormPromptAssociationClass]])\ncompletedPrompts (Optional[List[FormPromptAssociationClass]])\n\n\n\n\n\nproperty completedPrompts List[FormPromptAssociationClass]\nA list of prompts that are not yet complete for this form.\n\n\n\nproperty urn Aspect\nInformation about a form to help with filling out metadata on entities.\n\nParameters FormActorAssignmentClass\nWho the form is assigned to, e.g. who should see the form when visiting the entity page or governance center\n\n\n\nproperty description str\nDisplay name of the form\n\n\n\nproperty prompts str | FormTypeClass\nThe type of this form\n\n\n\n\nclass datahub.metadata.schemaclasses.FormKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\nInformation about the status of a particular prompt.\nNote that this is where we can add additional information about individual responses\n\nid (str)\nlastModified (AuditStampClass)\nfieldAssociations (Optional[FormPromptFieldAssociationsClass])\n\n\n\n\n\nproperty fieldAssociations str\nThe id for the prompt. This must be GLOBALLY UNIQUE.\n\n\n\nproperty lastModified DictWrapper\nA prompt to present to the user to encourage filling out metadata\n\nParameters None | str\nThe description of this prompt\n\n\n\nproperty id bool\nWhether the prompt is required to be completed, in order for the form to be marked as complete.\n\n\n\nproperty structuredPropertyParams str\nThe title of this prompt\n\n\n\nproperty type DictWrapper\nInformation about the field-level prompt associations on a top-level prompt association.\n\nParameters None | List[FieldFormPromptAssociationClass]\nA list of field-level prompt associations that are not yet complete for this form.\n\n\n\nproperty incompleteFieldPrompts object\n\n\nFIELDSSTRUCTUREDPROPERTY = 'FIELDSSTRUCTUREDPROPERTY'\n\n\n\nSTRUCTUREDPROPERTY = 'STRUCTUREDPROPERTY'\n\n\n\n\nclass datahub.metadata.schemaclasses.FormTypeClass\nBases DictWrapper\nAn association between a verification and an entity that has been granted\nvia completion of one or more forms of type \u2018VERIFICATION\u2019.\n\nParameters str\nThe urn of the form that granted this verification.\n\n\n\nproperty lastModified Aspect\nForms that are assigned to this entity to be filled out\n\nParameters List[FormAssociationClass]\nAll complete forms assigned to the entity.\n\n\n\nproperty incompleteForms List[FormVerificationAssociationClass]\nVerifications that have been applied to the entity via completed forms.\n\n\n\n\nclass datahub.metadata.schemaclasses.FreshnessAssertionInfoClass(type, entity, schedule, filter=None)\nBases\n\ntype (Union[str, FreshnessAssertionTypeClass])\nentity (str)\nschedule (FreshnessAssertionScheduleClass)\nfilter (Optional[DatasetFilterClass])\n\n\n\n\n\nproperty entity None | DatasetFilterClass\nA definition of the specific filters that should be applied, when performing monitoring.\nIf not provided, there is no filter, and the full table is under consideration.\n\n\n\nproperty schedule str | FreshnessAssertionTypeClass\nThe type of the freshness assertion being monitored.\n\n\n\n\nclass datahub.metadata.schemaclasses.FreshnessAssertionScheduleClass(type, cron=None, fixedInterval=None)\nBases\n\ntype (Union[str, FreshnessAssertionScheduleTypeClass])\ncron (Optional[FreshnessCronScheduleClass])\nfixedInterval (Optional[FixedIntervalScheduleClass])\n\n\n\n\n\nproperty cron None | FixedIntervalScheduleClass\nA fixed interval schedule. This field is required when type is FIXEDINTERVAL.\n\n\n\nproperty type object\n\n\nCRON = 'CRON'\n\n\n\nFIXEDINTERVAL = 'FIXEDINTERVAL'\n\n\n\nSINCETHELASTCHECK = 'SINCETHELASTCHECK'\n\n\n\n\nclass datahub.metadata.schemaclasses.FreshnessAssertionTypeClass\nBases DictWrapper\nA contract pertaining to the operational SLAs of a physical data asset\n\nParameters str\nThe assertion representing the SLA contract.\n\n\n\n\nclass datahub.metadata.schemaclasses.FreshnessCronScheduleClass(cron, timezone, windowStartOffsetMs=None)\nBases\n\ncron (str)\ntimezone (str)\nwindowStartOffsetMs (Optional[int])\n\n\n\n\n\nproperty cron str\nTimezone in which the cron interval applies, e.g. America/Los Angeles\n\n\n\nproperty windowStartOffsetMs DictWrapper\nGeneric record structure for serializing an Aspect\n\nParameters str\nThe content type, which represents the fashion in which the aspect was serialized.\nThe only type currently supported is application/json.\n\n\n\nproperty value DictWrapper\nGeneric payload record structure for serializing a Platform Event.\n\nParameters str\nThe content type, which represents the fashion in which the event was serialized.\nThe only type currently supported is application/json.\n\n\n\nproperty value Aspect\nDataHub Global platform settings. Careful - these should not be modified by the outside world!\n\nParameters DocPropagationFeatureSettingsClass | None\nSettings related to the documentation propagation feature\n\n\n\nproperty sso None | GlobalViewsSettingsClass\nSettings related to the Views Feature\n\n\n\n\nclass datahub.metadata.schemaclasses.GlobalSettingsKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty idglobalSettings\nId for the settings. There should be only 1 global settings urn\n\nType Aspect\nTag aspect used for applying tags to an entity\n\nParameters List[TagAssociationClass]\nTags associated with a given entity\n\n\n\n\nclass datahub.metadata.schemaclasses.GlobalViewsSettingsClass(defaultView=None)\nBases\ndefaultView (Optional[str])\n\n\n\n\nproperty defaultView Aspect\nProperties associated with a GlossaryNode\n\nParameters Dict[str, str]\nCustom property bag.\n\n\n\nproperty definition None | str\nOptional id for the GlossaryNode\n\n\n\nproperty name None | str\nParent node of the glossary term\n\n\n\n\nclass datahub.metadata.schemaclasses.GlossaryNodeKeyClass(name)\nBases\nname (str)\n\n\n\n\nproperty name DictWrapper\nA metadata snapshot for a specific GlossaryNode entity.\n\nParameters List[GlossaryNodeKeyClass | GlossaryNodeInfoClass | OwnershipClass | StatusClass]\nThe list of metadata aspects associated with the GlossaryNode. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nHas A / Is A lineage information about a glossary Term reporting the lineage\n\nParameters None | List[str]\nThe relationship Has A with glossary term\n\n\n\nproperty isRelatedTerms None | List[str]\nThe relationship isRelatedTo with glossary term\n\n\n\nproperty values DictWrapper\nProperties of an applied glossary term.\n\nParameters None | str\nThe user URN which will be credited for adding associating this term to the entity\n\n\n\nproperty attribution None | str\nAdditional context about the association\n\n\n\nproperty urn Aspect\nProperties associated with a GlossaryTerm\n\nParameters Dict[str, str]\nCustom property bag.\n\n\n\nproperty definition None | str\nOptional id for the term\n\n\n\nproperty name None | str\nParent node of the glossary term\n\n\n\nproperty rawSchema None | str\nExternal Reference to the business-term\n\n\n\nproperty sourceUrl\nThe abstracted URL such as https\n\n\n\n\n\nproperty termSource Aspect\nKey for a GlossaryTerm\n\nParameters str\nThe term name, which serves as a unique id\n\n\n\n\nclass datahub.metadata.schemaclasses.GlossaryTermSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[GlossaryTermKeyClass, GlossaryTermInfoClass, OwnershipClass, StatusClass, BrowsePathsClass, GlossaryRelatedTermsClass]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.GlossaryTermsClass(terms, auditStamp)\nBases\n\nterms (List[GlossaryTermAssociationClass])\nauditStamp (AuditStampClass)\n\n\n\n\n\nproperty auditStamp List[GlossaryTermAssociationClass]\nThe related business terms\n\n\n\n\nclass datahub.metadata.schemaclasses.GroupMembershipClass(groups)\nBases\ngroups (List[str])\n\n\n\n\nproperty groups DictWrapper\n\nParameters List[str]\n\n\n\nproperty heights Aspect\nIceberg Catalog metadata associated with an Iceberg table/view\n\nParameters None | str\nWhen Datahub is the REST Catalog for an Iceberg Table, stores the current metadata pointer.\nIf the Iceberg table is managed by an external catalog, the metadata pointer is not set.\n\n\n\nproperty view Aspect\nAn Iceberg warehouse location and credentails whose read/writes are governed by datahub catalog.\n\nParameters str\nclientId to be used to authenticate with storage hosting this warehouse\n\n\n\nproperty clientSecret str\nPath of the root for the backing store of the tables in the warehouse.\n\n\n\nproperty env str\nregion where the warehouse is located.\n\n\n\nproperty role None | int\n\n\n\n\nclass datahub.metadata.schemaclasses.IconLibraryClass\nBases DictWrapper\nProperties describing an icon associated with an entity\n\nParameters str | IconLibraryClass\ne.g. Antd, Material, etc\n\nType str\nThe name of the icon\n\n\n\nproperty style DictWrapper\nThe incident assignee type.\nThis is in a record so that we can add additional fields if we need to later (e.g.\nthe type of the assignee.\n\nParameters str\nThe user or group assigned to the incident.\n\n\n\nproperty assignedAt Aspect\nInformation about an incident raised on an asset.\n\nParameters None | List[IncidentAssigneeClass]\nThe parties assigned with resolving the incident\n\n\n\nproperty created None | str\nAn optional custom incident type. Present only if type is \u2018CUSTOM\u2019.\n\n\n\nproperty description List[str]\nA reference to the entity associated with the incident.\n\n\n\nproperty priority 0 - CRITICAL, 1 - HIGH, 2 - MED, 3 - LOW\n(We probably should have modeled as an enum)\n\n\n\nproperty source None | int\nThe time at which the incident actually started (may be before the date it was raised).\n\n\n\nproperty status None | str\nOptional title associated with the incident\n\n\n\nproperty type Aspect\nKey for an asset Incident\n\nParameters str\nA unique id for the incident. Generated on the server side at incident creation time.\n\n\n\n\nclass datahub.metadata.schemaclasses.IncidentSourceClass(type, sourceUrn=None)\nBases\n\ntype (Union[str, IncidentSourceTypeClass])\nsourceUrn (Optional[str])\n\n\n\n\n\nproperty sourceUrn str | IncidentSourceTypeClass\nMessage associated with the incident\n\n\n\n\nclass datahub.metadata.schemaclasses.IncidentSourceTypeClass\nBases object\n\n\nFIXED = 'FIXED'\n\n\n\nINVESTIGATION = 'INVESTIGATION'\n\n\n\nNOACTIONREQUIRED = 'NOACTIONREQUIRED'\n\n\n\nTRIAGE = 'TRIAGE'\n\n\n\nWORKINPROGRESS = 'WORKINPROGRESS'\n\n\n\n\nclass datahub.metadata.schemaclasses.IncidentStateClass\nBases DictWrapper\nInformation about an incident raised on an asset\n\nParameters AuditStampClass\nThe time at which the request was initially created\n\n\n\nproperty message None | str | IncidentStageClass\nThe lifecycle stage for the incident - Null means no stage was assigned yet.\nIn the future, we may add CUSTOM here with a customStage string field for user-defined stages.\n\n\n\nproperty state DictWrapper\nSummary statistics about incidents on an entity.\n\nParameters int\nThe time at which the incident was raised in milliseconds since epoch.\n\n\n\nproperty priority None | int\nThe time at which the incident was marked as resolved in milliseconds since epoch. Null if the incident is still active.\n\n\n\nproperty type str\nThe urn of the incident\n\n\n\n\nclass datahub.metadata.schemaclasses.IncidentTypeClass\nBases Aspect\nSummary related incidents on an entity.\n\nParameters List[IncidentSummaryDetailsClass]\nSummary details about the set of active incidents\n\n\n\nproperty activeIncidents List[IncidentSummaryDetailsClass]\nSummary details about the set of resolved incidents\n\n\n\nproperty resolvedIncidents DictWrapper\nThe definition of the transformer function that should be applied to a given field / column value in a dataset\nin order to determine the segment or bucket that it belongs to, which in turn is used to evaluate\nvolume assertions.\n\nParameters None | str\nThe \u2018native\u2019 transformer type, useful as a back door if a custom operator is required.\nThis field is required if the type is NATIVE.\n\n\n\nproperty type object\n\n\nCEILING = 'CEILING'\n\n\n\nFLOOR = 'FLOOR'\n\n\n\nNATIVE = 'NATIVE'\n\n\n\nTIMESTAMPMSTODATE = 'TIMESTAMPMSTODATE'\n\n\n\nTIMESTAMPMSTOHOUR = 'TIMESTAMPMSTOHOUR'\n\n\n\nTIMESTAMPMSTOMINUTE = 'TIMESTAMPMSTOMINUTE'\n\n\n\nTIMESTAMPMSTOMONTH = 'TIMESTAMPMSTOMONTH'\n\n\n\nTIMESTAMPMSTOYEAR = 'TIMESTAMPMSTOYEAR'\n\n\n\n\nclass datahub.metadata.schemaclasses.IncrementingSegmentRowCountChangeClass(segment, type, operator, parameters)\nBases\n\nsegment (IncrementingSegmentSpecClass)\ntype (Union[str, AssertionValueChangeTypeClass])\noperator (Union[str, AssertionStdOperatorClass])\nparameters (AssertionStdParametersClass)\n\n\n\n\n\nproperty operator\nGREATERTHAN, GREATERTHANOREQUALTO, EQUALTO, LESSTHAN, LESSTHANOREQUALTO,\nBETWEEN.\n\n\n\nproperty parameters NUMBER.\n\n\n\nproperty segment str | AssertionValueChangeTypeClass\na fixed absolute value or a relative percentage.\n\nType DictWrapper\nAttributes defining an INCREMENTINGSEGMENTROWCOUNTTOTAL volume assertion.\n\nParameters str | AssertionStdOperatorClass\nThe operator you\u2019d like to apply.\nNote that only numeric operators are valid inputs AssertionStdParametersClass\nThe parameters you\u2019d like to provide as input to the operator.\nNote that only numeric parameter types are valid inputs IncrementingSegmentSpecClass\nA specification of how the \u2018segment\u2019 can be derived using a column and an optional transformer function.\n\n\n\n\nclass datahub.metadata.schemaclasses.IncrementingSegmentSpecClass(field, transformer=None)\nBases\n\n\nA field or column that represents the incrementing value. New rows that are inserted will be identified using this column.\nNote that the value of this column may not by itself represent the \u201cbucket\u201d or the \u201csegment\u201d in which the row falls.\n[Optional] An transformer function that may be applied to the selected column value in order\nto obtain the final \u201csegment identifier\u201d or \u201cbucket identifier\u201d. Rows that have the same value after applying the transformation\nwill be grouped into the same segment, using which the final value (e.g. row count) will be determined.\n\n\n\nParameters SchemaFieldSpecClass\nThe field to use to generate segments. It must be constantly incrementing as new rows are inserted.\n\n\n\nproperty transformer DictWrapper\nThe checkpoint state object of a datahub ingestion run for a given job.\n\nParameters str\nThe version of the state format.\n\n\n\nproperty payload str\nThe serialization/deserialization protocol.\n\n\n\n\nclass datahub.metadata.schemaclasses.InputFieldClass(schemaFieldUrn, schemaField=None)\nBases\n\nschemaFieldUrn (str)\nschemaField (Optional[SchemaFieldClass])\n\n\n\n\n\nproperty schemaField str\nUrn of the schema being referenced for lineage purposes\n\n\n\n\nclass datahub.metadata.schemaclasses.InputFieldsClass(fields)\nBases\nfields (List[InputFieldClass])\n\n\n\n\nproperty fields Aspect\nInstitutional memory of an entity. This is a way to link to relevant documentation and provide description of the documentation. Institutional or tribal knowledge is very important for users to leverage the entity.\n\nParameters List[InstitutionalMemoryMetadataClass]\nList of records that represent institutional memory of an entity. Each record consists of a link, description, creator and timestamps associated with that record.\n\n\n\n\nclass datahub.metadata.schemaclasses.InstitutionalMemoryMetadataClass(url, description, createStamp)\nBases\n\nurl (str)\ndescription (str)\ncreateStamp (AuditStampClass)\n\n\n\n\n\nproperty createStamp str\nDescription of the link.\n\n\n\nproperty url Aspect\nIntended Use for the ML Model\n\nParameters None | List[str]\nHighlight technology that the MLModel might easily be confused with, or related contexts that users could try to apply the MLModel to.\n\n\n\nproperty primaryUsers None | List[str]\nPrimary Use cases for the MLModel.\n\n\n\n\nclass datahub.metadata.schemaclasses.IntendedUserTypeClass\nBases Aspect\nAspect used to store invite tokens.\n\nParameters None | str\nThe role that this invite token may be associated with\n\n\n\nproperty token Aspect\nKey for an InviteToken.\n\nParameters str\nA unique id for the invite token.\n\n\n\n\nclass datahub.metadata.schemaclasses.JobStatusClass\nBases DictWrapper\nThis header records information about the context of an event as it is emitted into kafka and is intended to be used by the kafka audit application. For more information see go/kafkaauditheader\n\nParameters str\nThe name of the application from which the event is being emitted. see go/appname\n\n\n\nproperty auditVersion\nThe version that is being used for auditing. In version 0, the audit trail buckets events into 10 minute audit windows based on the EventHeader timestamp. In version 1, the audit trail buckets events as follows\n\n\n\n\n\nproperty clusterConnectionString None | str\nfabric\nThe fabricUrn of the host from which the event is being emitted. Fabric Urn in the format of urn\n\nType None | str\nThe instance on the server from which the event is being emitted. e.g. i001\n\n\n\nproperty messageId str\nThe fully qualified name of the host from which the event is being emitted.\n\n\n\nproperty time DictWrapper\nSchema holder for kafka schema.\n\nParameters str\nThe native kafka document schema. This is a human readable avro document schema.\n\n\n\nproperty documentSchemaType None | str\nThe native kafka key schema as retrieved from Schema Registry\n\n\n\nproperty keySchemaType DictWrapper\nSchema text of a key-value store schema.\n\nParameters str\nThe raw schema for the key in the key-value store.\n\n\n\nproperty valueSchema object\nMLFeature Data Type\n\n\nAUDIO = 'AUDIO'\n\n\n\nBINARY = 'BINARY'\n\n\n\nBYTE = 'BYTE'\n\n\n\nCONTINUOUS = 'CONTINUOUS'\n\n\n\nCOUNT = 'COUNT'\n\n\n\nIMAGE = 'IMAGE'\n\n\n\nINTERVAL = 'INTERVAL'\n\n\n\nMAP = 'MAP'\n\n\n\nNOMINAL = 'NOMINAL'\n\n\n\nORDINAL = 'ORDINAL'\n\n\n\nSEQUENCE = 'SEQUENCE'\n\n\n\nSET = 'SET'\n\n\n\nTEXT = 'TEXT'\n\n\n\nTIME = 'TIME'\n\n\n\nUNKNOWN = 'UNKNOWN'\n\n\n\nUSELESS = 'USELESS'\n\n\n\nVIDEO = 'VIDEO'\n\n\n\n\nclass datahub.metadata.schemaclasses.MLFeatureKeyClass(featureNamespace, name)\nBases\n\nfeatureNamespace (str)\nname (str)\n\n\n\n\n\nproperty featureNamespace str\nName of the feature\n\n\n\n\nclass datahub.metadata.schemaclasses.MLFeaturePropertiesClass(customProperties=None, description=None, dataType=None, version=None, sources=None)\nBases\n\ncustomProperties (Optional[Dict[str, str]])\ndescription (Optional[str])\ndataType (Union[None, str, MLFeatureDataTypeClass])\nversion (Optional[VersionTagClass])\nsources (Optional[List[str]])\n\n\n\n\n\nproperty customProperties None | str | MLFeatureDataTypeClass\nData Type of the MLFeature\n\n\n\nproperty description None | List[str]\nSource of the MLFeature\n\n\n\nproperty version DictWrapper\n\nParameters List[MLFeatureKeyClass | MLFeaturePropertiesClass | OwnershipClass | InstitutionalMemoryClass | StatusClass | DeprecationClass | BrowsePathsClass | GlobalTagsClass | DataPlatformInstanceClass | BrowsePathsV2Class]\nThe list of metadata aspects associated with the MLFeature. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nKey for an MLFeatureTable\n\nParameters str\nName of the feature table\n\n\n\nproperty platform Aspect\nProperties associated with a MLFeatureTable\n\nParameters Dict[str, str]\nCustom property bag.\n\n\n\nproperty description None | List[str]\nList of features contained in the feature table\n\n\n\nproperty mlPrimaryKeys DictWrapper\n\nParameters List[MLFeatureTableKeyClass | MLFeatureTablePropertiesClass | OwnershipClass | InstitutionalMemoryClass | StatusClass | DeprecationClass | BrowsePathsClass | GlobalTagsClass | DataPlatformInstanceClass | BrowsePathsV2Class]\nThe list of metadata aspects associated with the MLFeatureTable. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nProperties associated with an ML Hyper Param\n\nParameters None | int\nDate when the MLHyperParam was developed\n\n\n\nproperty description str\nName of the MLHyperParam\n\n\n\nproperty value Aspect\nProperties associated with an ML Metric\n\nParameters None | int\nDate when the mlMetric was developed\n\n\n\nproperty description str\nName of the mlMetric\n\n\n\nproperty value Aspect\nKey for an ML model deployment\n\nParameters str\nName of the MLModelDeployment\n\n\n\nproperty origin str\nStandardized platform urn for the model Deployment\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelDeploymentPropertiesClass(customProperties=None, externalUrl=None, description=None, createdAt=None, version=None, status=None)\nBases\n\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\ndescription (Optional[str])\ncreatedAt (Optional[int])\nversion (Optional[VersionTagClass])\nstatus (Union[None, str, DeploymentStatusClass])\n\n\n\n\n\nproperty createdAt Dict[str, str]\nCustom property bag.\n\n\n\nproperty description None | str\nURL where the reference exist\n\n\n\nproperty status None | VersionTagClass\nVersion of the MLModelDeployment\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelDeploymentSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[MLModelDeploymentKeyClass, MLModelDeploymentPropertiesClass, OwnershipClass, StatusClass, DeprecationClass, GlobalTagsClass, DataPlatformInstanceClass]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelFactorPromptsClass(relevantFactors=None, evaluationFactors=None)\nBases\n\nrelevantFactors (Optional[List[MLModelFactorsClass]])\nevaluationFactors (Optional[List[MLModelFactorsClass]])\n\n\n\n\n\nproperty evaluationFactors None | List[MLModelFactorsClass]\nWhat are foreseeable salient factors for which MLModel performance may vary, and how were these determined?\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelFactorsClass(groups=None, instrumentation=None, environment=None)\nBases\n\ngroups (Optional[List[str]])\ninstrumentation (Optional[List[str]])\nenvironment (Optional[List[str]])\n\n\n\n\n\nproperty environment None | List[str]\nGroups refers to distinct categories with similar characteristics that are present in the evaluation data instances.\nFor human-centric machine learning MLModels, groups are people who share one or multiple characteristics.\n\n\n\nproperty instrumentation Aspect\nKey for an ML model group\n\nParameters str\nName of the MLModelGroup\n\n\n\nproperty origin str\nStandardized platform urn for the model group\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelGroupPropertiesClass(customProperties=None, trainingJobs=None, downstreamJobs=None, externalUrl=None, name=None, description=None, createdAt=None, created=None, lastModified=None, version=None)\nBases\n\ncustomProperties (Optional[Dict[str, str]])\ntrainingJobs (Optional[List[str]])\ndownstreamJobs (Optional[List[str]])\nexternalUrl (Optional[str])\nname (Optional[str])\ndescription (Optional[str])\ncreatedAt (Optional[int])\ncreated (Optional[TimeStampClass])\nlastModified (Optional[TimeStampClass])\nversion (Optional[VersionTagClass])\n\n\n\n\n\nproperty created None | int\nDate when the MLModelGroup was developed\n\n\n\nproperty customProperties None | str\nDocumentation of the MLModelGroup\n\n\n\nproperty downstreamJobs None | str\nURL where the reference exist\n\n\n\nproperty lastModified None | str\nDisplay name of the MLModelGroup\n\n\n\nproperty trainingJobs None | VersionTagClass\nVersion of the MLModelGroup\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelGroupSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[MLModelGroupKeyClass, MLModelGroupPropertiesClass, OwnershipClass, StatusClass, DeprecationClass, BrowsePathsClass, GlobalTagsClass, DataPlatformInstanceClass, BrowsePathsV2Class]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelKeyClass(platform, name, origin)\nBases\n\nplatform (str)\nname (str)\norigin (Union[str, FabricTypeClass])\n\n\n\n\n\nproperty name str | FabricTypeClass\nFabric type where model belongs to or where it was generated\n\n\n\nproperty platform Aspect\nProperties associated with a ML Model\n\nParameters None | TimeStampClass\nAudit stamp containing who created this and when\n\n\n\nproperty customProperties None | int\nDate when the MLModel was developed\n\n\n\nproperty deployments None | str\nDocumentation of the MLModel\n\n\n\nproperty downstreamJobs None | str\nURL where the reference exist\n\n\n\nproperty groups None | Dict[str, str | int | float | bool]\nHyper Parameters of the MLModel\nNOTE None | List[MLHyperParamClass]\nHyperparameters of the MLModel\n\n\n\nproperty lastModified None | List[str]\nList of features used for MLModel training\n\n\n\nproperty name None | List[MLMetricClass]\nMetrics of the MLModel used in production\n\n\n\nproperty tags None | List[str]\nList of jobs or process instances (if any) used to train the model or group. Visible in Lineage. Note that ML Models can also be specified as the output of a specific Data Process Instances (runs) via the DataProcessInstanceOutputs aspect.\n\n\n\nproperty trainingMetrics None | str\nType of Algorithm or MLModel such as whether it is a Naive Bayes classifier, Convolutional Neural Network, etc\n\n\n\nproperty version DictWrapper\nMLModel Snapshot entity details.\n\nParameters List[MLModelKeyClass | OwnershipClass | MLModelPropertiesClass | IntendedUseClass | MLModelFactorPromptsClass | MetricsClass | EvaluationDataClass | TrainingDataClass | QuantitativeAnalysesClass | EthicalConsiderationsClass | CaveatsAndRecommendationsClass | InstitutionalMemoryClass | SourceCodeClass | StatusClass | CostClass | DeprecationClass | BrowsePathsClass | GlobalTagsClass | DataPlatformInstanceClass | BrowsePathsV2Class]\nThe list of metadata aspects associated with the MLModel. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nKey for an MLPrimaryKey\n\nParameters str\nNamespace for the primary key\n\n\n\nproperty name Aspect\nProperties associated with a MLPrimaryKey\n\nParameters Dict[str, str]\nCustom property bag.\n\n\n\nproperty dataType None | str\nDocumentation of the MLPrimaryKey\n\n\n\nproperty sources None | VersionTagClass\nVersion of the MLPrimaryKey\n\n\n\n\nclass datahub.metadata.schemaclasses.MLPrimaryKeySnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[MLPrimaryKeyKeyClass, MLPrimaryKeyPropertiesClass, OwnershipClass, InstitutionalMemoryClass, StatusClass, DeprecationClass, GlobalTagsClass, DataPlatformInstanceClass]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.MLTrainingRunPropertiesClass(customProperties=None, externalUrl=None, id=None, outputUrls=None, hyperParams=None, trainingMetrics=None)\nBases\n\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\nid (Optional[str])\noutputUrls (Optional[List[str]])\nhyperParams (Optional[List[MLHyperParamClass]])\ntrainingMetrics (Optional[List[MLMetricClass]])\n\n\n\n\n\nproperty customProperties None | str\nURL where the reference exist\n\n\n\nproperty hyperParams None | str\nRun Id of the ML Training Run\n\n\n\nproperty outputUrls None | List[MLMetricClass]\nMetrics of the ML Training Run\n\n\n\n\nclass datahub.metadata.schemaclasses.MapTypeClass(keyType=None, valueType=None)\nBases\n\nkeyType (Optional[str])\nvalueType (Optional[str])\n\n\n\n\n\nproperty keyType None | str\nType of the value in a map\n\n\n\n\nclass datahub.metadata.schemaclasses.MediaClass(type, location)\nBases\n\ntype (Union[str, MediaTypeClass])\nlocation (str)\n\n\n\n\n\nproperty location str | MediaTypeClass\nType of content the Media is storing, e.g. image, video, etc.\n\n\n\n\nclass datahub.metadata.schemaclasses.MediaTypeClass\nBases DictWrapper\nInformation about who, why, and how this metadata was applied\n\nParameters str\nThe entity (e.g. a member URN) responsible for applying the assocated metadata. This can\neither be a user (in case of UI edits) or the datahub system for automation.\n\n\n\nproperty source Dict[str, str]\nThe details associated with why this metadata was applied. For example, this could include\nthe actual regex rule, sql statement, ingestion pipeline ID, etc.\n\n\n\nproperty time DictWrapper\nKafka event for proposing a metadata change for an entity. A corresponding MetadataAuditEvent is emitted when the change is accepted and committed, otherwise a FailedMetadataChangeEvent will be emitted instead.\n\nParameters None | KafkaAuditHeaderClass\nKafka audit header. See go/kafkaauditheader for more info.\n\n\n\nproperty proposedDelta ChartSnapshotClass | CorpGroupSnapshotClass | CorpUserSnapshotClass | DashboardSnapshotClass | DataFlowSnapshotClass | DataJobSnapshotClass | DatasetSnapshotClass | DataProcessSnapshotClass | DataPlatformSnapshotClass | MLModelSnapshotClass | MLPrimaryKeySnapshotClass | MLFeatureSnapshotClass | MLFeatureTableSnapshotClass | MLModelDeploymentSnapshotClass | MLModelGroupSnapshotClass | TagSnapshotClass | GlossaryTermSnapshotClass | GlossaryNodeSnapshotClass | DataHubPolicySnapshotClass | SchemaFieldSnapshotClass | DataHubRetentionSnapshotClass\nSnapshot of the proposed metadata change. Include only the aspects affected by the change in the snapshot.\n\n\n\nproperty systemMetadata DictWrapper\nKafka event for capturing update made to an entity\u2019s metadata.\n\nParameters None | GenericAspectClass\nThe value of the new aspect.\n\n\n\nproperty aspectName This is only valid for CREATE, UPSERT, and DELETE operations.\n\n\n\nproperty auditHeader str | ChangeTypeClass\nType of change being proposed\n\n\n\nproperty created None | GenericAspectClass\nKey aspect of the entity being written\n\n\n\nproperty entityType None | str\nUrn of the entity being written\n\n\n\nproperty headers None | GenericAspectClass\nThe previous value of the aspect that has changed.\n\n\n\nproperty previousSystemMetadata None | SystemMetadataClass\nSystem properties that one might want to attach to an event\n\n\n\n\nclass datahub.metadata.schemaclasses.MetadataChangeProposalClass(entityType, changeType, auditHeader=None, entityUrn=None, entityKeyAspect=None, aspectName=None, aspect=None, systemMetadata=None, headers=None)\nBases\n\nentityType (str)\nchangeType (Union[str, ChangeTypeClass])\nauditHeader (Optional[KafkaAuditHeaderClass])\nentityUrn (Optional[str])\nentityKeyAspect (Optional[GenericAspectClass])\naspectName (Optional[str])\naspect (Optional[GenericAspectClass])\nsystemMetadata (Optional[SystemMetadataClass])\nheaders (Optional[Dict[str, str]])\n\n\n\n\n\nproperty aspect None | str\nAspect of the entity being written to\nNot filling this out implies that the writer wants to affect the entire entity\nNote None | KafkaAuditHeaderClass\nKafka audit header. Currently remains unused in the open source.\n\n\n\nproperty changeType None | GenericAspectClass\nKey aspect of the entity being written\n\n\n\nproperty entityType None | str\nUrn of the entity being written\n\n\n\nproperty headers None | SystemMetadataClass\nSystem properties that one might want to attach to an event\n\n\n\n\nclass datahub.metadata.schemaclasses.MetricsClass(performanceMeasures=None, decisionThreshold=None)\nBases\n\nperformanceMeasures (Optional[List[str]])\ndecisionThreshold (Optional[List[str]])\n\n\n\n\n\nproperty decisionThreshold None | List[str]\nMeasures of MLModel performance\n\n\n\n\nclass datahub.metadata.schemaclasses.MySqlDDLClass(tableSchema)\nBases\ntableSchema (str)\n\n\n\n\nproperty tableSchema Aspect\nCarries information about the native CorpGroups a user is in.\n\nParameters List[str]\n\n\n\n\nclass datahub.metadata.schemaclasses.NotebookCellClass(type, textCell=None, queryCell=None, chartCell=None)\nBases\n\ntype (Union[str, NotebookCellTypeClass])\ntextCell (Optional[TextCellClass])\nqueryCell (Optional[QueryCellClass])\nchartCell (Optional[ChartCellClass])\n\n\n\n\n\nproperty chartCell None | QueryCellClass\nThe query cell content. The will be non-null only when all other cell field is null.\n\n\n\nproperty textCell str | NotebookCellTypeClass\nThe type of this Notebook cell\n\n\n\n\nclass datahub.metadata.schemaclasses.NotebookCellTypeClass\nBases Aspect\nContent in a Notebook\nNote\ncells (Optional[List[NotebookCellClass]])\n\n\n\n\nproperty cells Aspect\nInformation about a Notebook\nNote\n\ntitle (str)\nchangeAuditStamps (ChangeAuditStampsClass)\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\ndescription (Optional[str])\n\n\n\n\n\nproperty changeAuditStamps Dict[str, str]\nCustom property bag.\n\n\n\nproperty description None | str\nURL where the reference exist\n\n\n\nproperty title Aspect\nKey for a Notebook\n\nParameters str\nUnique id for the Notebook. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as \u2018querybook.com/notebook/773\u2019\n\n\n\nproperty notebookTool DictWrapper\nNotification settings for an actor or subscription.\n\nParameters None | EmailNotificationSettingsClass\nEmail Notification Settings\n\n\n\nproperty sinkTypes None | SlackNotificationSettingsClass\nSlack Notification Settings\n\n\n\n\nclass datahub.metadata.schemaclasses.NotificationSinkTypeClass\nBases DictWrapper\nNull field type.\n\n\n\nclass datahub.metadata.schemaclasses.NumberTypeClass\nBases long, integer, short, etc..\n\n\n\nclass datahub.metadata.schemaclasses.OidcSettingsClass(enabled, clientId, clientSecret, discoveryUri, userNameClaim=None, userNameClaimRegex=None, scope=None, clientAuthenticationMethod=None, jitProvisioningEnabled=None, preProvisioningRequired=None, extractGroupsEnabled=None, groupsClaim=None, responseType=None, responseMode=None, useNonce=None, readTimeout=None, extractJwtAccessTokenClaims=None, preferredJwsAlgorithm=None, preferredJwsAlgorithm2=None)\nBases\n\nenabled (bool)\nclientId (str)\nclientSecret (str)\ndiscoveryUri (str)\nuserNameClaim (Optional[str])\nuserNameClaimRegex (Optional[str])\nscope (Optional[str])\nclientAuthenticationMethod (Optional[str])\njitProvisioningEnabled (Optional[bool])\npreProvisioningRequired (Optional[bool])\nextractGroupsEnabled (Optional[bool])\ngroupsClaim (Optional[str])\nresponseType (Optional[str])\nresponseMode (Optional[str])\nuseNonce (Optional[bool])\nreadTimeout (Optional[int])\nextractJwtAccessTokenClaims (Optional[bool])\npreferredJwsAlgorithm (Optional[str])\npreferredJwsAlgorithm2 (Optional[str])\n\n\n\n\n\nproperty clientAuthenticationMethod\nADVANCED. Which authentication method to use to pass credentials (clientId and clientSecret) to the token endpoint\n\n\n\n\n\nproperty clientId str\nUnique client secret issued by the identity provider.\n\n\n\nproperty discoveryUri bool\nWhether OIDC SSO is enabled.\n\n\n\nproperty extractGroupsEnabled None | bool\nADVANCED. Whether to extract claims from JWT access token. Defaults to false.\n\n\n\nproperty groupsClaim None | bool\nADVANCED. Whether DataHub users should be provisioned on login if they do not exist. Defaults to true.\n\n\n\nproperty preProvisioningRequired None | str\nADVANCED. Which jws algorithm to use. Unused.\n\n\n\nproperty preferredJwsAlgorithm2 None | int\nADVANCED. Read timeout.\n\n\n\nproperty responseMode None | str\nADVANCED. Response type.\n\n\n\nproperty scope None | bool\nADVANCED. Use Nonce.\n\n\n\nproperty userNameClaim None | str\nADVANCED. TThe regex used to parse the DataHub username from the user name claim. Defaults to (.*) (all).\n\n\n\n\nclass datahub.metadata.schemaclasses.OperationClass(timestampMillis, operationType, lastUpdatedTimestamp, eventGranularity=None, partitionSpec=None, messageId=None, actor=None, customOperationType=None, numAffectedRows=None, affectedDatasets=None, sourceType=None, customProperties=None)\nBases\n\ntimestampMillis (int)\noperationType (Union[str, OperationTypeClass])\nlastUpdatedTimestamp (int)\neventGranularity (Optional[TimeWindowSizeClass])\npartitionSpec (Optional[PartitionSpecClass])\nmessageId (Optional[str])\nactor (Optional[str])\ncustomOperationType (Optional[str])\nnumAffectedRows (Optional[int])\naffectedDatasets (Optional[List[str]])\nsourceType (Union[None, str, OperationSourceTypeClass])\ncustomProperties (Optional[Dict[str, str]])\n\n\n\n\n\nASPECTTYPE None | str\nActor who issued this operation.\n\n\n\nproperty affectedDatasets None | str\nA custom type of operation. Required if operationType is CUSTOM.\n\n\n\nproperty customProperties None | TimeWindowSizeClass\nGranularity of the event if applicable\n\n\n\nproperty lastUpdatedTimestamp None | str\nThe optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.\n\n\n\nproperty numAffectedRows str | OperationTypeClass\nOperation type of change.\n\n\n\nproperty partitionSpec None | str | OperationSourceTypeClass\nSource Type\n\n\n\nproperty timestampMillis object\nThe source of an operation\n\n\nDATAPLATFORM = 'DATAPLATFORM'\n\n\n\nDATAPROCESS = 'DATAPROCESS'\n\n\n\n\nclass datahub.metadata.schemaclasses.OperationTypeClass\nBases DictWrapper\nSchema holder for oracle data definition language that describes an oracle table.\n\nParameters str\nThe native schema in the dataset\u2019s platform. This is a human readable (json blob) table schema.\n\n\n\n\nclass datahub.metadata.schemaclasses.OrcSchemaClass(schema)\nBases\nschema (str)\n\n\n\n\nproperty schema Aspect\nCarries information about where an entity originated from.\n\nParameters None | str\nOnly populated if type is EXTERNAL. The externalType of the entity, such as the name of the identity provider.\n\n\n\nproperty type object\nEnum to define where an entity originated from.\n\n\nEXTERNAL = 'EXTERNAL'\n\n\n\nNATIVE = 'NATIVE'\n\n\n\n\nclass datahub.metadata.schemaclasses.OtherSchemaClass(rawSchema)\nBases\nrawSchema (str)\n\n\n\n\nproperty rawSchema DictWrapper\nOwnership information\n\nParameters str\ncorpuserligroupname, and urnmultiProduct only corpuser is currently supported in the frontend.)\n\nType\nli\n\n\n\n\n\nproperty source str | OwnershipTypeClass\nThe type of the ownership\n\n\n\nproperty typeUrn Aspect\nOwnership information of an entity.\n\nParameters AuditStampClass\nAudit stamp containing who last modified the record and when. A value of 0 in the time field indicates missing data.\n\n\n\nproperty ownerTypes List[OwnerClass]\nList of owners of the entity.\n\n\n\n\nclass datahub.metadata.schemaclasses.OwnershipSourceClass(type, url=None)\nBases\n\ntype (Union[str, OwnershipSourceTypeClass])\nurl (Optional[str])\n\n\n\n\n\nproperty type None | str\nA reference URL for the source\n\n\n\n\nclass datahub.metadata.schemaclasses.OwnershipSourceTypeClass\nBases object\nAsset owner types\n\n\nBUSINESSOWNER = 'BUSINESSOWNER'\n\n\n\nCONSUMER = 'CONSUMER'\n\n\n\nCUSTOM = 'CUSTOM'\n\n\n\nDATAOWNER = 'DATAOWNER'\n\n\n\nDATASTEWARD = 'DATASTEWARD'\n\n\n\nDELEGATE = 'DELEGATE'\n\n\n\nDEVELOPER = 'DEVELOPER'\n\n\n\nNONE = 'NONE'\n\n\n\nPRODUCER = 'PRODUCER'\n\n\n\nSTAKEHOLDER = 'STAKEHOLDER'\n\n\n\nTECHNICALOWNER = 'TECHNICALOWNER'\n\n\n\n\nclass datahub.metadata.schemaclasses.OwnershipTypeInfoClass(name, created, lastModified, description=None)\nBases\n\nname (str)\ncreated (AuditStampClass)\nlastModified (AuditStampClass)\ndescription (Optional[str])\n\n\n\n\n\nproperty created None | str\nDescription of the Ownership Type\n\n\n\nproperty lastModified str\nDisplay name of the Ownership Type\n\n\n\n\nclass datahub.metadata.schemaclasses.OwnershipTypeKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\nArbitrary key-value parameters for an Entity Change Event. (any record).\n\n\n\nclass datahub.metadata.schemaclasses.PartitionSpecClass(partition, timePartition=None, type=None)\nBases\n\npartition (str)\ntimePartition (Optional[TimeWindowClass])\ntype (Union[str, PartitionTypeClass, None])\n\n\n\n\n\nproperty partition None | TimeWindowClass\nTime window of the partition, if we are able to extract it from the partition key.\n\n\n\nproperty type DictWrapper\nDefines how the data is partitioned\n\nParameters None | int\nThe created time for a given partition.\n\n\n\nproperty lastModifiedTime str\nA unique id / value for the partition for which statistics were collected,\ngenerated by applying the key definition to a given row.\n\n\n\n\nclass datahub.metadata.schemaclasses.PartitionTypeClass\nBases Aspect\nDefines how the data is partitioned for Data Lake tables (e.g. Hive, S3, Iceberg, Delta, Hudi, etc).\n\nParameters None | PartitionSummaryClass\nThe maximum partition as ordered\n\n\n\nproperty minPartition DictWrapper\nA DataHub Platform Event.\n\nParameters PlatformEventHeaderClass\nHeader information stored with the event.\n\n\n\nproperty name GenericPayloadClass\nThe event payload.\n\n\n\n\nclass datahub.metadata.schemaclasses.PlatformEventHeaderClass(timestampMillis)\nBases\ntimestampMillis (int)\n\n\n\n\nproperty timestampMillis Aspect\nPlatform Resource Info.\nThese entities are for miscelaneous data that is used in non-core parts of the system.\nFor instance, if we want to persist &amp; retrieve data from auxiliary integrations such as Slack or Microsoft Teams.\n\nParameters str\nThe primary key for this platform resource.\ne.g. for a slack member this would be the memberID.\nprimary keys specified here don\u2019t need to include any additional specificity for the\n\ndataPlatform\n\nThe @PlatformResourceKey is supposed to represent that\n\n\n\nproperty resourceType conversation, user, grant, etc.\nResource types are indexed for ease of access.\ne.g. Get me all platform resources of type user for the platform looker\n\n\n\nproperty secondaryKeys None | SerializedValueClass\nThe serialized value of this platform resource item.\n\n\n\n\nclass datahub.metadata.schemaclasses.PlatformResourceKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty idslack-instanceuser-info\nor guid(slack, slack-instance, slack-user-id, user-info) etc.\n\n\n\n\nclass datahub.metadata.schemaclasses.PlatformTypeClass\nBases object\nThe matching condition in a filter criterion\n\n\nEQUALS = 'EQUALS'\n\n\n\nSTARTSWITH = 'STARTSWITH'\n\n\n\n\nclass datahub.metadata.schemaclasses.PolicyMatchCriterionClass(field, values, condition=None)\nBases\n\nfield (str)\nvalues (List[str])\ncondition (Union[str, PolicyMatchConditionClass, None])\n\n\n\n\n\nproperty condition str\nThe name of the field that the criterion refers to\n\n\n\nproperty values DictWrapper\nThe filter for specifying the resource or actor to apply privileges to\n\nParameters List[PolicyMatchCriterionClass]\nA list of criteria to apply conjunctively (so all criteria must pass)\n\n\n\n\nclass datahub.metadata.schemaclasses.PostContentClass(title, type, description=None, link=None, media=None)\nBases\n\ntitle (str)\ntype (Union[str, PostContentTypeClass])\ndescription (Optional[str])\nlink (Optional[str])\nmedia (Optional[MediaClass])\n\n\n\n\n\nproperty description None | str\nOptional link that the post is associated with.\n\n\n\nproperty media str\nTitle of the post.\n\n\n\nproperty type object\nEnum defining the type of content held in a Post.\n\n\nLINK = 'LINK'\n\n\n\nTEXT = 'TEXT'\n\n\n\n\nclass datahub.metadata.schemaclasses.PostInfoClass(type, content, created, lastModified, auditStamp=None, target=None)\nBases\n\ntype (Union[str, PostTypeClass])\ncontent (PostContentClass)\ncreated (int)\nlastModified (int)\nauditStamp (Optional[AuditStampClass])\ntarget (Optional[str])\n\n\n\n\n\nproperty auditStamp PostContentClass\nContent stored in the post.\n\n\n\nproperty created int\nThe time at which the post was last modified\n\n\n\nproperty target str | PostTypeClass\nType of the Post.\n\n\n\n\nclass datahub.metadata.schemaclasses.PostKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id object\nEnum defining types of Posts.\n\n\nENTITYANNOUNCEMENT = 'ENTITYANNOUNCEMENT'\n\n\n\nHOMEPAGEANNOUNCEMENT = 'HOMEPAGEANNOUNCEMENT'\n\n\n\n\nclass datahub.metadata.schemaclasses.PrestoDDLClass(rawSchema)\nBases\nrawSchema (str)\n\n\n\n\nproperty rawSchema object\n\n\nMULTIPLE = 'MULTIPLE'\n\n\n\nSINGLE = 'SINGLE'\n\n\n\n\nclass datahub.metadata.schemaclasses.PropertyValueClass(value, description=None)\nBases\n\nvalue (Union[str, float])\ndescription (Optional[str])\n\n\n\n\n\nproperty description str | float\n\n\n\n\nclass datahub.metadata.schemaclasses.QuantileClass(quantile, value)\nBases\n\nquantile (str)\nvalue (str)\n\n\n\n\n\nproperty quantile str\n\n\n\n\nclass datahub.metadata.schemaclasses.QuantitativeAnalysesClass(unitaryResults=None, intersectionalResults=None)\nBases\n\nunitaryResults (Optional[str])\nintersectionalResults (Optional[str])\n\n\n\n\n\nproperty intersectionalResults None | str\nLink to a dashboard with results showing how the MLModel performed with respect to each factor\n\n\n\n\nclass datahub.metadata.schemaclasses.QueryCellClass(cellId, changeAuditStamps, rawQuery, cellTitle=None, lastExecuted=None)\nBases\n\ncellId (str)\nchangeAuditStamps (ChangeAuditStampsClass)\nrawQuery (str)\ncellTitle (Optional[str])\nlastExecuted (Optional[AuditStampClass])\n\n\n\n\n\nproperty cellId None | str\nTitle of the cell\n\n\n\nproperty changeAuditStamps None | AuditStampClass\nCaptures information about who last executed this query cell and when\n\n\n\nproperty rawQuery Aspect\nKey for a Query\n\nParameters str\nA unique id for the Query.\n\n\n\n\nclass datahub.metadata.schemaclasses.QueryLanguageClass\nBases Aspect\nInformation about a Query against one or more data assets (e.g. Tables or Views).\n\nParameters AuditStampClass\nAudit stamp capturing the time and actor who created the Query.\n\n\n\nproperty customProperties None | str\nThe Query description.\n\n\n\nproperty lastModified None | str\nOptional display name to identify the query.\n\n\n\nproperty origin str | QuerySourceClass\nThe source of the Query\n\n\n\nproperty statement object\n\n\nMANUAL = 'MANUAL'\n\n\n\nSYSTEM = 'SYSTEM'\n\n\n\n\nclass datahub.metadata.schemaclasses.QueryStatementClass(value, language=None)\nBases\n\nvalue (str)\nlanguage (Union[str, QueryLanguageClass, None])\n\n\n\n\n\nproperty language str\nThe query text\n\n\n\n\nclass datahub.metadata.schemaclasses.QuerySubjectClass(entity)\nBases\nentity (str)\n\n\n\n\nproperty entity Aspect\nInformation about the subjects of a particular Query, i.e. the assets\nbeing queried.\n\nParameters List[QuerySubjectClass]\nOne or more subjects of the query.\nIn single-asset queries (e.g. table select), this will contain the Table reference\nand optionally schema field references.\nIn multi-asset queries (e.g. table joins), this may contain multiple Table references\nand optionally schema field references.\n\n\n\n\nclass datahub.metadata.schemaclasses.QueryUsageStatisticsClass(timestampMillis, eventGranularity=None, partitionSpec=None, messageId=None, queryCount=None, queryCost=None, lastExecutedAt=None, uniqueUserCount=None, userCounts=None)\nBases\n\ntimestampMillis (int)\neventGranularity (Optional[TimeWindowSizeClass])\npartitionSpec (Optional[PartitionSpecClass])\nmessageId (Optional[str])\nqueryCount (Optional[int])\nqueryCost (Optional[float])\nlastExecutedAt (Optional[int])\nuniqueUserCount (Optional[int])\nuserCounts (Optional[List[DatasetUserUsageCountsClass]])\n\n\n\n\n\nASPECTTYPE None | TimeWindowSizeClass\nGranularity of the event if applicable\n\n\n\nproperty lastExecutedAt None | str\nThe optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.\n\n\n\nproperty partitionSpec None | float\nQuery cost for this query and bucket\n\n\n\nproperty queryCount int\nThe event timestamp field as epoch at UTC in milli seconds.\n\n\n\nproperty uniqueUserCount None | List[DatasetUserUsageCountsClass]\nUsers within this bucket, with frequency counts\n\n\n\n\nclass datahub.metadata.schemaclasses.RecordTypeClass\nBases DictWrapper\nIndividual Field Mapping of a relationship- one of several\n\nParameters str\n1\n\nType str\n1\n\nType DictWrapper\nBase class that encapsulates different retention policies.\nOnly one of the fields should be set\n\nParameters None | TimeBasedRetentionClass\n\n\n\nproperty version DictWrapper\nProperties of an applied Role. For now, just an Urn\n\nParameters str\nUrn of the External Role\n\n\n\n\nclass datahub.metadata.schemaclasses.RoleKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nCarries information about which roles a user or group is assigned to.\n\nParameters List[str]\n\n\n\n\nclass datahub.metadata.schemaclasses.RolePropertiesClass(name, type, description=None, requestUrl=None, created=None)\nBases\n\nname (str)\ntype (str)\ndescription (Optional[str])\nrequestUrl (Optional[str])\ncreated (Optional[AuditStampClass])\n\n\n\n\n\nproperty created None | str\nDescription of the IAM Role\n\n\n\nproperty name None | str\nLink to access external access management\n\n\n\nproperty type DictWrapper\nProvisioned users of a role\n\nParameters str\nLink provisioned corp user for a role\n\n\n\n\nclass datahub.metadata.schemaclasses.RowCountChangeClass(type, operator, parameters)\nBases\n\ntype (Union[str, AssertionValueChangeTypeClass])\noperator (Union[str, AssertionStdOperatorClass])\nparameters (AssertionStdParametersClass)\n\n\n\n\n\nproperty operator\nGREATERTHAN, GREATERTHANOREQUALTO, EQUALTO, LESSTHAN, LESSTHANOREQUALTO,\nBETWEEN.\n\n\n\nproperty parameters NUMBER.\n\n\n\nproperty type\nThe type of the value used to evaluate the assertion\n\n\n\n\n\n\nclass datahub.metadata.schemaclasses.RowCountTotalClass(operator, parameters)\nBases\n\noperator (Union[str, AssertionStdOperatorClass])\nparameters (AssertionStdParametersClass)\n\n\n\n\n\nproperty operator\nGREATERTHAN, GREATERTHANOREQUALTO, EQUALTO, LESSTHAN, LESSTHANOREQUALTO,\nBETWEEN.\n\n\n\nproperty parameters NUMBER.\n\n\n\n\nclass datahub.metadata.schemaclasses.RunResultTypeClass\nBases object\n\n\nEXACTMATCH = 'EXACTMATCH'\n\n\n\nSUBSET = 'SUBSET'\n\n\n\nSUPERSET = 'SUPERSET'\n\n\n\n\nclass datahub.metadata.schemaclasses.SchemaAssertionInfoClass(entity, schema, compatibility=None)\nBases\n\nentity (str)\nschema (SchemaMetadataClass)\ncompatibility (Union[str, SchemaAssertionCompatibilityClass, None])\n\n\n\n\n\nproperty compatibility str\nThe entity targeted by the assertion\n\n\n\nproperty schema DictWrapper\nExpectations for a logical schema\n\nParameters str\nThe assertion representing the schema contract.\n\n\n\n\nclass datahub.metadata.schemaclasses.SchemaFieldAliasesClass(aliases=None)\nBases\naliases (Optional[List[str]])\n\n\n\n\nproperty aliases DictWrapper\nSchemaField to describe metadata related to dataset schema.\n\nParameters None | AuditStampClass\nAn AuditStamp corresponding to the creation of this schema field.\n\n\n\nproperty description str\nFlattened name of the field. Field is computed from jsonPath field.\n\n\n\nproperty globalTags None | GlossaryTermsClass\nGlossary terms associated with the field\n\n\n\nproperty isPartOfKey None | bool\nFor Datasets which are partitioned, this determines the partitioning key.\nNote that multiple columns can be part of a partitioning key, but currently we do not support\nrendering the ordered partitioning key.\n\n\n\nproperty jsonPath None | str\nFor schema fields that have other properties that are not modeled explicitly,\nuse this field to serialize those properties into a JSON string\n\n\n\nproperty label None | AuditStampClass\nAn AuditStamp corresponding to the last modification of this schema field.\n\n\n\nproperty nativeDataType bool\nIndicates if this field is optional or nullable\n\n\n\nproperty recursive SchemaFieldDataTypeClass\nPlatform independent field type of the field.\n\n\n\n\nclass datahub.metadata.schemaclasses.SchemaFieldDataTypeClass(type)\nBases\ntype (Union[BooleanTypeClass, FixedTypeClass, StringTypeClass, BytesTypeClass, NumberTypeClass, DateTypeClass, TimeTypeClass, EnumTypeClass, NullTypeClass, MapTypeClass, ArrayTypeClass, UnionTypeClass, RecordTypeClass])\n\n\n\n\nproperty type Aspect\n\nParameters None | str\n\n\n\nproperty schemaFieldAliases Aspect\nKey for a SchemaField\n\nParameters str\nfieldPath identifying the schema field\n\n\n\nproperty parent DictWrapper\nA metadata snapshot for a specific schema field entity.\n\nParameters List[SchemaFieldKeyClass]\nThe list of metadata aspects associated with the dataset. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn DictWrapper\nLightweight spec used for referencing a particular schema field.\n\nParameters str\nThe native field type\n\n\n\nproperty path str\nThe DataHub standard schema field type.\n\n\n\n\nclass datahub.metadata.schemaclasses.SchemaMetadataClass(schemaName, platform, version, hash, platformSchema, fields, created=None, lastModified=None, deleted=None, dataset=None, cluster=None, primaryKeys=None, foreignKeysSpecs=None, foreignKeys=None)\nBases\n\nschemaName (str)\nplatform (str)\nversion (int)\nhash (str)\nplatformSchema (Union[EspressoSchemaClass, OracleDDLClass, MySqlDDLClass, PrestoDDLClass, KafkaSchemaClass, BinaryJsonSchemaClass, OrcSchemaClass, SchemalessClass, KeyValueSchemaClass, OtherSchemaClass])\nfields (List[SchemaFieldClass])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ndataset (Optional[str])\ncluster (Optional[str])\nprimaryKeys (Optional[List[str]])\nforeignKeysSpecs (Optional[Dict[str, ForeignKeySpecClass]])\nforeignKeys (Optional[List[ForeignKeyConstraintClass]])\n\n\n\n\n\nproperty cluster AuditStampClass\nAn AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.\n\n\n\nproperty dataset None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty fields None | List[ForeignKeyConstraintClass]\nList of foreign key constraints for the schema\n\n\n\nproperty foreignKeysSpecs str\nthe SHA1 hash of the schema content\n\n\n\nproperty lastModified str\nplatform\nStandardized platform urn where schema is defined. The data platform Urn (urn\n\nType EspressoSchemaClass | OracleDDLClass | MySqlDDLClass | PrestoDDLClass | KafkaSchemaClass | BinaryJsonSchemaClass | OrcSchemaClass | SchemalessClass | KeyValueSchemaClass | OtherSchemaClass\nThe native schema in the dataset\u2019s platform.\n\n\n\nproperty primaryKeys str\nSchema name e.g. PageViewEvent, identity.Profile, ams.accountmanagementtracking\n\n\n\nproperty version DictWrapper\nThe dataset has no specific schema associated with it\n\n\n\nclass datahub.metadata.schemaclasses.SearchFieldTypeClass\nBases DictWrapper\nCaptures the serialized value of a (usually) schema-d blob.\n\nParameters bytes\nThe serialized blob value.\n\n\n\nproperty contentType None | str\nAn optional reference to the schema that models the object.\ne.g., \u2018com.linkedin.pegasus2avro.platformresource.slack.SlackConversation\u2019\n\n\n\nproperty schemaType object\n\n\nBINARY = 'BINARY'\n\n\n\nJSON = 'JSON'\n\n\n\n\nclass datahub.metadata.schemaclasses.SerializedValueSchemaTypeClass\nBases Aspect\nSiblings information of an entity.\n\nParameters bool\nIf this is the leader entity of the set of siblings\n\n\n\nproperty siblings DictWrapper\nSlack Notification settings for an actor.\n\nParameters None | List[str]\nOptional list of channels to send notifications to\n\n\n\nproperty userHandle Aspect\nInformation about a Slack user.\n\nParameters str\nThe display name of the Slack member.\n\n\n\nproperty email str\nThe unique identifier for the Slack member.\n\n\n\nproperty isAdmin bool\nWhether the member is a bot.\n\n\n\nproperty isDeleted bool\nWhether the member is an owner.\n\n\n\nproperty isPrimaryOwner None | int\nThe timestamp of when the member was last updated. (in seconds)\n\n\n\nproperty name None | str\nThe phone number of the Slack member.\n\n\n\nproperty profilePictureUrl str\nThe real name of the Slack member.\n\n\n\nproperty slackInstance None | str\nThe status emoji of the Slack member.\n\n\n\nproperty statusText str\nThe ID associated with the Slack team.\n\n\n\nproperty timezone None | int\nThe timezone offset of the Slack member.\n\n\n\nproperty title Aspect\nSource Code\n\nParameters List[SourceCodeUrlClass]\nSource Code along with types\n\n\n\n\nclass datahub.metadata.schemaclasses.SourceCodeUrlClass(type, sourceCodeUrl)\nBases\n\ntype (Union[str, SourceCodeUrlTypeClass])\nsourceCodeUrl (str)\n\n\n\n\n\nproperty sourceCodeUrl str | SourceCodeUrlTypeClass\nSource Code Url Types\n\n\n\n\nclass datahub.metadata.schemaclasses.SourceCodeUrlTypeClass\nBases DictWrapper\nAttributes defining a SQL Assertion\n\nParameters None | str | AssertionValueChangeTypeClass\na fixed absolute value or a relative percentage.\nThis value is required if the type is METRICCHANGE.\n\nType str\nThe entity targeted by this SQL check.\n\n\n\nproperty operator\nGREATERTHAN, GREATERTHANOREQUALTO, EQUALTO, LESSTHAN, LESSTHANOREQUALTO,\nBETWEEN.\n\n\n\nproperty parameters NUMBER.\n\n\n\nproperty statement str | SqlAssertionTypeClass\nThe type of the SQL assertion being monitored.\n\n\n\n\nclass datahub.metadata.schemaclasses.SqlAssertionTypeClass\nBases DictWrapper\nSSO Integrations, supported on the UI.\n\nParameters str\nAuth base URL.\n\n\n\nproperty oidcSettings Aspect\nThe lifecycle status metadata of an entity, e.g. dataset, metric, feature, etc.\nThis aspect is used to represent soft deletes conventionally.\n\nParameters bool\nWhether the entity has been removed (soft-deleted).\n\n\n\n\nclass datahub.metadata.schemaclasses.StringTypeClass\nBases DictWrapper\nA flexible carrier for structured results of an execution request.\nThe goal is to allow for free flow of structured responses from execution tasks to the orchestrator or observer.\nThe full spectrum of different execution report types is not intended to be modeled by this object.\n\nParameters str\nThe content-type of the serialized value (e.g. application/json, application/json;gzip etc.)\n\n\n\nproperty serializedValue str\nThe type of the structured report. (e.g. INGESTIONREPORT, TESTCONNECTIONREPORT, etc.)\n\n\n\n\nclass datahub.metadata.schemaclasses.StructuredPropertiesClass(properties)\nBases\nproperties (List[StructuredPropertyValueAssignmentClass])\n\n\n\n\nproperty properties Aspect\n\nParameters None | List[PropertyValueClass]\nA list of allowed values that the property is allowed to take.\nIf this is not specified, then the property can take any value of given type.\n\n\n\nproperty cardinality None | AuditStampClass\nCreated Audit stamp\n\n\n\nproperty description None | str\nThe display name of the property. This is the name that will be shown in the UI and can be used to look up the property id.\n\n\n\nproperty entityTypes bool\nWhether the structured property value is immutable once applied to an entity.\n\n\n\nproperty lastModified str\nThe fully qualified name of the property. e.g. io.acryl.datahub.myProperty\n\n\n\nproperty searchConfiguration None | Dict[str, List[str]]\nA map that allows for type specialization of the valueType.\ne.g. a valueType of urndataType [\u201durnentityTypelidatahub.corpGroup\u201d] }\n\n\n\nproperty valueTypelidatahub.date\n\n\n\nproperty version v1, v2\n\n20240610, 20240611\n\n\n\n\n\nclass datahub.metadata.schemaclasses.StructuredPropertyKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\n\nParameters str\nThe structured property that is required on this entity\n\n\n\n\nclass datahub.metadata.schemaclasses.StructuredPropertySettingsClass(isHidden=None, showInSearchFilters=None, showInAssetSummary=None, showAsAssetBadge=None, showInColumnsTable=None, lastModified=None)\nBases\n\nisHidden (Optional[bool])\nshowInSearchFilters (Optional[bool])\nshowInAssetSummary (Optional[bool])\nshowAsAssetBadge (Optional[bool])\nshowInColumnsTable (Optional[bool])\nlastModified (Optional[AuditStampClass])\n\n\n\n\n\nproperty isHidden None | AuditStampClass\nLast Modified Audit stamp\n\n\n\nproperty showAsAssetBadge bool\nWhether or not this asset should be displayed in the asset sidebar\n\n\n\nproperty showInColumnsTable bool\nWhether or not this asset should be displayed as a search filter\n\n\n\n\nclass datahub.metadata.schemaclasses.StructuredPropertyValueAssignmentClass(propertyUrn, values, created=None, lastModified=None)\nBases\n\npropertyUrn (str)\nvalues (List[Union[str, float]])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\n\n\n\n\n\nproperty created None | AuditStampClass\nAudit stamp containing who last modified this relationship edge and when\n\n\n\nproperty propertyUrn List[str | float]\nThe value assigned to the property.\n\n\n\n\nclass datahub.metadata.schemaclasses.SubTypesClass(typeNames)\nBases\ntypeNames (List[str])\n\n\n\n\nproperty typeNames Aspect\nMetadata associated with each metadata change that is processed by the system\n\nParameters int | None\nThe timestamp the metadata was observed at\n\n\n\nproperty lastRunId None | str\nThe ingestion pipeline id that produced the metadata. Populated in case of batch ingestion.\n\n\n\nproperty properties None | str\nThe model registry name that was used to process this event\n\n\n\nproperty registryVersion str | None\nThe original run id that produced the metadata. Populated in case of batch-ingestion.\n\n\n\nproperty version DictWrapper\nProperties of an applied tag. For now, just an Urn. In the future we can extend this with other properties, e.g.\npropagation parameters.\n\nParameters None | MetadataAttributionClass\nInformation about who, why, and how this metadata was applied\n\n\n\nproperty context str\nUrn of the applied tag\n\n\n\n\nclass datahub.metadata.schemaclasses.TagKeyClass(name)\nBases\nname (str)\n\n\n\n\nproperty name Aspect\nProperties associated with a Tag\n\nParameters None | str\nThe color associated with the Tag in Hex. For example #FFFFFF.\n\n\n\nproperty description str\nDisplay name of the tag\n\n\n\n\nclass datahub.metadata.schemaclasses.TagSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[TagKeyClass, OwnershipClass, TagPropertiesClass, StatusClass]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.TelemetryClientIdClass(clientId)\nBases\nclientId (str)\n\n\n\n\nproperty clientId Aspect\nKey for the telemetry client ID, only one should ever exist\n\nParameters str\nThe telemetry entity name, which serves as a unique id\n\n\n\n\nclass datahub.metadata.schemaclasses.TestDefinitionClass(type, json=None)\nBases\n\ntype (Union[str, TestDefinitionTypeClass])\njson (Optional[str])\n\n\n\n\n\nproperty json str | TestDefinitionTypeClass\nThe Test Definition Type\n\n\n\n\nclass datahub.metadata.schemaclasses.TestDefinitionTypeClass\nBases Aspect\nInformation about a DataHub Test\n\nParameters str\nCategory of the test\n\n\n\nproperty definition None | str\nDescription of the test\n\n\n\nproperty name Aspect\nKey for a Test\n\nParameters str\nUnique id for the test\n\n\n\n\nclass datahub.metadata.schemaclasses.TestResultClass(test, type, testDefinitionMd5=None, lastComputed=None)\nBases\n\ntest (str)\ntype (Union[str, TestResultTypeClass])\ntestDefinitionMd5 (Optional[str])\nlastComputed (Optional[AuditStampClass])\n\n\n\n\n\nproperty lastComputed str\nThe urn of the test\n\n\n\nproperty testDefinitionMd5 str | TestResultTypeClass\nThe type of the result\n\n\n\n\nclass datahub.metadata.schemaclasses.TestResultTypeClass\nBases Aspect\nInformation about a Test Result\n\nParameters List[TestResultClass]\nResults that are failing\n\n\n\nproperty passing DictWrapper\nText cell in a Notebook, which will present content in text format\n\nParameters str\nUnique id for the cell. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as \u2018querybook.com/notebook/773/?cellId=1234\u2019\n\n\n\nproperty cellTitle ChangeAuditStampsClass\nCaptures information about who created/last modified/deleted this Notebook cell and when\n\n\n\nproperty text DictWrapper\nKeep records that are less than X seconds old\n\nParameters int\n\n\n\n\nclass datahub.metadata.schemaclasses.TimeStampClass(time, actor=None)\nBases\n\ntime (int)\nactor (Optional[str])\n\n\n\n\n\nproperty actor\nOptional\n\n\n\n\n\nproperty time DictWrapper\nTime field type. This should also be used for datetimes.\n\n\n\nclass datahub.metadata.schemaclasses.TimeWindowClass(startTimeMillis, length)\nBases\n\nstartTimeMillis (int)\nlength (TimeWindowSizeClass)\n\n\n\n\n\nproperty length int\nStart time as epoch at UTC.\n\n\n\n\nclass datahub.metadata.schemaclasses.TimeWindowSizeClass(unit, multiple=None)\nBases\n\nunit (Union[str, CalendarIntervalClass])\nmultiple (Optional[int])\n\n\n\n\n\nproperty multiple str | CalendarIntervalClass\nInterval unit such as minute/hour/day etc.\n\n\n\n\nclass datahub.metadata.schemaclasses.TrainingDataClass(trainingData)\nBases\ntrainingData (List[BaseDataClass])\n\n\n\n\nproperty trainingData object\nType of the transformation involved in generating destination fields from source fields.\n\n\nBLACKBOX = 'BLACKBOX'\n\n\n\nIDENTITY = 'IDENTITY'\n\n\n\n\nclass datahub.metadata.schemaclasses.UDFTransformerClass(udf)\nBases\nudf (str)\n\n\n\n\nproperty udf DictWrapper\nUnion field type.\n\nParameters None | List[str]\nList of types in union type.\n\n\n\n\nclass datahub.metadata.schemaclasses.UpstreamClass(dataset, type, auditStamp=None, created=None, properties=None, query=None)\nBases\n\ndataset (str)\ntype (Union[str, DatasetLineageTypeClass])\nauditStamp (Optional[AuditStampClass])\ncreated (Optional[AuditStampClass])\nproperties (Optional[Dict[str, str]])\nquery (Optional[str])\n\n\n\n\n\nproperty auditStamp None | AuditStampClass\nAudit stamp containing who created the lineage and when.\n\n\n\nproperty dataset None | Dict[str, str]\nA generic properties bag that allows us to store specific information on this graph edge.\n\n\n\nproperty query str | DatasetLineageTypeClass\nThe type of the lineage\n\n\n\n\nclass datahub.metadata.schemaclasses.UpstreamLineageClass(upstreams, fineGrainedLineages=None)\nBases\n\nupstreams (List[UpstreamClass])\nfineGrainedLineages (Optional[List[FineGrainedLineageClass]])\n\n\n\n\n\nproperty fineGrainedLineages List[UpstreamClass]\nList of upstream dataset lineage information\n\n\n\n\nclass datahub.metadata.schemaclasses.UrnForeignKeyClass(currentFieldPath)\nBases\ncurrentFieldPath (str)\n\n\n\n\nproperty currentFieldPath DictWrapper\nUsage data for a given resource, rolled up into a bucket.\n\nParameters int\nBucket start time in milliseconds\n\n\n\nproperty duration UsageAggregationMetricsClass\nMetrics associated with this bucket\n\n\n\nproperty resource DictWrapper\nMetrics for usage data for a given resource and bucket. Not all fields\nmake sense for all buckets, so every field is optional.\n\nParameters None | List[FieldUsageCountsClass]\nField-level usage stats\n\n\n\nproperty topSqlQueries None | int\nTotal SQL query count\n\n\n\nproperty uniqueUserCount None | List[UserUsageCountsClass]\nUsers within this bucket, with frequency counts\n\n\n\n\nclass datahub.metadata.schemaclasses.UserUsageCountsClass(count, user=None, userEmail=None)\nBases\n\ncount (int)\nuser (Optional[str])\nuserEmail (Optional[str])\n\n\n\n\n\nproperty count None | str\n\n\n\nproperty userEmail DictWrapper\n\nParameters int\n\n\n\nproperty value DictWrapper\nKeep max N latest records\n\nParameters int\n\n\n\n\nclass datahub.metadata.schemaclasses.VersionInfoClass(version, versionType, customProperties=None, externalUrl=None)\nBases\n\nversion (str)\nversionType (str)\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\n\n\n\n\n\nproperty customProperties None | str\nURL where the reference exist\n\n\n\nproperty version str\nThe type of the version like git hash or md5 hash\n\n\n\n\nclass datahub.metadata.schemaclasses.VersionPropertiesClass(versionSet, version, sortId, aliases=None, comment=None, versioningScheme=None, sourceCreatedTimestamp=None, metadataCreatedTimestamp=None, isLatest=None)\nBases\n\nversionSet (str)\nversion (VersionTagClass)\nsortId (str)\naliases (Optional[List[VersionTagClass]])\ncomment (Optional[str])\nversioningScheme (Union[str, VersioningSchemeClass, None])\nsourceCreatedTimestamp (Optional[AuditStampClass])\nmetadataCreatedTimestamp (Optional[AuditStampClass])\nisLatest (Optional[bool])\n\n\n\n\n\nproperty aliases None | str\nComment documenting what this version was created for, changes, or represents\n\n\n\nproperty isLatest None | AuditStampClass\nTimestamp reflecting when the metadata for this version was created in DataHub\n\n\n\nproperty sortId None | AuditStampClass\nTimestamp reflecting when this asset version was created in the source system.\n\n\n\nproperty version str\nThe linked Version Set entity that ties multiple versioned assets together\n\n\n\nproperty versioningScheme Aspect\nKey for a Version Set entity\n\nParameters str\nType of entities included in version set, limits to a single entity type between linked versioned entities\n\n\n\nproperty id Aspect\n\nParameters Dict[str, str]\nCustom property bag.\n\n\n\nproperty latest str | VersioningSchemeClass\nWhat versioning scheme is being utilized for the versioned entities sort criterion. Static once set\n\n\n\n\nclass datahub.metadata.schemaclasses.VersionTagClass(versionTag=None, metadataAttribution=None)\nBases\n\nversionTag (Optional[str])\nmetadataAttribution (Optional[MetadataAttributionClass])\n\n\n\n\n\nproperty metadataAttribution None | str\n\n\n\n\nclass datahub.metadata.schemaclasses.VersioningSchemeClass\nBases Aspect\nDetails about a View.\ne.g. Gets activated when subTypes is view\n\nParameters None | str\nThe formatted view logic. This is particularly used for SQL sources, where the SQL\nlogic is formatted for better readability, and with dbt, where this contains the\ncompiled SQL logic.\n\n\n\nproperty materialized str\nThe view logic language / dialect\n\n\n\nproperty viewLogic DictWrapper\nAttributes defining a dataset Volume Assertion\n\nParameters str\nThe entity targeted by this Volume check.\n\n\n\nproperty filter None | IncrementingSegmentRowCountChangeClass\nProduce FAILURE Assertion Result if the asset\u2019s incrementing segment row count delta\ndoes not meet specific requirements. Required if type is \u2018INCREMENTINGSEGMENTROWCOUNTCHANGE\u2019\n\n\n\nproperty incrementingSegmentRowCountTotal None | RowCountChangeClass\nProduce FAILURE Assertion Result if the delta row count of the asset does not meet specific requirements\nwithin a given period of time.\nRequired if type is \u2018ROWCOUNTCHANGE\u2019\n\n\n\nproperty rowCountTotal str | VolumeAssertionTypeClass\nThe type of the volume assertion being monitored.\n\n\n\n\nclass datahub.metadata.schemaclasses.VolumeAssertionTypeClass\nBases object\nEnum to define the length of a bucket when doing aggregations\n\n\nDAY = 'DAY'\n\n\n\nHOUR = 'HOUR'\n\n\n\nMONTH = 'MONTH'\n\n\n\nWEEK = 'WEEK'\n\n\n\nYEAR = 'YEAR'\n\n\n\n\ndatahub.metadata.schemaclasses.getschematype(fullname)\n\nParameters\nRecordSchema\n\n\n\n\n"}}>"><meta data-rh="true" property="og:description" content="\n\n\n\n\nclass datahub.metadata.schemaclasses.AccessClass(roles=None)\nBases\nroles (Optional[List[RoleAssociationClass]])\n\n\n\n\nproperty roles object\nThe various access levels\n\n\nPRIVATE = 'PRIVATE'\n\n\n\nPUBLIC = 'PUBLIC'\n\n\n\n\nclass datahub.metadata.schemaclasses.ActorsClass(users=None)\nBases\nusers (Optional[List[RoleUserClass]])\n\n\n\n\nproperty users DictWrapper\nArray field type.\n\nParameters None | List[str]\nList of types this array holds.\n\n\n\n\nclass datahub.metadata.schemaclasses.AspectBag\nBases AccessClass\n\n\n\nactors AssertionActionsClass\n\n\n\nassertionInfo AssertionKeyClass\n\n\n\nassertionRunEvent BrowsePathsClass\n\n\n\nbrowsePathsV2 BusinessAttributeInfoClass\n\n\n\nbusinessAttributeKey BusinessAttributesClass\n\n\n\nchartInfo ChartKeyClass\n\n\n\nchartQuery ChartUsageStatisticsClass\n\n\n\ncontainer ContainerKeyClass\n\n\n\ncontainerProperties CorpGroupEditableInfoClass\n\n\n\ncorpGroupInfo CorpGroupKeyClass\n\n\n\ncorpUserCredentials CorpUserEditableInfoClass\n\n\n\ncorpUserInfo CorpUserKeyClass\n\n\n\ncorpUserSettings CorpUserStatusClass\n\n\n\ncost DashboardInfoClass\n\n\n\ndashboardKey DashboardUsageStatisticsClass\n\n\n\ndataContractKey DataContractPropertiesClass\n\n\n\ndataContractStatus DataFlowInfoClass\n\n\n\ndataFlowKey DataHubAccessTokenInfoClass\n\n\n\ndataHubAccessTokenKey DataHubActionKeyClass\n\n\n\ndataHubConnectionDetails DataHubConnectionKeyClass\n\n\n\ndataHubExecutionRequestInput ExecutionRequestKeyClass\n\n\n\ndataHubExecutionRequestResult ExecutionRequestSignalClass\n\n\n\ndataHubIngestionSourceInfo DataHubIngestionSourceKeyClass\n\n\n\ndataHubOpenAPISchemaKey DataHubPersonaInfoClass\n\n\n\ndataHubPersonaKey DataHubPolicyInfoClass\n\n\n\ndataHubPolicyKey DataHubRetentionConfigClass\n\n\n\ndataHubRetentionKey DataHubRoleInfoClass\n\n\n\ndataHubRoleKey DataHubSecretKeyClass\n\n\n\ndataHubSecretValue DataHubStepStateKeyClass\n\n\n\ndataHubStepStateProperties DataHubUpgradeKeyClass\n\n\n\ndataHubUpgradeRequest DataHubUpgradeResultClass\n\n\n\ndataHubViewInfo DataHubViewKeyClass\n\n\n\ndataJobInfo DataJobInputOutputClass\n\n\n\ndataJobKey DataPlatformInfoClass\n\n\n\ndataPlatformInstance DataPlatformInstanceKeyClass\n\n\n\ndataPlatformInstanceProperties DataPlatformKeyClass\n\n\n\ndataProcessInfo DataProcessInstanceInputClass\n\n\n\ndataProcessInstanceKey DataProcessInstanceOutputClass\n\n\n\ndataProcessInstanceProperties DataProcessInstanceRelationshipsClass\n\n\n\ndataProcessInstanceRunEvent DataProcessKeyClass\n\n\n\ndataProductKey DataProductPropertiesClass\n\n\n\ndataTransformLogic DataTypeInfoClass\n\n\n\ndataTypeKey DatahubIngestionCheckpointClass\n\n\n\ndatahubIngestionRunSummary DatasetDeprecationClass\n\n\n\ndatasetKey DatasetProfileClass\n\n\n\ndatasetProperties DatasetUpstreamLineageClass\n\n\n\ndatasetUsageStatistics DeprecationClass\n\n\n\ndisplayProperties DocumentationClass\n\n\n\ndomainKey DomainPropertiesClass\n\n\n\ndomains DynamicFormAssignmentClass\n\n\n\neditableChartProperties EditableContainerPropertiesClass\n\n\n\neditableDashboardProperties EditableDataFlowPropertiesClass\n\n\n\neditableDataJobProperties EditableDatasetPropertiesClass\n\n\n\neditableERModelRelationshipProperties EditableMLFeaturePropertiesClass\n\n\n\neditableMlFeatureTableProperties EditableMLModelGroupPropertiesClass\n\n\n\neditableMlModelProperties EditableMLPrimaryKeyPropertiesClass\n\n\n\neditableNotebookProperties EditableSchemaMetadataClass\n\n\n\nembed EntityTypeInfoClass\n\n\n\nentityTypeKey ERModelRelationshipKeyClass\n\n\n\nerModelRelationshipProperties FormInfoClass\n\n\n\nformKey FormsClass\n\n\n\nglobalSettingsInfo GlobalSettingsKeyClass\n\n\n\nglobalTags GlossaryNodeInfoClass\n\n\n\nglossaryNodeKey GlossaryRelatedTermsClass\n\n\n\nglossaryTermInfo GlossaryTermKeyClass\n\n\n\nglossaryTerms GroupMembershipClass\n\n\n\nicebergCatalogInfo IcebergWarehouseInfoClass\n\n\n\nincidentInfo IncidentKeyClass\n\n\n\nincidentSource IncidentsSummaryClass\n\n\n\ninputFields InstitutionalMemoryClass\n\n\n\nintendedUse InviteTokenClass\n\n\n\ninviteTokenKey MLFeatureKeyClass\n\n\n\nmlFeatureProperties MLFeatureTableKeyClass\n\n\n\nmlFeatureTableProperties MLHyperParamClass\n\n\n\nmlMetric CaveatsAndRecommendationsClass\n\n\n\nmlModelDeploymentKey MLModelDeploymentPropertiesClass\n\n\n\nmlModelEthicalConsiderations EvaluationDataClass\n\n\n\nmlModelFactorPrompts MLModelGroupKeyClass\n\n\n\nmlModelGroupProperties MLModelKeyClass\n\n\n\nmlModelMetrics MLModelPropertiesClass\n\n\n\nmlModelQuantitativeAnalyses TrainingDataClass\n\n\n\nmlPrimaryKeyKey MLPrimaryKeyPropertiesClass\n\n\n\nmlTrainingRunProperties NativeGroupMembershipClass\n\n\n\nnotebookContent NotebookInfoClass\n\n\n\nnotebookKey OperationClass\n\n\n\norigin OwnershipClass\n\n\n\nownershipTypeInfo OwnershipTypeKeyClass\n\n\n\npartitionsSummary PlatformResourceInfoClass\n\n\n\nplatformResourceKey PostInfoClass\n\n\n\npostKey StructuredPropertyDefinitionClass\n\n\n\nqueryKey QueryPropertiesClass\n\n\n\nquerySubjects QueryUsageStatisticsClass\n\n\n\nroleKey RoleMembershipClass\n\n\n\nroleProperties SchemaFieldAliasesClass\n\n\n\nschemaFieldKey SchemaMetadataClass\n\n\n\nschemafieldInfo SiblingsClass\n\n\n\nslackUserInfo SourceCodeClass\n\n\n\nstatus StructuredPropertiesClass\n\n\n\nstructuredPropertyKey StructuredPropertySettingsClass\n\n\n\nsubTypes SystemMetadataClass\n\n\n\ntagKey TagPropertiesClass\n\n\n\ntelemetryClientId TelemetryKeyClass\n\n\n\ntestInfo TestKeyClass\n\n\n\ntestResults UpstreamLineageClass\n\n\n\nversionInfo VersionPropertiesClass\n\n\n\nversionSetKey VersionSetPropertiesClass\n\n\n\nviewProperties DictWrapper\nThe Actions about an Assertion.\nIn the future, we\u2019ll likely extend this model to support additional\nparameters or options related to the assertion actions.\n\nParameters str | AssertionActionTypeClass\nThe type of the Action\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionActionTypeClass\nBases Aspect\nThe Actions about an Assertion\n\nParameters List[AssertionActionClass]\nActions to be executed on failed assertion run.\n\n\n\nproperty onSuccess Aspect\nInformation about an assertion\n\nParameters None | CustomAssertionInfoClass\nA Custom Assertion definition. This field is populated when type is CUSTOM.\n\n\n\nproperty customProperties None | DatasetAssertionInfoClass\nA Dataset Assertion definition. This field is populated when the type is DATASET.\n\n\n\nproperty description None | str\nURL where the reference exist\n\n\n\nproperty fieldAssertion None | FreshnessAssertionInfoClass\nAn Freshness Assertion definition. This field is populated when the type is FRESHNESS.\n\n\n\nproperty lastUpdated None | SchemaAssertionInfoClass\nAn schema Assertion definition. This field is populated when the type is DATASCHEMA\n\n\n\nproperty source None | SqlAssertionInfoClass\nA SQL Assertion definition. This field is populated when the type is SQL.\n\n\n\nproperty type None | VolumeAssertionInfoClass\nAn Volume Assertion definition. This field is populated when the type is VOLUME.\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionKeyClass(assertionId)\nBases\nassertionId (str)\n\n\n\n\nproperty assertionId DictWrapper\nThe result of running an assertion\n\nParameters None | float\nObserved aggregate value for evaluated batch\n\n\n\nproperty error None | str\nExternal URL where full results are available. Only present when assertion source is not native.\n\n\n\nproperty missingCount None | Dict[str, str]\nOther results of evaluation\n\n\n\nproperty rowCount str | AssertionResultTypeClass\nThe final result, e.g. either SUCCESS, FAILURE, or ERROR.\n\n\n\nproperty unexpectedCount DictWrapper\nAn error encountered when evaluating an AssertionResult\n\nParameters None | Dict[str, str]\nAdditional metadata depending on the type of error\n\n\n\nproperty type object\n\n\nCUSTOMSQLERROR = 'CUSTOMSQLERROR'\n\n\n\nFIELDASSERTIONERROR = 'FIELDASSERTIONERROR'\n\n\n\nINSUFFICIENTDATA = 'INSUFFICIENTDATA'\n\n\n\nINVALIDPARAMETERS = 'INVALIDPARAMETERS'\n\n\n\nINVALIDSOURCETYPE = 'INVALIDSOURCETYPE'\n\n\n\nSOURCECONNECTIONERROR = 'SOURCECONNECTIONERROR'\n\n\n\nSOURCEQUERYFAILED = 'SOURCEQUERYFAILED'\n\n\n\nUNKNOWNERROR = 'UNKNOWNERROR'\n\n\n\nUNSUPPORTEDPLATFORM = 'UNSUPPORTEDPLATFORM'\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionResultTypeClass\nBases Aspect\nAn event representing the current status of evaluating an assertion on a batch.\nAssertionRunEvent should be used for reporting the status of a run as an assertion evaluation progresses.\n\nParameters ClassVar[str] = 'timeseries'\n\n\n\nproperty asserteeUrn str\n\n\n\nproperty batchSpec None | TimeWindowSizeClass\nGranularity of the event if applicable\n\n\n\nproperty messageId PartitionSpecClass | None\nThe optional partition specification.\n\n\n\nproperty result str\nNative (platform-specific) identifier for this run\n\n\n\nproperty runtimeContext str | AssertionRunStatusClass\nThe status of the assertion run as per this timeseries event.\n\n\n\nproperty timestampMillis object\nThe lifecycle status of an assertion run.\n\n\nCOMPLETE = 'COMPLETE'\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionSourceClass(type, created=None)\nBases\n\ntype (Union[str, AssertionSourceTypeClass])\ncreated (Optional[AuditStampClass])\n\n\n\n\n\nproperty created str | AssertionSourceTypeClass\nThe type of the Assertion Source\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionSourceTypeClass\nBases object\nThe function that is applied to the aggregation input (schema, rows, column values) before evaluating an operator.\n\n\nCOLUMNS = 'COLUMNS'\n\n\n\nCOLUMNCOUNT = 'COLUMNCOUNT'\n\n\n\nIDENTITY = 'IDENTITY'\n\n\n\nMAX = 'MAX'\n\n\n\nMEAN = 'MEAN'\n\n\n\nMEDIAN = 'MEDIAN'\n\n\n\nMIN = 'MIN'\n\n\n\nNULLCOUNT = 'NULLCOUNT'\n\n\n\nNULLPROPORTION = 'NULLPROPORTION'\n\n\n\nROWCOUNT = 'ROWCOUNT'\n\n\n\nSTDDEV = 'STDDEV'\n\n\n\nSUM = 'SUM'\n\n\n\nUNIQUECOUNT = 'UNIQUECOUNT'\n\n\n\nUNIQUEPROPORTION = 'UNIQUEPROPORTION'\n\n\n\nUNIQUEPROPOTION = 'UNIQUEPROPOTION'\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionStdOperatorClass\nBases DictWrapper\nSingle parameter for AssertionStdOperators.\n\nParameters str | AssertionStdParameterTypeClass\nThe type of the parameter\n\n\n\nproperty value object\n\n\nLIST = 'LIST'\n\n\n\nNUMBER = 'NUMBER'\n\n\n\nSET = 'SET'\n\n\n\nSTRING = 'STRING'\n\n\n\nUNKNOWN = 'UNKNOWN'\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionStdParametersClass(value=None, maxValue=None, minValue=None)\nBases\n\nvalue (Optional[AssertionStdParameterClass])\nmaxValue (Optional[AssertionStdParameterClass])\nminValue (Optional[AssertionStdParameterClass])\n\n\n\n\n\nproperty maxValue None | AssertionStdParameterClass\nThe minValue parameter of an assertion\n\n\n\nproperty value object\n\n\nCUSTOM = 'CUSTOM'\n\n\n\nDATASET = 'DATASET'\n\n\n\nDATASCHEMA = 'DATASCHEMA'\n\n\n\nFIELD = 'FIELD'\n\n\n\nFRESHNESS = 'FRESHNESS'\n\n\n\nSQL = 'SQL'\n\n\n\nVOLUME = 'VOLUME'\n\n\n\n\nclass datahub.metadata.schemaclasses.AssertionValueChangeTypeClass\nBases DictWrapper\nData captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage.\n\nParameters str\nThe entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change.\n\n\n\nproperty impersonator None | str\nwas the change created by an automated process, or manually.\n\nType int\nWhen did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent.\n\n\n\n\nclass datahub.metadata.schemaclasses.AzkabanJobTypeClass\nBases DictWrapper\nBaseData record\n\nParameters str\nWhat dataset were used in the MLModel?\n\n\n\nproperty motivation None | List[str]\nHow was the data preprocessed (e.g., tokenization of sentences, cropping of images, any filtering such as dropping images without faces)?\n\n\n\n\nclass datahub.metadata.schemaclasses.BatchSpecClass(customProperties=None, nativeBatchId=None, query=None, limit=None)\nBases\n\ncustomProperties (Optional[Dict[str, str]])\nnativeBatchId (Optional[str])\nquery (Optional[str])\nlimit (Optional[int])\n\n\n\n\n\nproperty customProperties None | int\nAny limit to the number of rows in the batch, if applied\n\n\n\nproperty nativeBatchId None | str\nA query that identifies a batch of data\n\n\n\n\nclass datahub.metadata.schemaclasses.BinaryJsonSchemaClass(schema)\nBases\nschema (str)\n\n\n\n\nproperty schema DictWrapper\nBoolean field type.\n\n\n\nclass datahub.metadata.schemaclasses.BrowsePathEntryClass(id, urn=None)\nBases\n\nid (str)\nurn (Optional[str])\n\n\n\n\n\nproperty id None | str\nOptional urn pointing to some entity in DataHub\n\n\n\n\nclass datahub.metadata.schemaclasses.BrowsePathsClass(paths)\nBases\npaths (List[str])\n\n\n\n\nproperty paths \u2018prod/snowflake/datasetName\u2019\n\n\n\n\nclass datahub.metadata.schemaclasses.BrowsePathsV2Class(path)\nBases\npath (List[BrowsePathEntryClass])\n\n\n\n\nproperty path DictWrapper\n\nParameters str\nUrn of the applied businessAttribute\n\n\n\n\nclass datahub.metadata.schemaclasses.BusinessAttributeInfoClass(fieldPath, name, description=None, globalTags=None, glossaryTerms=None, customProperties=None, created=None, lastModified=None, deleted=None, type=None)\nBases\n\nfieldPath (str)\nname (str)\ndescription (Optional[str])\nglobalTags (Optional[GlobalTagsClass])\nglossaryTerms (Optional[GlossaryTermsClass])\ncustomProperties (Optional[Dict[str, str]])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ntype (Optional[SchemaFieldDataTypeClass])\n\n\n\n\n\nproperty created Dict[str, str]\nCustom property bag.\n\n\n\nproperty deleted None | str\nDescription\n\n\n\nproperty fieldPath None | GlobalTagsClass\nTags associated with the field\n\n\n\nproperty glossaryTerms AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\nproperty name None | SchemaFieldDataTypeClass\n\n\n\n\nclass datahub.metadata.schemaclasses.BusinessAttributeKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nBusinessAttribute aspect used for applying it to an entity\n\nParameters None | BusinessAttributeAssociationClass\nBusiness Attribute for this field.\n\n\n\n\nclass datahub.metadata.schemaclasses.BytesTypeClass\nBases object\n\n\nDAY = 'DAY'\n\n\n\nHOUR = 'HOUR'\n\n\n\nMINUTE = 'MINUTE'\n\n\n\nMONTH = 'MONTH'\n\n\n\nQUARTER = 'QUARTER'\n\n\n\nSECOND = 'SECOND'\n\n\n\nWEEK = 'WEEK'\n\n\n\nYEAR = 'YEAR'\n\n\n\n\nclass datahub.metadata.schemaclasses.CaveatDetailsClass(needsFurtherTesting=None, caveatDescription=None, groupsNotRepresented=None)\nBases\n\nneedsFurtherTesting (Optional[bool])\ncaveatDescription (Optional[str])\ngroupsNotRepresented (Optional[List[str]])\n\n\n\n\n\nproperty caveatDescription Given gender classes are binary (male/not male), which we include as male/female. Further work needed to evaluate across a spectrum of genders.\n\n\n\nproperty groupsNotRepresented None | bool\nDid the results suggest any further testing?\n\n\n\n\nclass datahub.metadata.schemaclasses.CaveatsAndRecommendationsClass(caveats=None, recommendations=None, idealDatasetCharacteristics=None)\nBases\n\ncaveats (Optional[CaveatDetailsClass])\nrecommendations (Optional[str])\nidealDatasetCharacteristics (Optional[List[str]])\n\n\n\n\n\nproperty caveats None | List[str]\nIdeal characteristics of an evaluation dataset for this MLModel\n\n\n\nproperty recommendations DictWrapper\nData captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into various lifecycle stages, and who acted to move it into those lifecycle stages. The recommended best practice is to include this record in your record schema, and annotate its fields as @readOnly in your resource. See linkedin/rest.li\n\nParameters AuditStampClass\nAn AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.\n\n\n\nproperty deleted AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\n\nclass datahub.metadata.schemaclasses.ChangeTypeClass\nBases DictWrapper\nChart cell in a notebook, which will present content in chart format\n\nParameters str\nUnique id for the cell. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as \u2018querybook.com/notebook/773/?cellId=1234\u2019\n\n\n\nproperty cellTitle ChangeAuditStampsClass\nCaptures information about who created/last modified/deleted this Notebook cell and when\n\n\n\n\nclass datahub.metadata.schemaclasses.ChartInfoClass(title, description, lastModified, customProperties=None, externalUrl=None, chartUrl=None, inputs=None, inputEdges=None, type=None, access=None, lastRefreshed=None)\nBases\n\ntitle (str)\ndescription (str)\nlastModified (ChangeAuditStampsClass)\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\nchartUrl (Optional[str])\ninputs (Optional[List[str]])\ninputEdges (Optional[List[EdgeClass]])\ntype (Union[None, str, ChartTypeClass])\naccess (Union[None, str, AccessLevelClass])\nlastRefreshed (Optional[int])\n\n\n\n\n\nproperty access None | str\nURL for the chart. This could be used as an external link on DataHub to allow users access/view the chart\n\n\n\nproperty customProperties str\nDetailed description about the chart\n\n\n\nproperty externalUrl None | List[EdgeClass]\nData sources for the chart\n\n\n\nproperty inputs ChangeAuditStampsClass\nCaptures information about who created/last modified/deleted this chart and when\n\n\n\nproperty lastRefreshed str\nTitle of the chart\n\n\n\nproperty type Aspect\nKey for a Chart\n\nParameters str\nUnique id for the chart. This id should be globally unique for a dashboarding tool even when there are multiple deployments of it. As an example, chart URL could be used here for Looker such as \u2018looker.linkedin.com/looks/1234\u2019\n\n\n\nproperty dashboardTool Aspect\nInformation for chart query which is used for getting data of the chart\n\nParameters str\nRaw query to build a chart from input datasets\n\n\n\nproperty type object\n\n\nLOOKML = 'LOOKML'\n\n\n\nSQL = 'SQL'\n\n\n\n\nclass datahub.metadata.schemaclasses.ChartSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[ChartKeyClass, ChartInfoClass, ChartQueryClass, EditableChartPropertiesClass, OwnershipClass, StatusClass, GlobalTagsClass, BrowsePathsClass, GlossaryTermsClass, InstitutionalMemoryClass, DataPlatformInstanceClass, BrowsePathsV2Class]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.ChartTypeClass\nBases Aspect\nExperimental (Subject to breaking change) \u2013 Stats corresponding to chart\u2019s usage.\nIf this aspect represents the latest snapshot of the statistics about a Chart, the eventGranularity field should be null.\nIf this aspect represents a bucketed window of usage statistics (e.g. over a day), then the eventGranularity field should be set accordingly.\n\nParameters ClassVar[str] = 'timeseries'\n\n\n\nproperty eventGranularity None | str\nThe optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.\n\n\n\nproperty partitionSpec int\nThe event timestamp field as epoch at UTC in milli seconds.\n\n\n\nproperty uniqueUserCount None | List[ChartUserUsageCountsClass]\nUsers within this bucket, with frequency counts\n\n\n\nproperty viewsCount DictWrapper\nRecords a single user\u2019s usage counts for a given resource\n\nParameters str\nThe unique id of the user.\n\n\n\nproperty viewsCount object\nThe matching condition in a filter criterion\n\n\nANCESTORSINCL = 'ANCESTORSINCL'\n\n\n\nCONTAIN = 'CONTAIN'\n\n\n\nDESCENDANTSINCL = 'DESCENDANTSINCL'\n\n\n\nENDWITH = 'ENDWITH'\n\n\n\nEQUAL = 'EQUAL'\n\n\n\nEXISTS = 'EXISTS'\n\n\n\nGREATERTHAN = 'GREATERTHAN'\n\n\n\nGREATERTHANOREQUALTO = 'GREATERTHANOREQUALTO'\n\n\n\nIEQUAL = 'IEQUAL'\n\n\n\nIN = 'IN'\n\n\n\nISNULL = 'ISNULL'\n\n\n\nLESSTHAN = 'LESSTHAN'\n\n\n\nLESSTHANOREQUALTO = 'LESSTHANOREQUALTO'\n\n\n\nRELATEDINCL = 'RELATEDINCL'\n\n\n\nSTARTWITH = 'STARTWITH'\n\n\n\n\nclass datahub.metadata.schemaclasses.ConjunctiveCriterionClass(and)\nBases\nand (List[CriterionClass])\n\n\n\n\nproperty and Aspect\nLink from an asset to its parent container\n\nParameters str\nThe parent container of an asset\n\n\n\n\nclass datahub.metadata.schemaclasses.ContainerKeyClass(guid=None)\nBases\nguid (Optional[str])\n\n\n\n\nproperty guid Aspect\nInformation about a Asset Container as received from a 3rd party source system\n\nParameters None | TimeStampClass\nA timestamp documenting when the asset was created in the source Data Platform (not on DataHub)\n\n\n\nproperty customProperties None | str\nDescription of the Asset Container as it exists inside a source system\n\n\n\nproperty env None | str\nURL where the reference exist\n\n\n\nproperty lastModified str\nDisplay name of the Asset Container\n\n\n\nproperty qualifiedName Aspect\nGroup information that can be edited from UI\n\nParameters None | str\nA description of the group\n\n\n\nproperty email str\nA URL which points to a picture which user wants to set as the photo for the group\n\n\n\nproperty slack Aspect\nInformation about a Corp Group ingested from a third party source\n\nParameters List[str]\nowners of this group\nDeprecated! Replaced by Ownership aspect.\n\n\n\nproperty created None | str\nA description of the group.\n\n\n\nproperty displayName None | str\nemail of this group\n\n\n\nproperty groups List[str]\nList of ldap urn in this group.\nDeprecated! Replaced by GroupMembership aspect.\n\n\n\nproperty slack Aspect\nKey for a CorpGroup\n\nParameters str\nThe URL-encoded name of the AD/LDAP group. Serves as a globally unique identifier within DataHub.\n\n\n\n\nclass datahub.metadata.schemaclasses.CorpGroupSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[CorpGroupKeyClass, CorpGroupInfoClass, GlobalTagsClass, StatusClass]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.CorpUserAppearanceSettingsClass(showSimplifiedHomepage=None, showThemeV2=None)\nBases\n\nshowSimplifiedHomepage (Optional[bool])\nshowThemeV2 (Optional[bool])\n\n\n\n\n\nproperty showSimplifiedHomepage None | bool\nFlag controlling whether the V2 UI for DataHub is shown.\n\n\n\n\nclass datahub.metadata.schemaclasses.CorpUserCredentialsClass(salt, hashedPassword, passwordResetToken=None, passwordResetTokenExpirationTimeMillis=None)\nBases\n\nsalt (str)\nhashedPassword (str)\npasswordResetToken (Optional[str])\npasswordResetTokenExpirationTimeMillis (Optional[int])\n\n\n\n\n\nproperty hashedPassword None | str\nOptional token needed to reset a user\u2019s password. Can only be set by the admin.\n\n\n\nproperty passwordResetTokenExpirationTimeMillis str\nSalt used to hash password\n\n\n\n\nclass datahub.metadata.schemaclasses.CorpUserEditableInfoClass(aboutMe=None, teams=None, skills=None, pictureLink=None, displayName=None, title=None, platforms=None, persona=None, slack=None, phone=None, email=None, informationSources=None)\nBases\n\naboutMe (Optional[str])\nteams (Optional[List[str]])\nskills (Optional[List[str]])\npictureLink (Optional[str])\ndisplayName (Optional[str])\ntitle (Optional[str])\nplatforms (Optional[List[str]])\npersona (Optional[str])\nslack (Optional[str])\nphone (Optional[str])\nemail (Optional[str])\ninformationSources (Optional[List[str]])\n\n\n\n\n\nproperty aboutMe None | str\nDataHub-native display name\n\n\n\nproperty email None | List[str]\nInformation sources that have been used to populate this CorpUserEditableInfo.\nThese include platform resources, such as Slack members or Looker users.\nThey can also refer to other semantic urns in the future.\n\n\n\nproperty persona None | str\nPhone number to contact the user\n\n\n\nproperty pictureLink None | List[str]\nThe platforms that the user commonly works with\n\n\n\nproperty skills None | str\nSlack handle for the user\n\n\n\nproperty teams None | str\nDataHub-native Title, e.g. \u2018Software Engineer\u2019\n\n\n\n\nclass datahub.metadata.schemaclasses.CorpUserInfoClass(active, customProperties=None, displayName=None, email=None, title=None, managerUrn=None, departmentId=None, departmentName=None, firstName=None, lastName=None, fullName=None, countryCode=None, system=None)\nBases\n\nactive (bool)\ncustomProperties (Optional[Dict[str, str]])\ndisplayName (Optional[str])\nemail (Optional[str])\ntitle (Optional[str])\nmanagerUrn (Optional[str])\ndepartmentId (Optional[int])\ndepartmentName (Optional[str])\nfirstName (Optional[str])\nlastName (Optional[str])\nfullName (Optional[str])\ncountryCode (Optional[str])\nsystem (Optional[bool])\n\n\n\n\n\nproperty active\nDeprecated! Use CorpUserStatus instead. Whether the corpUser is active, ref\n\nType None | str\ntwo uppercase letters country code. e.g. US\n\n\n\nproperty customProperties None | int\ndepartment id this user belong to\n\n\n\nproperty departmentName None | str\ndisplayName of this user , e.g. Hang Zhang(DataHQ)\n\n\n\nproperty email None | str\nfirst name of this user\n\n\n\nproperty fullName None | str\nlast name of this user\n\n\n\nproperty managerUrn bool | None\nWhether the corpUser is a system user.\n\n\n\nproperty title Aspect\nKey for a CorpUser\n\nParameters str\nThe name of the AD/LDAP user.\n\n\n\n\nclass datahub.metadata.schemaclasses.CorpUserSettingsClass(appearance, views=None, notificationSettings=None)\nBases\n\nappearance (CorpUserAppearanceSettingsClass)\nviews (Optional[CorpUserViewsSettingsClass])\nnotificationSettings (Optional[NotificationSettingsClass])\n\n\n\n\n\nproperty appearance None | NotificationSettingsClass\nNotification settings for a user\n\n\n\nproperty views DictWrapper\nA metadata snapshot for a specific CorpUser entity.\n\nParameters List[CorpUserKeyClass | CorpUserInfoClass | CorpUserEditableInfoClass | CorpUserStatusClass | GroupMembershipClass | GlobalTagsClass | StatusClass]\nThe list of metadata aspects associated with the CorpUser. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nThe status of the user, e.g. provisioned, active, suspended, etc.\n\nParameters AuditStampClass\nAudit stamp containing who last modified the status and when.\n\n\n\nproperty status DictWrapper\nSettings related to the \u2018Views\u2019 feature.\n\nParameters None | str\nThe default View which is selected for the user.\nIf none is chosen, then this value will be left blank.\n\n\n\n\nclass datahub.metadata.schemaclasses.CostClass(costType, cost)\nBases\n\ncostType (Union[str, CostTypeClass])\ncost (CostCostClass)\n\n\n\n\n\nproperty cost str | CostTypeClass\n\n\n\n\nclass datahub.metadata.schemaclasses.CostCostClass(fieldDiscriminator, costId=None, costCode=None)\nBases\n\nfieldDiscriminator (Union[str, CostCostDiscriminatorClass])\ncostId (Optional[float])\ncostCode (Optional[str])\n\n\n\n\n\nproperty costCode None | float\n\n\n\nproperty fieldDiscriminator object\n\n\ncostCode = 'costCode'\n\n\n\ncostId = 'costId'\n\n\n\n\nclass datahub.metadata.schemaclasses.CostTypeClass\nBases DictWrapper\nA criterion for matching a field with given value\n\nParameters str | ConditionClass\nThe condition for the criterion, e.g. EQUAL, STARTWITH\n\n\n\nproperty field bool\nWhether the condition should be negated\n\n\n\nproperty value List[str]\nValues. one of which the intended field should match\nNote, if values is set, the above \u201cvalue\u201d field will be ignored\n\n\n\n\nclass datahub.metadata.schemaclasses.CustomAssertionInfoClass(type, entity, field=None, logic=None)\nBases\n\ntype (str)\nentity (str)\nfield (Optional[str])\nlogic (Optional[str])\n\n\n\n\n\nproperty entity None | str\ndataset schema field targeted by this assertion.\nThis field is expected to be provided if the assertion is on dataset field\n\n\n\nproperty logic str\nThe type of custom assertion.\nThis is how your assertion will appear categorized in DataHub UI.\n\n\n\n\nclass datahub.metadata.schemaclasses.DashboardInfoClass(title, description, lastModified, customProperties=None, externalUrl=None, charts=None, chartEdges=None, datasets=None, datasetEdges=None, dashboards=None, dashboardUrl=None, access=None, lastRefreshed=None)\nBases\n\ntitle (str)\ndescription (str)\nlastModified (ChangeAuditStampsClass)\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\ncharts (Optional[List[str]])\nchartEdges (Optional[List[EdgeClass]])\ndatasets (Optional[List[str]])\ndatasetEdges (Optional[List[EdgeClass]])\ndashboards (Optional[List[EdgeClass]])\ndashboardUrl (Optional[str])\naccess (Union[None, str, AccessLevelClass])\nlastRefreshed (Optional[int])\n\n\n\n\n\nproperty access None | List[EdgeClass]\nCharts in a dashboard\n\n\n\nproperty charts Dict[str, str]\nCustom property bag.\n\n\n\nproperty dashboardUrl List[EdgeClass]\nDashboards included by this dashboard.\nSome dashboard entities (e.g. PowerBI Apps) can contain other dashboards.\nThe Edge\u2019s sourceUrn should never be set, as it will always be the base dashboard.\n\n\n\nproperty datasetEdges List[str]\nDatasets consumed by a dashboard\nDeprecated! Use datasetEdges instead.\n\n\n\nproperty description None | str\nURL where the reference exist\n\n\n\nproperty lastModified None | int\nThe time when this dashboard last refreshed\n\n\n\nproperty title Aspect\nKey for a Dashboard\n\nParameters str\nUnique id for the dashboard. This id should be globally unique for a dashboarding tool even when there are multiple deployments of it. As an example, dashboard URL could be used here for Looker such as \u2018looker.linkedin.com/dashboards/1234\u2019\n\n\n\nproperty dashboardTool DictWrapper\nA metadata snapshot for a specific Dashboard entity.\n\nParameters List[DashboardKeyClass | DashboardInfoClass | EditableDashboardPropertiesClass | OwnershipClass | StatusClass | GlobalTagsClass | BrowsePathsClass | GlossaryTermsClass | InstitutionalMemoryClass | DataPlatformInstanceClass | BrowsePathsV2Class]\nThe list of metadata aspects associated with the dashboard. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nExperimental (Subject to breaking change) \u2013 Stats corresponding to dashboard\u2019s usage.\nIf this aspect represents the latest snapshot of the statistics about a Dashboard, the eventGranularity field should be null.\nIf this aspect represents a bucketed window of usage statistics (e.g. over a day), then the eventGranularity field should be set accordingly.\n\nParameters ClassVar[str] = 'timeseries'\n\n\n\nproperty eventGranularity None | int\nThe total number of dashboard executions (refreshes / syncs)\n\n\n\nproperty favoritesCount None | int\nLast viewed at\nThis should not be set in cases where statistics are windowed.\n\n\n\nproperty messageId PartitionSpecClass | None\nThe optional partition specification.\n\n\n\nproperty timestampMillis None | int\nUnique user count\n\n\n\nproperty userCounts None | int\nThe total number of times dashboard has been viewed\n\n\n\n\nclass datahub.metadata.schemaclasses.DashboardUserUsageCountsClass(user, viewsCount=None, executionsCount=None, usageCount=None, userEmail=None)\nBases\n\nuser (str)\nviewsCount (Optional[int])\nexecutionsCount (Optional[int])\nusageCount (Optional[int])\nuserEmail (Optional[str])\n\n\n\n\n\nproperty executionsCount None | int\nNormalized numeric metric representing user\u2019s dashboard usage \u2013 the number of times the user executed or viewed the dashboard.\n\n\n\nproperty user None | str\nIf useremail is set, we attempt to resolve the user\u2019s urn upon ingest\n\n\n\nproperty viewsCount Aspect\nKey for a Data Contract\n\nParameters str\nUnique id for the contract\n\n\n\n\nclass datahub.metadata.schemaclasses.DataContractPropertiesClass(entity, schema=None, freshness=None, dataQuality=None, rawContract=None)\nBases\n\nentity (str)\nschema (Optional[List[SchemaContractClass]])\nfreshness (Optional[List[FreshnessContractClass]])\ndataQuality (Optional[List[DataQualityContractClass]])\nrawContract (Optional[str])\n\n\n\n\n\nproperty dataQuality str\nThe entity that this contract is associated with. Currently, we only support Dataset contracts, but\nin the future we may also support Data Product level contracts.\n\n\n\nproperty freshness None | str\nYAML-formatted contract definition\n\n\n\nproperty schema object\n\n\nACTIVE = 'ACTIVE'\n\n\n\nPENDING = 'PENDING'\n\n\n\n\nclass datahub.metadata.schemaclasses.DataContractStatusClass(state, customProperties=None)\nBases\n\nstate (Union[str, DataContractStateClass])\ncustomProperties (Optional[Dict[str, str]])\n\n\n\n\n\nproperty customProperties str | DataContractStateClass\nThe latest state of the data contract\n\n\n\n\nclass datahub.metadata.schemaclasses.DataFlowInfoClass(name, customProperties=None, externalUrl=None, description=None, project=None, created=None, lastModified=None, env=None)\nBases\n\nname (str)\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\ndescription (Optional[str])\nproject (Optional[str])\ncreated (Optional[TimeStampClass])\nlastModified (Optional[TimeStampClass])\nenv (Union[None, str, FabricTypeClass])\n\n\n\n\n\nproperty created Dict[str, str]\nCustom property bag.\n\n\n\nproperty description None | str | FabricTypeClass\nEnvironment for this flow\n\n\n\nproperty externalUrl None | TimeStampClass\nA timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)\n\n\n\nproperty name None | str\nOptional project/namespace associated with the flow\n\n\n\n\nclass datahub.metadata.schemaclasses.DataFlowKeyClass(orchestrator, flowId, cluster)\nBases\n\norchestrator (str)\nflowId (str)\ncluster (str)\n\n\n\n\n\nproperty cluster str\nUnique Identifier of the data flow\n\n\n\nproperty orchestrator DictWrapper\nA metadata snapshot for a specific DataFlow entity.\n\nParameters List[DataFlowKeyClass | DataFlowInfoClass | EditableDataFlowPropertiesClass | OwnershipClass | StatusClass | GlobalTagsClass | BrowsePathsClass | GlossaryTermsClass | InstitutionalMemoryClass | DataPlatformInstanceClass | BrowsePathsV2Class]\nThe list of metadata aspects associated with the data flow. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nInformation about a DataHub Access Token\n\nParameters str\nUrn of the actor to which this access token belongs to.\n\n\n\nproperty createdAt None | str\nDescription of the token if defined.\n\n\n\nproperty expiresAt str\nUser defined name for the access token if defined.\n\n\n\nproperty ownerUrn Aspect\nKey for a DataHub Access Token\n\nParameters str\nAccess token\u2019s SHA-256 hashed JWT signature\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubActionKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\nInformation used to filter DataHub actors.\n\nParameters bool\nWhether the filter should apply to all groups.\n\n\n\nproperty allUsers None | List[str]\nA specific set of groups to apply the policy to (disjunctive)\n\n\n\nproperty resourceOwners None | List[str]\nDefine type of ownership for the policy\n\n\n\nproperty roles None | List[str]\nA specific set of users to apply the policy to (disjunctive)\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubConnectionDetailsClass(type, name=None, json=None)\nBases\n\ntype (Union[str, DataHubConnectionDetailsTypeClass])\nname (Optional[str])\njson (Optional[DataHubJsonConnectionClass])\n\n\n\n\n\nproperty json None | str\nDisplay name of the connection\n\n\n\nproperty type object\n\n\nJSON = 'JSON'\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubConnectionKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\n\nParameters None | bool\nWhether or not to run this ingestion source in debug mode\n\n\n\nproperty executorId None | Dict[str, str]\nExtra arguments for the ingestion run.\n\n\n\nproperty recipe None | str\nThe PyPI version of the datahub CLI to use when executing a recipe\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubIngestionSourceInfoClass(name, type, config, platform=None, schedule=None, source=None)\nBases\n\nname (str)\ntype (str)\nconfig (DataHubIngestionSourceConfigClass)\nplatform (Optional[str])\nschedule (Optional[DataHubIngestionSourceScheduleClass])\nsource (Optional[DataHubIngestionSourceSourceClass])\n\n\n\n\n\nproperty config str\nThe display name of the ingestion source\n\n\n\nproperty platform None | DataHubIngestionSourceScheduleClass\nThe schedule on which the ingestion source is executed\n\n\n\nproperty source str\nThe type of the source itself, e.g. mysql, bigquery, bigquery-usage. Should match the recipe.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubIngestionSourceKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\nThe schedule associated with an ingestion source.\n\nParameters str\nA cron-formatted execution interval, as a cron string, e.g. * * * * *\n\n\n\nproperty timezone DictWrapper\n\nParameters str | DataHubIngestionSourceSourceTypeClass\nThe source type of the ingestion source\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubIngestionSourceSourceTypeClass\nBases DictWrapper\nA set of connection details consisting of an encrypted JSON blob.\n\nParameters str\nThe encrypted JSON connection details.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubOpenAPISchemaKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nPlaceholder aspect for persona type info\n\n\n\nclass datahub.metadata.schemaclasses.DataHubPersonaKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nInformation about a DataHub (UI) access policy.\n\nParameters DataHubActorFilterClass\nThe actors that the policy applies to.\n\n\n\nproperty description str\nDisplay name of the Policy\n\n\n\nproperty editable None | int\nTimestamp when the policy was last updated\n\n\n\nproperty privileges None | DataHubResourceFilterClass\nThe resource that the policy applies to. Not required for some \u2018Platform\u2019 privileges.\n\n\n\nproperty state str\nThe type of policy\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubPolicyKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\nA metadata snapshot for DataHub Access Policy data.\n\nParameters List[DataHubPolicyKeyClass | DataHubPolicyInfoClass]\nThe list of metadata aspects associated with the DataHub access policy.\n\n\n\nproperty urn DictWrapper\nInformation used to filter DataHub resource.\n\nParameters bool\nWhether the policy should be applied to all assets matching the filter.\n\n\n\nproperty filter None | List[str]\nA specific set of resources to apply the policy to, e.g. asset urns\n\n\n\nproperty type Aspect\n\nParameters RetentionClass\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubRetentionKeyClass(entityName, aspectName)\nBases\n\nentityName (str)\naspectName (str)\n\n\n\n\n\nproperty aspectName str\nEntity name to apply retention to. (or empty) for applying defaults.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubRetentionSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[DataHubRetentionKeyClass, DataHubRetentionConfigClass]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubRoleInfoClass(name, description, editable=None)\nBases\n\nname (str)\ndescription (str)\neditable (Optional[bool])\n\n\n\n\n\nproperty description bool\nWhether the role should be editable via the UI\n\n\n\nproperty name Aspect\nKey for a DataHub Role\n\nParameters str\nA unique id for the DataHub role record. Generated on the server side at role creation time.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubSearchConfigClass(fieldName=None, fieldType=None, queryByDefault=None, enableAutocomplete=None, addToFilters=None, addHasValuesToFilters=None, filterNameOverride=None, hasValuesFilterNameOverride=None, boostScore=None, hasValuesFieldName=None, numValuesFieldName=None, weightsPerFieldValue=None, fieldNameAliases=None)\nBases\n\nfieldName (Optional[str])\nfieldType (Union[None, str, SearchFieldTypeClass])\nqueryByDefault (Optional[bool])\nenableAutocomplete (Optional[bool])\naddToFilters (Optional[bool])\naddHasValuesToFilters (Optional[bool])\nfilterNameOverride (Optional[str])\nhasValuesFilterNameOverride (Optional[str])\nboostScore (Optional[float])\nhasValuesFieldName (Optional[str])\nnumValuesFieldName (Optional[str])\nweightsPerFieldValue (Optional[Dict[str, float]])\nfieldNameAliases (Optional[List[str]])\n\n\n\n\n\nproperty addHasValuesToFilters bool\nWhether or not to add field to filters.\n\n\n\nproperty boostScore bool\nWhether we should use the field for default autocomplete\n\n\n\nproperty fieldName None | List[str]\n(Optional) Aliases for this given field that can be used for sorting etc.\n\n\n\nproperty fieldType None | str\nDisplay name of the filter\n\n\n\nproperty hasValuesFieldName None | str\nDisplay name of the has values filter\n\n\n\nproperty numValuesFieldName bool\nWhether we should match the field for the default search query\n\n\n\nproperty weightsPerFieldValue Aspect\nKey for a DataHub Secret\n\nParameters str\nA unique id for the Secret\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubSecretValueClass(name, value, description=None, created=None)\nBases\n\nname (str)\nvalue (str)\ndescription (Optional[str])\ncreated (Optional[AuditStampClass])\n\n\n\n\n\nproperty created None | str\nDescription of the secret\n\n\n\nproperty name str\nThe AES-encrypted value of the DataHub secret.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubStepStateKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nThe properties associated with a DataHub step state\n\nParameters AuditStampClass\nAudit stamp describing the last person to update it.\n\n\n\nproperty properties Aspect\nKey for a DataHubUpgrade\n\nParameters str\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubUpgradeRequestClass(timestampMs, version)\nBases\n\ntimestampMs (int)\nversion (str)\n\n\n\n\n\nproperty timestampMs str\nVersion of this upgrade\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubUpgradeResultClass(timestampMs, state=None, result=None)\nBases\n\ntimestampMs (int)\nstate (Union[str, DataHubUpgradeStateClass, None])\nresult (Optional[Dict[str, str]])\n\n\n\n\n\nproperty result str | DataHubUpgradeStateClass | None\nUpgrade state UpgradeResult.Result\n\n\n\nproperty timestampMs object\n\n\nABORTED = 'ABORTED'\n\n\n\nFAILED = 'FAILED'\n\n\n\nINPROGRESS = 'INPROGRESS'\n\n\n\nSUCCEEDED = 'SUCCEEDED'\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubViewDefinitionClass(entityTypes, filter)\nBases\n\nentityTypes (List[str])\nfilter (FilterClass)\n\n\n\n\n\nproperty entityTypes FilterClass\nThe filter criteria, which represents the view itself\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubViewInfoClass(name, type, definition, created, lastModified, description=None)\nBases Understand whether an entity type filter is required.\n\nParameters AuditStampClass\nAudit stamp capturing the time and actor who created the View.\n\n\n\nproperty definition None | str\nDescription of the view\n\n\n\nproperty lastModified str\nThe name of the View\n\n\n\nproperty type Aspect\nKey for a DataHub View\n\nParameters str\nA unique id for the View\n\n\n\n\nclass datahub.metadata.schemaclasses.DataHubViewTypeClass\nBases Aspect\nInformation about a Data processing job\n\nParameters None | TimeStampClass\nA timestamp documenting when the asset was created in the source Data Platform (not on DataHub)\n\n\n\nproperty customProperties None | str\nJob description\n\n\n\nproperty env None | str\nURL where the reference exist\n\n\n\nproperty flowUrn None | TimeStampClass\nA timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)\n\n\n\nproperty name None | str | JobStatusClass\nStatus of the job - Deprecated for Data Process Instance model.\n\n\n\nproperty type AzkabanJobType is deprecated. Please use strings instead.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataJobInputOutputClass(inputDatasets, outputDatasets, inputDatasetEdges=None, outputDatasetEdges=None, inputDatajobs=None, inputDatajobEdges=None, inputDatasetFields=None, outputDatasetFields=None, fineGrainedLineages=None)\nBases\n\ninputDatasets (List[str])\noutputDatasets (List[str])\ninputDatasetEdges (Optional[List[EdgeClass]])\noutputDatasetEdges (Optional[List[EdgeClass]])\ninputDatajobs (Optional[List[str]])\ninputDatajobEdges (Optional[List[EdgeClass]])\ninputDatasetFields (Optional[List[str]])\noutputDatasetFields (Optional[List[str]])\nfineGrainedLineages (Optional[List[FineGrainedLineageClass]])\n\n\n\n\n\nproperty fineGrainedLineages None | List[EdgeClass]\nInput datajobs that this data job depends on\n\n\n\nproperty inputDatajobs None | List[EdgeClass]\nInput datasets consumed by the data job during processing\n\n\n\nproperty inputDatasetFields List[str]\nInput datasets consumed by the data job during processing\nDeprecated! Use inputDatasetEdges instead.\n\n\n\nproperty outputDatasetEdges None | List[str]\nFields of the output datasets this job writes to\n\n\n\nproperty outputDatasets Aspect\nKey for a Data Job\n\nParameters str\nStandardized data processing flow urn representing the flow for the job\n\n\n\nproperty jobId DictWrapper\nA metadata snapshot for a specific DataJob entity.\n\nParameters List[DataJobKeyClass | DataJobInfoClass | DataJobInputOutputClass | EditableDataJobPropertiesClass | OwnershipClass | StatusClass | GlobalTagsClass | BrowsePathsClass | GlossaryTermsClass | InstitutionalMemoryClass | DataPlatformInstanceClass | BrowsePathsV2Class]\nThe list of metadata aspects associated with the data job. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nInformation about a data platform\n\nParameters str\nThe delimiter in the dataset names on the data platform, e.g. \u2018/\u2019 for HDFS and \u2018.\u2019 for Oracle\n\n\n\nproperty displayName None | str\nThe URL for a logo associated with the platform\n\n\n\nproperty name str | PlatformTypeClass\nPlatform type this data platform describes\n\n\n\n\nclass datahub.metadata.schemaclasses.DataPlatformInstanceClass(platform, instance=None)\nBases\n\nplatform (str)\ninstance (Optional[str])\n\n\n\n\n\nproperty instance str\nData Platform\n\n\n\n\nclass datahub.metadata.schemaclasses.DataPlatformInstanceKeyClass(platform, instance)\nBases\n\nplatform (str)\ninstance (str)\n\n\n\n\n\nproperty instance str\nData platform urn associated with the instance\n\n\n\n\nclass datahub.metadata.schemaclasses.DataPlatformInstancePropertiesClass(customProperties=None, externalUrl=None, name=None, description=None)\nBases\n\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\nname (Optional[str])\ndescription (Optional[str])\n\n\n\n\n\nproperty customProperties None | str\nDocumentation of the Data Platform Instance\n\n\n\nproperty externalUrl None | str\nDisplay name of the Data Platform Instance\n\n\n\n\nclass datahub.metadata.schemaclasses.DataPlatformKeyClass(platformName)\nBases\nplatformName (str)\n\n\n\n\nproperty platformName DictWrapper\nA metadata snapshot for a specific dataplatform entity.\n\nParameters List[DataPlatformKeyClass | DataPlatformInfoClass]\nThe list of metadata aspects associated with the data platform. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nThe inputs and outputs of this data process\n\nParameters None | List[str]\nthe inputs of the data process\n\n\n\nproperty outputs Aspect\nInformation about the inputs datasets of a Data process\n\nParameters None | List[EdgeClass]\nInput assets consumed by the data process instance, with additional metadata.\nCounts as lineage.\nWill eventually deprecate the inputs field.\n\n\n\nproperty inputs Aspect\nKey for an Asset DataProcessInstance\n\nParameters str\nA unique id for the DataProcessInstance . Should be separate from the name used for displaying a DataProcessInstance.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProcessInstanceOutputClass(outputs, outputEdges=None)\nBases\n\noutputs (List[str])\noutputEdges (Optional[List[EdgeClass]])\n\n\n\n\n\nproperty outputEdges List[str]\nOutput assets produced\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProcessInstancePropertiesClass(name, created, customProperties=None, externalUrl=None, type=None)\nBases\n\nname (str)\ncreated (AuditStampClass)\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\ntype (Union[None, str, DataProcessTypeClass])\n\n\n\n\n\nproperty created Dict[str, str]\nCustom property bag.\n\n\n\nproperty externalUrl str\nProcess name\n\n\n\nproperty type Aspect\nInformation about Data process relationships\n\nParameters None | str\nThe parent DataProcessInstance where it belongs to.\nIf it is a Airflow Task then it should belong to an Airflow Dag run as well\nwhich will be another DataProcessInstance\n\n\n\nproperty parentTemplate List[str]\nInput DataProcessInstance which triggered this dataprocess instance\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProcessInstanceRunEventClass(timestampMillis, status, eventGranularity=None, partitionSpec=None, messageId=None, externalUrl=None, attempt=None, result=None, durationMillis=None)\nBases\n\ntimestampMillis (int)\nstatus (Union[str, DataProcessRunStatusClass])\neventGranularity (Optional[TimeWindowSizeClass])\npartitionSpec (Optional[PartitionSpecClass])\nmessageId (Optional[str])\nexternalUrl (Optional[str])\nattempt (Optional[int])\nresult (Optional[DataProcessInstanceRunResultClass])\ndurationMillis (Optional[int])\n\n\n\n\n\nASPECTTYPE None | int\nReturn the try number that this Instance Run is in\n\n\n\nproperty durationMillis None | TimeWindowSizeClass\nGranularity of the event if applicable\n\n\n\nproperty externalUrl None | str\nThe optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.\n\n\n\nproperty partitionSpec None | DataProcessInstanceRunResultClass\nThe final result of the Data Processing run.\n\n\n\nproperty status int\nThe event timestamp field as epoch at UTC in milli seconds.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProcessInstanceRunResultClass(type, nativeResultType)\nBases\n\ntype (Union[str, RunResultTypeClass])\nnativeResultType (str)\n\n\n\n\n\nproperty nativeResultType str | RunResultTypeClass\nThe final result, e.g. SUCCESS, FAILURE, SKIPPED, or UPFORRETRY.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProcessKeyClass(name, orchestrator, origin)\nBases\n\nname (str)\norchestrator (str)\norigin (Union[str, FabricTypeClass])\n\n\n\n\n\nproperty name str\nStandardized Orchestrator where data process is defined.\nTODO str | FabricTypeClass\nFabric type where dataset belongs to or where it was generated.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProcessRunStatusClass\nBases DictWrapper\nA metadata snapshot for a specific Data process entity.\n\nParameters List[DataProcessKeyClass | OwnershipClass | DataProcessInfoClass | StatusClass]\nThe list of metadata aspects associated with the data process. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn object\n\n\nBATCHADHOC = 'BATCHADHOC'\n\n\n\nBATCHSCHEDULED = 'BATCHSCHEDULED'\n\n\n\nSTREAMING = 'STREAMING'\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProductAssociationClass(destinationUrn, sourceUrn=None, created=None, lastModified=None, properties=None, outputPort=None)\nBases\n\ndestinationUrn (str)\nsourceUrn (Optional[str])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\nproperties (Optional[Dict[str, str]])\noutputPort (Optional[bool])\n\n\n\n\n\nproperty created str\nUrn of the destination of this relationship edge.\n\n\n\nproperty lastModified bool\nIf set to true, this asset is an output port of the Data Product.\n\n\n\nproperty properties None | str\nUrn of the source of this relationship edge.\nIf not specified, assumed to be the entity that this aspect belongs to.\n\n\n\n\nclass datahub.metadata.schemaclasses.DataProductKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nThe main properties of a Data Product\n\nParameters None | List[DataProductAssociationClass]\nA list of assets that are part of this Data Product\n\n\n\nproperty customProperties None | str\nDocumentation of the dataset\n\n\n\nproperty externalUrl None | str\nDisplay name of the Data Product\n\n\n\n\nclass datahub.metadata.schemaclasses.DataQualityContractClass(assertion)\nBases\nassertion (str)\n\n\n\n\nproperty assertion DictWrapper\nInformation about a transformation. It may be a query,\n\nParameters None | QueryStatementClass\nThe data transform may be defined by a query statement\n\n\n\n\nclass datahub.metadata.schemaclasses.DataTransformLogicClass(transforms)\nBases\ntransforms (List[DataTransformClass])\n\n\n\n\nproperty transforms Aspect\n\nParameters None | str\nAn optional description for the data type.\n\n\n\nproperty displayName str\nThe qualified name for the data type. Usually a unique namespace + name, e.g. datahub.string\n\n\n\n\nclass datahub.metadata.schemaclasses.DataTypeKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nCheckpoint of a datahub ingestion run for a given job.\n\nParameters ClassVar[str] = 'timeseries'\n\n\n\nproperty config None | TimeWindowSizeClass\nGranularity of the event if applicable\n\n\n\nproperty messageId PartitionSpecClass | None\nThe optional partition specification.\n\n\n\nproperty pipelineName str\nThe id of the instance against which the ingestion pipeline ran.\ne.g. str\nThe run identifier of this job.\n\n\n\nproperty state int\nThe event timestamp field as epoch at UTC in milli seconds.\n\n\n\n\nclass datahub.metadata.schemaclasses.DatahubIngestionRunSummaryClass(timestampMillis, pipelineName, platformInstanceId, runId, runStatus, eventGranularity=None, partitionSpec=None, messageId=None, numWorkUnitsCommitted=None, numWorkUnitsCreated=None, numEvents=None, numEntities=None, numAspects=None, numSourceAPICalls=None, totalLatencySourceAPICalls=None, numSinkAPICalls=None, totalLatencySinkAPICalls=None, numWarnings=None, numErrors=None, numEntitiesSkipped=None, config=None, customsummary=None, softwareVersion=None, systemHostName=None, operatingSystemName=None, numProcessors=None, totalMemory=None, availableMemory=None)\nBases\n\ntimestampMillis (int)\npipelineName (str)\nplatformInstanceId (str)\nrunId (str)\nrunStatus (Union[str, JobStatusClass])\neventGranularity (Optional[TimeWindowSizeClass])\npartitionSpec (Optional[PartitionSpecClass])\nmessageId (Optional[str])\nnumWorkUnitsCommitted (Optional[int])\nnumWorkUnitsCreated (Optional[int])\nnumEvents (Optional[int])\nnumEntities (Optional[int])\nnumAspects (Optional[int])\nnumSourceAPICalls (Optional[int])\ntotalLatencySourceAPICalls (Optional[int])\nnumSinkAPICalls (Optional[int])\ntotalLatencySinkAPICalls (Optional[int])\nnumWarnings (Optional[int])\nnumErrors (Optional[int])\nnumEntitiesSkipped (Optional[int])\nconfig (Optional[str])\ncustomsummary (Optional[str])\nsoftwareVersion (Optional[str])\nsystemHostName (Optional[str])\noperatingSystemName (Optional[str])\nnumProcessors (Optional[int])\ntotalMemory (Optional[int])\navailableMemory (Optional[int])\n\n\n\n\n\nASPECTTYPE None | int\nThe available memory on the host the ingestion pipeline ran on.\n\n\n\nproperty config None | str\nCustom value.\n\n\n\nproperty eventGranularity None | str\nThe optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.\n\n\n\nproperty numAspects None | int\nThe total number of entities produced (unique entity urns).\n\n\n\nproperty numEntitiesSkipped None | int\nNumber of errors generated.\n\n\n\nproperty numEvents None | int\nThe number of processors on the host the ingestion pipeline ran on.\n\n\n\nproperty numSinkAPICalls None | int\nTotal number of source API calls.\n\n\n\nproperty numWarnings None | int\nThe number of workunits written to sink.\n\n\n\nproperty numWorkUnitsCreated None | str\nThe os the ingestion pipeline ran on.\n\n\n\nproperty partitionSpec str\nThe name of the pipeline that ran ingestion, a stable unique user provided identifier.\ne.g. mysnowflake1-to-datahub.\n\n\n\nproperty platformInstanceId Bigquery project ids, MySQL hostnames etc.\n\n\n\nproperty runId str | JobStatusClass\nRun Status - Succeeded/Skipped/Failed etc.\n\n\n\nproperty softwareVersion None | str\nThe hostname the ingestion pipeline ran on.\n\n\n\nproperty timestampMillis None | int\nTotal latency across all sink API calls.\n\n\n\nproperty totalLatencySourceAPICalls None | int\nThe total amount of memory on the host the ingestion pipeline ran on.\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetAssertionInfoClass(dataset, scope, operator, fields=None, aggregation=None, parameters=None, nativeType=None, nativeParameters=None, logic=None)\nBases\n\ndataset (str)\nscope (Union[str, DatasetAssertionScopeClass])\noperator (Union[str, AssertionStdOperatorClass])\nfields (Optional[List[str]])\naggregation (Union[None, str, AssertionStdAggregationClass])\nparameters (Optional[AssertionStdParametersClass])\nnativeType (Optional[str])\nnativeParameters (Optional[Dict[str, str]])\nlogic (Optional[str])\n\n\n\n\n\nproperty aggregation str\nThe dataset targeted by this assertion.\n\n\n\nproperty fields None | str\n\n\n\nproperty nativeParameters None | str\nNative assertion type\n\n\n\nproperty operator None | AssertionStdParametersClass\nStandard parameters required for the assertion. e.g. minvalue, maxvalue, value, columns\n\n\n\nproperty scope object\n\n\nDATASETCOLUMN = 'DATASETCOLUMN'\n\n\n\nDATASETROWS = 'DATASETROWS'\n\n\n\nDATASETSCHEMA = 'DATASETSCHEMA'\n\n\n\nDATASETSTORAGESIZE = 'DATASETSTORAGESIZE'\n\n\n\nUNKNOWN = 'UNKNOWN'\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetDeprecationClass(deprecated, note, decommissionTime=None, actor=None)\nBases\n\ndeprecated (bool)\nnote (str)\ndecommissionTime (Optional[int])\nactor (Optional[str])\n\n\n\n\n\nproperty actor None | int\nThe time user plan to decommission this dataset.\n\n\n\nproperty deprecated str\nAdditional information about the dataset deprecation plan, such as the wiki, doc, RB.\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetFieldForeignKeyClass(parentDataset, currentFieldPaths, parentField)\nBases\n\nparentDataset (str)\ncurrentFieldPaths (List[str])\nparentField (str)\n\n\n\n\n\nproperty currentFieldPaths str\ndataset that stores the resource.\n\n\n\nproperty parentField DictWrapper\nRepresentation of mapping between fields in source dataset to the field in destination dataset\n\nParameters AuditStampClass\nAudit stamp containing who reported the field mapping and when\n\n\n\nproperty destinationField List[str]\nSource fields from which the fine grained lineage is derived\n\n\n\nproperty transformation DictWrapper\nStats corresponding to fields in a dataset\n\nParameters None | List[ValueFrequencyClass]\n\n\n\nproperty fieldPath None | HistogramClass\n\n\n\nproperty max None | str\n\n\n\nproperty median None | str\n\n\n\nproperty nullCount None | float\n\n\n\nproperty quantiles None | List[str]\n\n\n\nproperty stdev None | int\n\n\n\nproperty uniqueProportion DictWrapper\nRecords field-level usage counts for a given dataset\n\nParameters int\nNumber of times the field has been used.\n\n\n\nproperty fieldPath DictWrapper\nA definition of filters that should be used when\nquerying an external Dataset or Table.\nNote that this models should NOT be used for working with\nsearch / filter on DataHub Platform itself.\n\nParameters None | str\nThe raw where clause string which will be used for monitoring.\nRequired if the type is SQL.\n\n\n\nproperty type object\n\n\nSQL = 'SQL'\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetKeyClass(platform, name, origin)\nBases\n\nplatform (str)\nname (str)\norigin (Union[str, FabricTypeClass])\n\n\n\n\n\nproperty name str | FabricTypeClass\nFabric type where dataset belongs to or where it was generated.\n\n\n\nproperty platform object\nThe various types of supported dataset lineage\n\n\nCOPY = 'COPY'\n\n\n\nTRANSFORMED = 'TRANSFORMED'\n\n\n\nVIEW = 'VIEW'\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetProfileClass(timestampMillis, eventGranularity=None, partitionSpec=None, messageId=None, rowCount=None, columnCount=None, fieldProfiles=None, sizeInBytes=None)\nBases\n\ntimestampMillis (int)\neventGranularity (Optional[TimeWindowSizeClass])\npartitionSpec (Optional[PartitionSpecClass])\nmessageId (Optional[str])\nrowCount (Optional[int])\ncolumnCount (Optional[int])\nfieldProfiles (Optional[List[DatasetFieldProfileClass]])\nsizeInBytes (Optional[int])\n\n\n\n\n\nASPECTTYPE None | int\nThe total number of columns (or schema fields)\n\n\n\nproperty eventGranularity None | List[DatasetFieldProfileClass]\nProfiles for each column (or schema field)\n\n\n\nproperty messageId PartitionSpecClass | None\nThe optional partition specification.\n\n\n\nproperty rowCount None | int\nStorage size in bytes\n\n\n\nproperty timestampMillis Aspect\nProperties associated with a Dataset\n\nParameters None | TimeStampClass\nA timestamp documenting when the asset was created in the source Data Platform (not on DataHub)\n\n\n\nproperty customProperties None | str\nDocumentation of the dataset\n\n\n\nproperty externalUrl None | TimeStampClass\nA timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)\n\n\n\nproperty name None | str\nFully-qualified name of the Dataset\n\n\n\nproperty tags None | str\n///dir/filename. Uri should not include any environment specific properties. Some datasets might not have a standardized uri, which makes this field optional (i.e. kafka topic).\n\nType\n///data/tracking/PageViewEvent, file\n\n\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[DatasetKeyClass, DatasetPropertiesClass, EditableDatasetPropertiesClass, DatasetDeprecationClass, DatasetUpstreamLineageClass, UpstreamLineageClass, InstitutionalMemoryClass, OwnershipClass, StatusClass, SchemaMetadataClass, EditableSchemaMetadataClass, GlobalTagsClass, GlossaryTermsClass, BrowsePathsClass, DataPlatformInstanceClass, ViewPropertiesClass, BrowsePathsV2Class]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.DatasetUpstreamLineageClass(fieldMappings)\nBases\nfieldMappings (List[DatasetFieldMappingClass])\n\n\n\n\nproperty fieldMappings Aspect\nStats corresponding to dataset\u2019s usage.\n\nParameters ClassVar[str] = 'timeseries'\n\n\n\nproperty eventGranularity None | List[DatasetFieldUsageCountsClass]\nField-level usage stats\n\n\n\nproperty messageId PartitionSpecClass | None\nThe optional partition specification.\n\n\n\nproperty timestampMillis None | List[str]\nFrequent SQL queries; mostly makes sense for datasets in SQL databases\n\n\n\nproperty totalSqlQueries None | int\nUnique user count\n\n\n\nproperty userCounts DictWrapper\nRecords a single user\u2019s usage counts for a given resource\n\nParameters int\nNumber of times the dataset has been used by the user.\n\n\n\nproperty user None | str\nIf useremail is set, we attempt to resolve the user\u2019s urn upon ingest\n\n\n\n\nclass datahub.metadata.schemaclasses.DateTypeClass\nBases object\nModel endpoint statuses\n\n\nCREATING = 'CREATING'\n\n\n\nDELETING = 'DELETING'\n\n\n\nFAILED = 'FAILED'\n\n\n\nINSERVICE = 'INSERVICE'\n\n\n\nOUTOFSERVICE = 'OUTOFSERVICE'\n\n\n\nROLLINGBACK = 'ROLLINGBACK'\n\n\n\nUNKNOWN = 'UNKNOWN'\n\n\n\nUPDATING = 'UPDATING'\n\n\n\n\nclass datahub.metadata.schemaclasses.DeprecationClass(deprecated, note, actor, decommissionTime=None, replacement=None)\nBases\n\ndeprecated (bool)\nnote (str)\nactor (str)\ndecommissionTime (Optional[int])\nreplacement (Optional[str])\n\n\n\n\n\nproperty actor None | int\nThe time user plan to decommission this entity.\n\n\n\nproperty deprecated str\nAdditional information about the entity deprecation plan, such as the wiki, doc, RB.\n\n\n\nproperty replacement Aspect\nProperties related to how the entity is displayed in the Datahub UI\n\nParameters None | str\nThe color associated with the entity in Hex. For example #FFFFFF.\n\n\n\nproperty icon DictWrapper\n\nParameters bool\n\n\n\nproperty config None | str\n\nThe version of the configuration schema that has been used to serializethe config.\n\n\nIf not provided, the version is assumed to be the latest version.\n\n\n\nproperty enabled DictWrapper\nProperties of applied documentation including the attribution of the doc\n\nParameters None | MetadataAttributionClass\nInformation about who, why, and how this metadata was applied\n\n\n\nproperty documentation Aspect\nAspect used for storing all applicable documentations on assets.\nThis aspect supports multiple documentations from different sources.\nThere is an implicit assumption that there is only one documentation per\n\nsource.\n\n\nFor example, if there are two documentations from the same source, thelatest one will overwrite the previous one.\n\nIf there are two documentations from different sources, both will bestored.\n\n\nFuture evolution considerations\ndocumentations (List[DocumentationAssociationClass])\n\n\n\n\nproperty documentations Aspect\nKey for an Asset Domain\n\nParameters str\nA unique id for the domain. Should be separate from the name used for displaying a Domain.\n\n\n\n\nclass datahub.metadata.schemaclasses.DomainPropertiesClass(name, customProperties=None, description=None, created=None, parentDomain=None)\nBases\n\nname (str)\ncustomProperties (Optional[Dict[str, str]])\ndescription (Optional[str])\ncreated (Optional[AuditStampClass])\nparentDomain (Optional[str])\n\n\n\n\n\nproperty created Dict[str, str]\nCustom property bag.\n\n\n\nproperty description str\nDisplay name of the Domain\n\n\n\nproperty parentDomain\nOptional\n\n\n\n\n\n\nclass datahub.metadata.schemaclasses.DomainsClass(domains)\nBases\ndomains (List[str])\n\n\n\n\nproperty domains Aspect\nInformation about how a form is assigned to entities dynamically. Provide a filter to\nmatch a set of entities instead of explicitly applying a form to specific entities.\n\nParameters FilterClass\nThe filter applied when assigning this form to entities. Entities that match this filter\nwill have this form applied to them. Right now this filter only supports filtering by\nplatform, entity type, container, and domain through the UI.\n\n\n\n\nclass datahub.metadata.schemaclasses.ERModelRelationshipCardinalityClass\nBases Aspect\nKey for a ERModelRelationship\n\nParameters str\n\n\n\n\nclass datahub.metadata.schemaclasses.ERModelRelationshipPropertiesClass(name, source, destination, relationshipFieldMappings, customProperties=None, created=None, lastModified=None, cardinality=None)\nBases\n\nname (str)\nsource (str)\ndestination (str)\nrelationshipFieldMappings (List[RelationshipFieldMappingClass])\ncustomProperties (Optional[Dict[str, str]])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ncardinality (Union[str, ERModelRelationshipCardinalityClass, None])\n\n\n\n\n\nproperty cardinality None | AuditStampClass\nA timestamp documenting when the asset was created in the source Data Platform (not on DataHub)\n\n\n\nproperty customProperties str\nSecond dataset in the erModelRelationship (no directionality)\n\n\n\nproperty lastModified str\nName of the ERModelRelation\n\n\n\nproperty relationshipFieldMappings str\nFirst dataset in the erModelRelationship (no directionality)\n\n\n\n\nclass datahub.metadata.schemaclasses.EdgeClass(destinationUrn, sourceUrn=None, created=None, lastModified=None, properties=None)\nBases\n\ndestinationUrn (str)\nsourceUrn (Optional[str])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\nproperties (Optional[Dict[str, str]])\n\n\n\n\n\nproperty created str\nUrn of the destination of this relationship edge.\n\n\n\nproperty lastModified None | Dict[str, str]\nA generic properties bag that allows us to store specific information on this graph edge.\n\n\n\nproperty sourceUrn Aspect\nStores editable changes made to properties. This separates changes made from\ningestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines\n\nParameters AuditStampClass\nAn AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.\n\n\n\nproperty deleted None | str\nEdited documentation of the chart\n\n\n\nproperty lastModified Aspect\nEditable information about an Asset Container as defined on the DataHub Platform\n\nParameters None | str\nDescription of the Asset Container as its received on the DataHub Platform\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableDashboardPropertiesClass(created=None, lastModified=None, deleted=None, description=None)\nBases\n\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ndescription (Optional[str])\n\n\n\n\n\nproperty created None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty description AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableDataFlowPropertiesClass(created=None, lastModified=None, deleted=None, description=None)\nBases\n\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ndescription (Optional[str])\n\n\n\n\n\nproperty created None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty description AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableDataJobPropertiesClass(created=None, lastModified=None, deleted=None, description=None)\nBases\n\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ndescription (Optional[str])\n\n\n\n\n\nproperty created None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty description AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableDatasetPropertiesClass(created=None, lastModified=None, deleted=None, description=None, name=None)\nBases\n\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ndescription (Optional[str])\nname (Optional[str])\n\n\n\n\n\nproperty created None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty description AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\nproperty name Aspect\nEditableERModelRelationProperties stores editable changes made to erModelRelationship properties. This separates changes made from\ningestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines\n\nParameters AuditStampClass\nAn AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.\n\n\n\nproperty deleted None | str\nDocumentation of the erModelRelationship\n\n\n\nproperty lastModified None | str\nDisplay name of the ERModelRelation\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableMLFeaturePropertiesClass(description=None)\nBases\ndescription (Optional[str])\n\n\n\n\nproperty description Aspect\nProperties associated with a MLFeatureTable editable from the ui\n\nParameters None | str\nDocumentation of the MLFeatureTable\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableMLModelGroupPropertiesClass(description=None)\nBases\ndescription (Optional[str])\n\n\n\n\nproperty description Aspect\nProperties associated with a ML Model editable from the UI\n\nParameters None | str\nDocumentation of the ml model\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableMLPrimaryKeyPropertiesClass(description=None)\nBases\ndescription (Optional[str])\n\n\n\n\nproperty description Aspect\nStores editable changes made to properties. This separates changes made from\ningestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines\nNote\n\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ndescription (Optional[str])\n\n\n\n\n\nproperty created None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty description AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableSchemaFieldInfoClass(fieldPath, description=None, globalTags=None, glossaryTerms=None)\nBases\n\nfieldPath (str)\ndescription (Optional[str])\nglobalTags (Optional[GlobalTagsClass])\nglossaryTerms (Optional[GlossaryTermsClass])\n\n\n\n\n\nproperty description str\nFieldPath uniquely identifying the SchemaField this metadata is associated with\n\n\n\nproperty globalTags None | GlossaryTermsClass\nGlossary terms associated with the field\n\n\n\n\nclass datahub.metadata.schemaclasses.EditableSchemaMetadataClass(editableSchemaFieldInfo, created=None, lastModified=None, deleted=None)\nBases\n\neditableSchemaFieldInfo (List[EditableSchemaFieldInfoClass])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\n\n\n\n\n\nproperty created None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty editableSchemaFieldInfo AuditStampClass\nAn AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.\n\n\n\n\nclass datahub.metadata.schemaclasses.EmailNotificationSettingsClass(email)\nBases\nemail (str)\n\n\n\n\nproperty email Aspect\nInformation regarding rendering an embed for an asset.\n\nParameters None | str\nAn embed URL to be rendered inside of an iframe.\n\n\n\n\nclass datahub.metadata.schemaclasses.EntityChangeEventClass(entityType, entityUrn, category, operation, auditStamp, version, modifier=None, parameters=None)\nBases\n\nentityType (str)\nentityUrn (str)\ncategory (str)\noperation (str)\nauditStamp (AuditStampClass)\nversion (int)\nmodifier (Optional[str])\nparameters (Optional[ParametersClass])\n\n\n\n\n\nproperty auditStamp str\nThe category type (TAG, GLOSSARYTERM, OWNERSHIP, TECHNICALSCHEMA, etc). This is used to determine what the rest of the schema will look like.\n\n\n\nproperty entityType str\nThe urn of the entity which was affected.\n\n\n\nproperty modifier str\nThe operation type. This is used to determine what the rest of the schema will look like.\n\n\n\nproperty parameters int\nThe version of the event type, incremented in integers.\n\n\n\n\nclass datahub.metadata.schemaclasses.EntityTypeInfoClass(qualifiedName, displayName=None, description=None)\nBases\n\nqualifiedName (str)\ndisplayName (Optional[str])\ndescription (Optional[str])\n\n\n\n\n\nproperty description\nA description for the Entity Type\n\n\n\n\n\nproperty displayName str\nThe fully qualified name for the entity type, which usually consists of a namespace\nplus an identifier or name, e.g. datahub.dataset\n\n\n\n\nclass datahub.metadata.schemaclasses.EntityTypeKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\nEnum field type.\n\n\n\nclass datahub.metadata.schemaclasses.EspressoSchemaClass(documentSchema, tableSchema)\nBases\n\ndocumentSchema (str)\ntableSchema (str)\n\n\n\n\n\nproperty documentSchema str\nThe espresso table schema definition.\n\n\n\n\nclass datahub.metadata.schemaclasses.EthicalConsiderationsClass(data=None, humanLife=None, mitigations=None, risksAndHarms=None, useCases=None)\nBases\n\ndata (Optional[List[str]])\nhumanLife (Optional[List[str]])\nmitigations (Optional[List[str]])\nrisksAndHarms (Optional[List[str]])\nuseCases (Optional[List[str]])\n\n\n\n\n\nproperty data None | List[str]\nIs the MLModel intended to inform decisions about matters central to human life or flourishing - e.g., health or safety? Or could it be used in such a way?\n\n\n\nproperty mitigations None | List[str]\nWhat risks may be present in MLModel usage? Try to identify the potential recipients, likelihood, and magnitude of harms. If these cannot be determined, note that they were considered but remain unknown.\n\n\n\nproperty useCases Aspect\nAll referenced datasets would ideally point to any set of documents that provide visibility into the source and composition of the dataset.\n\nParameters List[BaseDataClass]\nDetails on the dataset(s) used for the quantitative analyses in the MLModel\n\n\n\n\nclass datahub.metadata.schemaclasses.ExecutionRequestInputClass(task, args, executorId, source, requestedAt, actorUrn=None)\nBases Determine who is responsible for emitting execution request success or failure. Executor?\n\nParameters None | str\nUrn of the actor who created this execution request.\n\n\n\nproperty args str\nspecify a specific executor to route the request to. If none is provided, a \u201cdefault\u201d executor is used.\n\nType int\nTime at which the execution request input was created\n\n\n\nproperty source str\nThe name of the task to execute, for example RUNINGEST\n\n\n\n\nclass datahub.metadata.schemaclasses.ExecutionRequestKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nThe result of an execution request\n\nParameters None | int\nDuration in milliseconds\n\n\n\nproperty report None | int\nTime at which the request was created\n\n\n\nproperty status None | StructuredExecutionReportClass\nA structured report if available.\n\n\n\n\nclass datahub.metadata.schemaclasses.ExecutionRequestSignalClass(signal, createdAt, executorId=None)\nBases\n\nsignal (str)\ncreatedAt (AuditStampClass)\nexecutorId (Optional[str])\n\n\n\n\n\nproperty createdAt None | str\nspecify a specific executor to route the request to. If none is provided, a \u201cdefault\u201d executor is used.\n\nType str\nThe signal to issue, e.g. KILL\n\n\n\n\nclass datahub.metadata.schemaclasses.ExecutionRequestSourceClass(type, ingestionSource=None)\nBases\n\ntype (str)\ningestionSource (Optional[str])\n\n\n\n\n\nproperty ingestionSource str\nThe type of the execution request source, e.g. INGESTIONSOURCE\n\n\n\n\nclass datahub.metadata.schemaclasses.FabricTypeClass\nBases DictWrapper\nAttributes defining a Field Assertion.\n\nParameters str\nThe entity targeted by this Field check.\n\n\n\nproperty fieldMetricAssertion None | FieldValuesAssertionClass\nThe definition of an assertion that validates individual values of a field / column for a set of rows.\nThis type of assertion verifies that each column value meets a particular requirement.\n\n\n\nproperty filter str | FieldAssertionTypeClass\nThe type of the field assertion being monitored.\n\n\n\n\nclass datahub.metadata.schemaclasses.FieldAssertionTypeClass\nBases DictWrapper\nInformation about the status of a particular prompt for a specific schema field\non an entity.\n\nParameters str\nThe field path on a schema field.\n\n\n\nproperty lastModified DictWrapper\nAttributes defining a field metric assertion, which asserts an expectation against\na common metric derived from the set of field / column values, for example\n\nfield (SchemaFieldSpecClass)\nmetric (Union[str, FieldMetricTypeClass])\noperator (Union[str, AssertionStdOperatorClass])\nparameters (Optional[AssertionStdParametersClass])\n\n\n\n\n\nproperty field str | FieldMetricTypeClass\nThe specific metric to assert against. This is the value that\nwill be obtained by applying a standard operation, such as an aggregation,\nto the selected field.\n\n\n\nproperty operator None | AssertionStdParametersClass\nStandard parameters required for the assertion. e.g. minvalue, maxvalue, value, columns\n\n\n\n\nclass datahub.metadata.schemaclasses.FieldMetricTypeClass\nBases DictWrapper\nDefinition of a transform applied to the values of a column / field.\nNote that the applicability of a field transform ultimately depends on the native type\nof the field / column.\nModel has single field to permit extension.\n\nParameters str | FieldTransformTypeClass\nThe type of the field transform, e.g. the transformation\nfunction / operator to apply.\n\n\n\n\nclass datahub.metadata.schemaclasses.FieldTransformTypeClass\nBases DictWrapper\nRecords field-level usage counts for a given resource\n\nParameters int\n\n\n\nproperty fieldName DictWrapper\nAttributes defining a field values assertion, which asserts that the values for a field / column\nof a dataset / table matches a set of expectations.\nIn other words, this type of assertion acts as a semantic constraint applied to fields for a specific column.\nTODO Determine whether we need an \u201coperator\u201d that can be applied to the field.\n\nParameters bool\nWhether to ignore or allow nulls when running the values assertion. (i.e.\nconsider only non-null values) using operators OTHER than the ISNULL operator.\nDefaults to true, allowing null values.\n\n\n\nproperty failThreshold SchemaFieldSpecClass\nThe field under evaluation\n\n\n\nproperty operator None | AssertionStdParametersClass\nStandard parameters required for the assertion. e.g. minvalue, maxvalue, value, columns\n\n\n\nproperty transform DictWrapper\n\nParameters str | FieldValuesFailThresholdTypeClass\nThe type of failure threshold. Either based on the number\nof column values (rows) that fail the expectations, or the percentage\nof the total rows under consideration.\n\n\n\nproperty value object\n\n\nCOUNT = 'COUNT'\n\n\n\nPERCENTAGE = 'PERCENTAGE'\n\n\n\n\nclass datahub.metadata.schemaclasses.FilterClass(or=None, criteria=None)\nBases\n\nor (Optional[List[ConjunctiveCriterionClass]])\ncriteria (Optional[List[CriterionClass]])\n\n\n\n\n\nproperty criteria None | List[ConjunctiveCriterionClass]\nA list of disjunctive criterion for the filter. (or operation to combine filters)\n\n\n\n\nclass datahub.metadata.schemaclasses.FineGrainedLineageClass(upstreamType, downstreamType, upstreams=None, downstreams=None, transformOperation=None, confidenceScore=None, query=None)\nBases\n\nupstreamType (Union[str, FineGrainedLineageUpstreamTypeClass])\ndownstreamType (Union[str, FineGrainedLineageDownstreamTypeClass])\nupstreams (Optional[List[str]])\ndownstreams (Optional[List[str]])\ntransformOperation (Optional[str])\nconfidenceScore (Optional[float])\nquery (Optional[str])\n\n\n\n\n\nproperty confidenceScore str | FineGrainedLineageDownstreamTypeClass\nThe type of downstream field(s)\n\n\n\nproperty downstreams None | str\nThe query that was used to generate this lineage.\nPresent only if the lineage was generated from a detected query.\n\n\n\nproperty transformOperation str | FineGrainedLineageUpstreamTypeClass\nThe type of upstream entity\n\n\n\nproperty upstreams object\nThe type of downstream field(s) in a fine-grained lineage\n\n\nFIELD = 'FIELD'\n\n\n\nFIELDSET = 'FIELDSET'\n\n\n\n\nclass datahub.metadata.schemaclasses.FineGrainedLineageUpstreamTypeClass\nBases DictWrapper\nAttributes defining a relative fixed interval SLA schedule.\n\nParameters int\nHow many units. Defaults to 1.\n\n\n\nproperty unit DictWrapper\nFixed field type.\n\n\n\nclass datahub.metadata.schemaclasses.ForeignKeyConstraintClass(name, foreignFields, sourceFields, foreignDataset)\nBases\n\nname (str)\nforeignFields (List[str])\nsourceFields (List[str])\nforeignDataset (str)\n\n\n\n\n\nproperty foreignDataset List[str]\nFields the constraint maps to on the foreign dataset\n\n\n\nproperty name List[str]\nFields the constraint maps to on the source dataset\n\n\n\n\nclass datahub.metadata.schemaclasses.ForeignKeySpecClass(foreignKey)\nBases\nforeignKey (Union[DatasetFieldForeignKeyClass, UrnForeignKeyClass])\n\n\n\n\nproperty foreignKey DictWrapper\n\nParameters None | List[str]\nSpecific set of groups that are targeted by this form assignment.\n\nType bool\nWhether the form should be assigned to the owners of assets that it is applied to.\nThis is the default.\n\n\n\nproperty users\nOptional\n\n\n\n\n\n\nclass datahub.metadata.schemaclasses.FormAssociationClass(urn, incompletePrompts=None, completedPrompts=None)\nBases\n\nurn (str)\nincompletePrompts (Optional[List[FormPromptAssociationClass]])\ncompletedPrompts (Optional[List[FormPromptAssociationClass]])\n\n\n\n\n\nproperty completedPrompts List[FormPromptAssociationClass]\nA list of prompts that are not yet complete for this form.\n\n\n\nproperty urn Aspect\nInformation about a form to help with filling out metadata on entities.\n\nParameters FormActorAssignmentClass\nWho the form is assigned to, e.g. who should see the form when visiting the entity page or governance center\n\n\n\nproperty description str\nDisplay name of the form\n\n\n\nproperty prompts str | FormTypeClass\nThe type of this form\n\n\n\n\nclass datahub.metadata.schemaclasses.FormKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\nInformation about the status of a particular prompt.\nNote that this is where we can add additional information about individual responses\n\nid (str)\nlastModified (AuditStampClass)\nfieldAssociations (Optional[FormPromptFieldAssociationsClass])\n\n\n\n\n\nproperty fieldAssociations str\nThe id for the prompt. This must be GLOBALLY UNIQUE.\n\n\n\nproperty lastModified DictWrapper\nA prompt to present to the user to encourage filling out metadata\n\nParameters None | str\nThe description of this prompt\n\n\n\nproperty id bool\nWhether the prompt is required to be completed, in order for the form to be marked as complete.\n\n\n\nproperty structuredPropertyParams str\nThe title of this prompt\n\n\n\nproperty type DictWrapper\nInformation about the field-level prompt associations on a top-level prompt association.\n\nParameters None | List[FieldFormPromptAssociationClass]\nA list of field-level prompt associations that are not yet complete for this form.\n\n\n\nproperty incompleteFieldPrompts object\n\n\nFIELDSSTRUCTUREDPROPERTY = 'FIELDSSTRUCTUREDPROPERTY'\n\n\n\nSTRUCTUREDPROPERTY = 'STRUCTUREDPROPERTY'\n\n\n\n\nclass datahub.metadata.schemaclasses.FormTypeClass\nBases DictWrapper\nAn association between a verification and an entity that has been granted\nvia completion of one or more forms of type \u2018VERIFICATION\u2019.\n\nParameters str\nThe urn of the form that granted this verification.\n\n\n\nproperty lastModified Aspect\nForms that are assigned to this entity to be filled out\n\nParameters List[FormAssociationClass]\nAll complete forms assigned to the entity.\n\n\n\nproperty incompleteForms List[FormVerificationAssociationClass]\nVerifications that have been applied to the entity via completed forms.\n\n\n\n\nclass datahub.metadata.schemaclasses.FreshnessAssertionInfoClass(type, entity, schedule, filter=None)\nBases\n\ntype (Union[str, FreshnessAssertionTypeClass])\nentity (str)\nschedule (FreshnessAssertionScheduleClass)\nfilter (Optional[DatasetFilterClass])\n\n\n\n\n\nproperty entity None | DatasetFilterClass\nA definition of the specific filters that should be applied, when performing monitoring.\nIf not provided, there is no filter, and the full table is under consideration.\n\n\n\nproperty schedule str | FreshnessAssertionTypeClass\nThe type of the freshness assertion being monitored.\n\n\n\n\nclass datahub.metadata.schemaclasses.FreshnessAssertionScheduleClass(type, cron=None, fixedInterval=None)\nBases\n\ntype (Union[str, FreshnessAssertionScheduleTypeClass])\ncron (Optional[FreshnessCronScheduleClass])\nfixedInterval (Optional[FixedIntervalScheduleClass])\n\n\n\n\n\nproperty cron None | FixedIntervalScheduleClass\nA fixed interval schedule. This field is required when type is FIXEDINTERVAL.\n\n\n\nproperty type object\n\n\nCRON = 'CRON'\n\n\n\nFIXEDINTERVAL = 'FIXEDINTERVAL'\n\n\n\nSINCETHELASTCHECK = 'SINCETHELASTCHECK'\n\n\n\n\nclass datahub.metadata.schemaclasses.FreshnessAssertionTypeClass\nBases DictWrapper\nA contract pertaining to the operational SLAs of a physical data asset\n\nParameters str\nThe assertion representing the SLA contract.\n\n\n\n\nclass datahub.metadata.schemaclasses.FreshnessCronScheduleClass(cron, timezone, windowStartOffsetMs=None)\nBases\n\ncron (str)\ntimezone (str)\nwindowStartOffsetMs (Optional[int])\n\n\n\n\n\nproperty cron str\nTimezone in which the cron interval applies, e.g. America/Los Angeles\n\n\n\nproperty windowStartOffsetMs DictWrapper\nGeneric record structure for serializing an Aspect\n\nParameters str\nThe content type, which represents the fashion in which the aspect was serialized.\nThe only type currently supported is application/json.\n\n\n\nproperty value DictWrapper\nGeneric payload record structure for serializing a Platform Event.\n\nParameters str\nThe content type, which represents the fashion in which the event was serialized.\nThe only type currently supported is application/json.\n\n\n\nproperty value Aspect\nDataHub Global platform settings. Careful - these should not be modified by the outside world!\n\nParameters DocPropagationFeatureSettingsClass | None\nSettings related to the documentation propagation feature\n\n\n\nproperty sso None | GlobalViewsSettingsClass\nSettings related to the Views Feature\n\n\n\n\nclass datahub.metadata.schemaclasses.GlobalSettingsKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty idglobalSettings\nId for the settings. There should be only 1 global settings urn\n\nType Aspect\nTag aspect used for applying tags to an entity\n\nParameters List[TagAssociationClass]\nTags associated with a given entity\n\n\n\n\nclass datahub.metadata.schemaclasses.GlobalViewsSettingsClass(defaultView=None)\nBases\ndefaultView (Optional[str])\n\n\n\n\nproperty defaultView Aspect\nProperties associated with a GlossaryNode\n\nParameters Dict[str, str]\nCustom property bag.\n\n\n\nproperty definition None | str\nOptional id for the GlossaryNode\n\n\n\nproperty name None | str\nParent node of the glossary term\n\n\n\n\nclass datahub.metadata.schemaclasses.GlossaryNodeKeyClass(name)\nBases\nname (str)\n\n\n\n\nproperty name DictWrapper\nA metadata snapshot for a specific GlossaryNode entity.\n\nParameters List[GlossaryNodeKeyClass | GlossaryNodeInfoClass | OwnershipClass | StatusClass]\nThe list of metadata aspects associated with the GlossaryNode. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nHas A / Is A lineage information about a glossary Term reporting the lineage\n\nParameters None | List[str]\nThe relationship Has A with glossary term\n\n\n\nproperty isRelatedTerms None | List[str]\nThe relationship isRelatedTo with glossary term\n\n\n\nproperty values DictWrapper\nProperties of an applied glossary term.\n\nParameters None | str\nThe user URN which will be credited for adding associating this term to the entity\n\n\n\nproperty attribution None | str\nAdditional context about the association\n\n\n\nproperty urn Aspect\nProperties associated with a GlossaryTerm\n\nParameters Dict[str, str]\nCustom property bag.\n\n\n\nproperty definition None | str\nOptional id for the term\n\n\n\nproperty name None | str\nParent node of the glossary term\n\n\n\nproperty rawSchema None | str\nExternal Reference to the business-term\n\n\n\nproperty sourceUrl\nThe abstracted URL such as https\n\n\n\n\n\nproperty termSource Aspect\nKey for a GlossaryTerm\n\nParameters str\nThe term name, which serves as a unique id\n\n\n\n\nclass datahub.metadata.schemaclasses.GlossaryTermSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[GlossaryTermKeyClass, GlossaryTermInfoClass, OwnershipClass, StatusClass, BrowsePathsClass, GlossaryRelatedTermsClass]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.GlossaryTermsClass(terms, auditStamp)\nBases\n\nterms (List[GlossaryTermAssociationClass])\nauditStamp (AuditStampClass)\n\n\n\n\n\nproperty auditStamp List[GlossaryTermAssociationClass]\nThe related business terms\n\n\n\n\nclass datahub.metadata.schemaclasses.GroupMembershipClass(groups)\nBases\ngroups (List[str])\n\n\n\n\nproperty groups DictWrapper\n\nParameters List[str]\n\n\n\nproperty heights Aspect\nIceberg Catalog metadata associated with an Iceberg table/view\n\nParameters None | str\nWhen Datahub is the REST Catalog for an Iceberg Table, stores the current metadata pointer.\nIf the Iceberg table is managed by an external catalog, the metadata pointer is not set.\n\n\n\nproperty view Aspect\nAn Iceberg warehouse location and credentails whose read/writes are governed by datahub catalog.\n\nParameters str\nclientId to be used to authenticate with storage hosting this warehouse\n\n\n\nproperty clientSecret str\nPath of the root for the backing store of the tables in the warehouse.\n\n\n\nproperty env str\nregion where the warehouse is located.\n\n\n\nproperty role None | int\n\n\n\n\nclass datahub.metadata.schemaclasses.IconLibraryClass\nBases DictWrapper\nProperties describing an icon associated with an entity\n\nParameters str | IconLibraryClass\ne.g. Antd, Material, etc\n\nType str\nThe name of the icon\n\n\n\nproperty style DictWrapper\nThe incident assignee type.\nThis is in a record so that we can add additional fields if we need to later (e.g.\nthe type of the assignee.\n\nParameters str\nThe user or group assigned to the incident.\n\n\n\nproperty assignedAt Aspect\nInformation about an incident raised on an asset.\n\nParameters None | List[IncidentAssigneeClass]\nThe parties assigned with resolving the incident\n\n\n\nproperty created None | str\nAn optional custom incident type. Present only if type is \u2018CUSTOM\u2019.\n\n\n\nproperty description List[str]\nA reference to the entity associated with the incident.\n\n\n\nproperty priority 0 - CRITICAL, 1 - HIGH, 2 - MED, 3 - LOW\n(We probably should have modeled as an enum)\n\n\n\nproperty source None | int\nThe time at which the incident actually started (may be before the date it was raised).\n\n\n\nproperty status None | str\nOptional title associated with the incident\n\n\n\nproperty type Aspect\nKey for an asset Incident\n\nParameters str\nA unique id for the incident. Generated on the server side at incident creation time.\n\n\n\n\nclass datahub.metadata.schemaclasses.IncidentSourceClass(type, sourceUrn=None)\nBases\n\ntype (Union[str, IncidentSourceTypeClass])\nsourceUrn (Optional[str])\n\n\n\n\n\nproperty sourceUrn str | IncidentSourceTypeClass\nMessage associated with the incident\n\n\n\n\nclass datahub.metadata.schemaclasses.IncidentSourceTypeClass\nBases object\n\n\nFIXED = 'FIXED'\n\n\n\nINVESTIGATION = 'INVESTIGATION'\n\n\n\nNOACTIONREQUIRED = 'NOACTIONREQUIRED'\n\n\n\nTRIAGE = 'TRIAGE'\n\n\n\nWORKINPROGRESS = 'WORKINPROGRESS'\n\n\n\n\nclass datahub.metadata.schemaclasses.IncidentStateClass\nBases DictWrapper\nInformation about an incident raised on an asset\n\nParameters AuditStampClass\nThe time at which the request was initially created\n\n\n\nproperty message None | str | IncidentStageClass\nThe lifecycle stage for the incident - Null means no stage was assigned yet.\nIn the future, we may add CUSTOM here with a customStage string field for user-defined stages.\n\n\n\nproperty state DictWrapper\nSummary statistics about incidents on an entity.\n\nParameters int\nThe time at which the incident was raised in milliseconds since epoch.\n\n\n\nproperty priority None | int\nThe time at which the incident was marked as resolved in milliseconds since epoch. Null if the incident is still active.\n\n\n\nproperty type str\nThe urn of the incident\n\n\n\n\nclass datahub.metadata.schemaclasses.IncidentTypeClass\nBases Aspect\nSummary related incidents on an entity.\n\nParameters List[IncidentSummaryDetailsClass]\nSummary details about the set of active incidents\n\n\n\nproperty activeIncidents List[IncidentSummaryDetailsClass]\nSummary details about the set of resolved incidents\n\n\n\nproperty resolvedIncidents DictWrapper\nThe definition of the transformer function that should be applied to a given field / column value in a dataset\nin order to determine the segment or bucket that it belongs to, which in turn is used to evaluate\nvolume assertions.\n\nParameters None | str\nThe \u2018native\u2019 transformer type, useful as a back door if a custom operator is required.\nThis field is required if the type is NATIVE.\n\n\n\nproperty type object\n\n\nCEILING = 'CEILING'\n\n\n\nFLOOR = 'FLOOR'\n\n\n\nNATIVE = 'NATIVE'\n\n\n\nTIMESTAMPMSTODATE = 'TIMESTAMPMSTODATE'\n\n\n\nTIMESTAMPMSTOHOUR = 'TIMESTAMPMSTOHOUR'\n\n\n\nTIMESTAMPMSTOMINUTE = 'TIMESTAMPMSTOMINUTE'\n\n\n\nTIMESTAMPMSTOMONTH = 'TIMESTAMPMSTOMONTH'\n\n\n\nTIMESTAMPMSTOYEAR = 'TIMESTAMPMSTOYEAR'\n\n\n\n\nclass datahub.metadata.schemaclasses.IncrementingSegmentRowCountChangeClass(segment, type, operator, parameters)\nBases\n\nsegment (IncrementingSegmentSpecClass)\ntype (Union[str, AssertionValueChangeTypeClass])\noperator (Union[str, AssertionStdOperatorClass])\nparameters (AssertionStdParametersClass)\n\n\n\n\n\nproperty operator\nGREATERTHAN, GREATERTHANOREQUALTO, EQUALTO, LESSTHAN, LESSTHANOREQUALTO,\nBETWEEN.\n\n\n\nproperty parameters NUMBER.\n\n\n\nproperty segment str | AssertionValueChangeTypeClass\na fixed absolute value or a relative percentage.\n\nType DictWrapper\nAttributes defining an INCREMENTINGSEGMENTROWCOUNTTOTAL volume assertion.\n\nParameters str | AssertionStdOperatorClass\nThe operator you\u2019d like to apply.\nNote that only numeric operators are valid inputs AssertionStdParametersClass\nThe parameters you\u2019d like to provide as input to the operator.\nNote that only numeric parameter types are valid inputs IncrementingSegmentSpecClass\nA specification of how the \u2018segment\u2019 can be derived using a column and an optional transformer function.\n\n\n\n\nclass datahub.metadata.schemaclasses.IncrementingSegmentSpecClass(field, transformer=None)\nBases\n\n\nA field or column that represents the incrementing value. New rows that are inserted will be identified using this column.\nNote that the value of this column may not by itself represent the \u201cbucket\u201d or the \u201csegment\u201d in which the row falls.\n[Optional] An transformer function that may be applied to the selected column value in order\nto obtain the final \u201csegment identifier\u201d or \u201cbucket identifier\u201d. Rows that have the same value after applying the transformation\nwill be grouped into the same segment, using which the final value (e.g. row count) will be determined.\n\n\n\nParameters SchemaFieldSpecClass\nThe field to use to generate segments. It must be constantly incrementing as new rows are inserted.\n\n\n\nproperty transformer DictWrapper\nThe checkpoint state object of a datahub ingestion run for a given job.\n\nParameters str\nThe version of the state format.\n\n\n\nproperty payload str\nThe serialization/deserialization protocol.\n\n\n\n\nclass datahub.metadata.schemaclasses.InputFieldClass(schemaFieldUrn, schemaField=None)\nBases\n\nschemaFieldUrn (str)\nschemaField (Optional[SchemaFieldClass])\n\n\n\n\n\nproperty schemaField str\nUrn of the schema being referenced for lineage purposes\n\n\n\n\nclass datahub.metadata.schemaclasses.InputFieldsClass(fields)\nBases\nfields (List[InputFieldClass])\n\n\n\n\nproperty fields Aspect\nInstitutional memory of an entity. This is a way to link to relevant documentation and provide description of the documentation. Institutional or tribal knowledge is very important for users to leverage the entity.\n\nParameters List[InstitutionalMemoryMetadataClass]\nList of records that represent institutional memory of an entity. Each record consists of a link, description, creator and timestamps associated with that record.\n\n\n\n\nclass datahub.metadata.schemaclasses.InstitutionalMemoryMetadataClass(url, description, createStamp)\nBases\n\nurl (str)\ndescription (str)\ncreateStamp (AuditStampClass)\n\n\n\n\n\nproperty createStamp str\nDescription of the link.\n\n\n\nproperty url Aspect\nIntended Use for the ML Model\n\nParameters None | List[str]\nHighlight technology that the MLModel might easily be confused with, or related contexts that users could try to apply the MLModel to.\n\n\n\nproperty primaryUsers None | List[str]\nPrimary Use cases for the MLModel.\n\n\n\n\nclass datahub.metadata.schemaclasses.IntendedUserTypeClass\nBases Aspect\nAspect used to store invite tokens.\n\nParameters None | str\nThe role that this invite token may be associated with\n\n\n\nproperty token Aspect\nKey for an InviteToken.\n\nParameters str\nA unique id for the invite token.\n\n\n\n\nclass datahub.metadata.schemaclasses.JobStatusClass\nBases DictWrapper\nThis header records information about the context of an event as it is emitted into kafka and is intended to be used by the kafka audit application. For more information see go/kafkaauditheader\n\nParameters str\nThe name of the application from which the event is being emitted. see go/appname\n\n\n\nproperty auditVersion\nThe version that is being used for auditing. In version 0, the audit trail buckets events into 10 minute audit windows based on the EventHeader timestamp. In version 1, the audit trail buckets events as follows\n\n\n\n\n\nproperty clusterConnectionString None | str\nfabric\nThe fabricUrn of the host from which the event is being emitted. Fabric Urn in the format of urn\n\nType None | str\nThe instance on the server from which the event is being emitted. e.g. i001\n\n\n\nproperty messageId str\nThe fully qualified name of the host from which the event is being emitted.\n\n\n\nproperty time DictWrapper\nSchema holder for kafka schema.\n\nParameters str\nThe native kafka document schema. This is a human readable avro document schema.\n\n\n\nproperty documentSchemaType None | str\nThe native kafka key schema as retrieved from Schema Registry\n\n\n\nproperty keySchemaType DictWrapper\nSchema text of a key-value store schema.\n\nParameters str\nThe raw schema for the key in the key-value store.\n\n\n\nproperty valueSchema object\nMLFeature Data Type\n\n\nAUDIO = 'AUDIO'\n\n\n\nBINARY = 'BINARY'\n\n\n\nBYTE = 'BYTE'\n\n\n\nCONTINUOUS = 'CONTINUOUS'\n\n\n\nCOUNT = 'COUNT'\n\n\n\nIMAGE = 'IMAGE'\n\n\n\nINTERVAL = 'INTERVAL'\n\n\n\nMAP = 'MAP'\n\n\n\nNOMINAL = 'NOMINAL'\n\n\n\nORDINAL = 'ORDINAL'\n\n\n\nSEQUENCE = 'SEQUENCE'\n\n\n\nSET = 'SET'\n\n\n\nTEXT = 'TEXT'\n\n\n\nTIME = 'TIME'\n\n\n\nUNKNOWN = 'UNKNOWN'\n\n\n\nUSELESS = 'USELESS'\n\n\n\nVIDEO = 'VIDEO'\n\n\n\n\nclass datahub.metadata.schemaclasses.MLFeatureKeyClass(featureNamespace, name)\nBases\n\nfeatureNamespace (str)\nname (str)\n\n\n\n\n\nproperty featureNamespace str\nName of the feature\n\n\n\n\nclass datahub.metadata.schemaclasses.MLFeaturePropertiesClass(customProperties=None, description=None, dataType=None, version=None, sources=None)\nBases\n\ncustomProperties (Optional[Dict[str, str]])\ndescription (Optional[str])\ndataType (Union[None, str, MLFeatureDataTypeClass])\nversion (Optional[VersionTagClass])\nsources (Optional[List[str]])\n\n\n\n\n\nproperty customProperties None | str | MLFeatureDataTypeClass\nData Type of the MLFeature\n\n\n\nproperty description None | List[str]\nSource of the MLFeature\n\n\n\nproperty version DictWrapper\n\nParameters List[MLFeatureKeyClass | MLFeaturePropertiesClass | OwnershipClass | InstitutionalMemoryClass | StatusClass | DeprecationClass | BrowsePathsClass | GlobalTagsClass | DataPlatformInstanceClass | BrowsePathsV2Class]\nThe list of metadata aspects associated with the MLFeature. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nKey for an MLFeatureTable\n\nParameters str\nName of the feature table\n\n\n\nproperty platform Aspect\nProperties associated with a MLFeatureTable\n\nParameters Dict[str, str]\nCustom property bag.\n\n\n\nproperty description None | List[str]\nList of features contained in the feature table\n\n\n\nproperty mlPrimaryKeys DictWrapper\n\nParameters List[MLFeatureTableKeyClass | MLFeatureTablePropertiesClass | OwnershipClass | InstitutionalMemoryClass | StatusClass | DeprecationClass | BrowsePathsClass | GlobalTagsClass | DataPlatformInstanceClass | BrowsePathsV2Class]\nThe list of metadata aspects associated with the MLFeatureTable. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nProperties associated with an ML Hyper Param\n\nParameters None | int\nDate when the MLHyperParam was developed\n\n\n\nproperty description str\nName of the MLHyperParam\n\n\n\nproperty value Aspect\nProperties associated with an ML Metric\n\nParameters None | int\nDate when the mlMetric was developed\n\n\n\nproperty description str\nName of the mlMetric\n\n\n\nproperty value Aspect\nKey for an ML model deployment\n\nParameters str\nName of the MLModelDeployment\n\n\n\nproperty origin str\nStandardized platform urn for the model Deployment\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelDeploymentPropertiesClass(customProperties=None, externalUrl=None, description=None, createdAt=None, version=None, status=None)\nBases\n\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\ndescription (Optional[str])\ncreatedAt (Optional[int])\nversion (Optional[VersionTagClass])\nstatus (Union[None, str, DeploymentStatusClass])\n\n\n\n\n\nproperty createdAt Dict[str, str]\nCustom property bag.\n\n\n\nproperty description None | str\nURL where the reference exist\n\n\n\nproperty status None | VersionTagClass\nVersion of the MLModelDeployment\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelDeploymentSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[MLModelDeploymentKeyClass, MLModelDeploymentPropertiesClass, OwnershipClass, StatusClass, DeprecationClass, GlobalTagsClass, DataPlatformInstanceClass]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelFactorPromptsClass(relevantFactors=None, evaluationFactors=None)\nBases\n\nrelevantFactors (Optional[List[MLModelFactorsClass]])\nevaluationFactors (Optional[List[MLModelFactorsClass]])\n\n\n\n\n\nproperty evaluationFactors None | List[MLModelFactorsClass]\nWhat are foreseeable salient factors for which MLModel performance may vary, and how were these determined?\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelFactorsClass(groups=None, instrumentation=None, environment=None)\nBases\n\ngroups (Optional[List[str]])\ninstrumentation (Optional[List[str]])\nenvironment (Optional[List[str]])\n\n\n\n\n\nproperty environment None | List[str]\nGroups refers to distinct categories with similar characteristics that are present in the evaluation data instances.\nFor human-centric machine learning MLModels, groups are people who share one or multiple characteristics.\n\n\n\nproperty instrumentation Aspect\nKey for an ML model group\n\nParameters str\nName of the MLModelGroup\n\n\n\nproperty origin str\nStandardized platform urn for the model group\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelGroupPropertiesClass(customProperties=None, trainingJobs=None, downstreamJobs=None, externalUrl=None, name=None, description=None, createdAt=None, created=None, lastModified=None, version=None)\nBases\n\ncustomProperties (Optional[Dict[str, str]])\ntrainingJobs (Optional[List[str]])\ndownstreamJobs (Optional[List[str]])\nexternalUrl (Optional[str])\nname (Optional[str])\ndescription (Optional[str])\ncreatedAt (Optional[int])\ncreated (Optional[TimeStampClass])\nlastModified (Optional[TimeStampClass])\nversion (Optional[VersionTagClass])\n\n\n\n\n\nproperty created None | int\nDate when the MLModelGroup was developed\n\n\n\nproperty customProperties None | str\nDocumentation of the MLModelGroup\n\n\n\nproperty downstreamJobs None | str\nURL where the reference exist\n\n\n\nproperty lastModified None | str\nDisplay name of the MLModelGroup\n\n\n\nproperty trainingJobs None | VersionTagClass\nVersion of the MLModelGroup\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelGroupSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[MLModelGroupKeyClass, MLModelGroupPropertiesClass, OwnershipClass, StatusClass, DeprecationClass, BrowsePathsClass, GlobalTagsClass, DataPlatformInstanceClass, BrowsePathsV2Class]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.MLModelKeyClass(platform, name, origin)\nBases\n\nplatform (str)\nname (str)\norigin (Union[str, FabricTypeClass])\n\n\n\n\n\nproperty name str | FabricTypeClass\nFabric type where model belongs to or where it was generated\n\n\n\nproperty platform Aspect\nProperties associated with a ML Model\n\nParameters None | TimeStampClass\nAudit stamp containing who created this and when\n\n\n\nproperty customProperties None | int\nDate when the MLModel was developed\n\n\n\nproperty deployments None | str\nDocumentation of the MLModel\n\n\n\nproperty downstreamJobs None | str\nURL where the reference exist\n\n\n\nproperty groups None | Dict[str, str | int | float | bool]\nHyper Parameters of the MLModel\nNOTE None | List[MLHyperParamClass]\nHyperparameters of the MLModel\n\n\n\nproperty lastModified None | List[str]\nList of features used for MLModel training\n\n\n\nproperty name None | List[MLMetricClass]\nMetrics of the MLModel used in production\n\n\n\nproperty tags None | List[str]\nList of jobs or process instances (if any) used to train the model or group. Visible in Lineage. Note that ML Models can also be specified as the output of a specific Data Process Instances (runs) via the DataProcessInstanceOutputs aspect.\n\n\n\nproperty trainingMetrics None | str\nType of Algorithm or MLModel such as whether it is a Naive Bayes classifier, Convolutional Neural Network, etc\n\n\n\nproperty version DictWrapper\nMLModel Snapshot entity details.\n\nParameters List[MLModelKeyClass | OwnershipClass | MLModelPropertiesClass | IntendedUseClass | MLModelFactorPromptsClass | MetricsClass | EvaluationDataClass | TrainingDataClass | QuantitativeAnalysesClass | EthicalConsiderationsClass | CaveatsAndRecommendationsClass | InstitutionalMemoryClass | SourceCodeClass | StatusClass | CostClass | DeprecationClass | BrowsePathsClass | GlobalTagsClass | DataPlatformInstanceClass | BrowsePathsV2Class]\nThe list of metadata aspects associated with the MLModel. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn Aspect\nKey for an MLPrimaryKey\n\nParameters str\nNamespace for the primary key\n\n\n\nproperty name Aspect\nProperties associated with a MLPrimaryKey\n\nParameters Dict[str, str]\nCustom property bag.\n\n\n\nproperty dataType None | str\nDocumentation of the MLPrimaryKey\n\n\n\nproperty sources None | VersionTagClass\nVersion of the MLPrimaryKey\n\n\n\n\nclass datahub.metadata.schemaclasses.MLPrimaryKeySnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[MLPrimaryKeyKeyClass, MLPrimaryKeyPropertiesClass, OwnershipClass, InstitutionalMemoryClass, StatusClass, DeprecationClass, GlobalTagsClass, DataPlatformInstanceClass]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.MLTrainingRunPropertiesClass(customProperties=None, externalUrl=None, id=None, outputUrls=None, hyperParams=None, trainingMetrics=None)\nBases\n\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\nid (Optional[str])\noutputUrls (Optional[List[str]])\nhyperParams (Optional[List[MLHyperParamClass]])\ntrainingMetrics (Optional[List[MLMetricClass]])\n\n\n\n\n\nproperty customProperties None | str\nURL where the reference exist\n\n\n\nproperty hyperParams None | str\nRun Id of the ML Training Run\n\n\n\nproperty outputUrls None | List[MLMetricClass]\nMetrics of the ML Training Run\n\n\n\n\nclass datahub.metadata.schemaclasses.MapTypeClass(keyType=None, valueType=None)\nBases\n\nkeyType (Optional[str])\nvalueType (Optional[str])\n\n\n\n\n\nproperty keyType None | str\nType of the value in a map\n\n\n\n\nclass datahub.metadata.schemaclasses.MediaClass(type, location)\nBases\n\ntype (Union[str, MediaTypeClass])\nlocation (str)\n\n\n\n\n\nproperty location str | MediaTypeClass\nType of content the Media is storing, e.g. image, video, etc.\n\n\n\n\nclass datahub.metadata.schemaclasses.MediaTypeClass\nBases DictWrapper\nInformation about who, why, and how this metadata was applied\n\nParameters str\nThe entity (e.g. a member URN) responsible for applying the assocated metadata. This can\neither be a user (in case of UI edits) or the datahub system for automation.\n\n\n\nproperty source Dict[str, str]\nThe details associated with why this metadata was applied. For example, this could include\nthe actual regex rule, sql statement, ingestion pipeline ID, etc.\n\n\n\nproperty time DictWrapper\nKafka event for proposing a metadata change for an entity. A corresponding MetadataAuditEvent is emitted when the change is accepted and committed, otherwise a FailedMetadataChangeEvent will be emitted instead.\n\nParameters None | KafkaAuditHeaderClass\nKafka audit header. See go/kafkaauditheader for more info.\n\n\n\nproperty proposedDelta ChartSnapshotClass | CorpGroupSnapshotClass | CorpUserSnapshotClass | DashboardSnapshotClass | DataFlowSnapshotClass | DataJobSnapshotClass | DatasetSnapshotClass | DataProcessSnapshotClass | DataPlatformSnapshotClass | MLModelSnapshotClass | MLPrimaryKeySnapshotClass | MLFeatureSnapshotClass | MLFeatureTableSnapshotClass | MLModelDeploymentSnapshotClass | MLModelGroupSnapshotClass | TagSnapshotClass | GlossaryTermSnapshotClass | GlossaryNodeSnapshotClass | DataHubPolicySnapshotClass | SchemaFieldSnapshotClass | DataHubRetentionSnapshotClass\nSnapshot of the proposed metadata change. Include only the aspects affected by the change in the snapshot.\n\n\n\nproperty systemMetadata DictWrapper\nKafka event for capturing update made to an entity\u2019s metadata.\n\nParameters None | GenericAspectClass\nThe value of the new aspect.\n\n\n\nproperty aspectName This is only valid for CREATE, UPSERT, and DELETE operations.\n\n\n\nproperty auditHeader str | ChangeTypeClass\nType of change being proposed\n\n\n\nproperty created None | GenericAspectClass\nKey aspect of the entity being written\n\n\n\nproperty entityType None | str\nUrn of the entity being written\n\n\n\nproperty headers None | GenericAspectClass\nThe previous value of the aspect that has changed.\n\n\n\nproperty previousSystemMetadata None | SystemMetadataClass\nSystem properties that one might want to attach to an event\n\n\n\n\nclass datahub.metadata.schemaclasses.MetadataChangeProposalClass(entityType, changeType, auditHeader=None, entityUrn=None, entityKeyAspect=None, aspectName=None, aspect=None, systemMetadata=None, headers=None)\nBases\n\nentityType (str)\nchangeType (Union[str, ChangeTypeClass])\nauditHeader (Optional[KafkaAuditHeaderClass])\nentityUrn (Optional[str])\nentityKeyAspect (Optional[GenericAspectClass])\naspectName (Optional[str])\naspect (Optional[GenericAspectClass])\nsystemMetadata (Optional[SystemMetadataClass])\nheaders (Optional[Dict[str, str]])\n\n\n\n\n\nproperty aspect None | str\nAspect of the entity being written to\nNot filling this out implies that the writer wants to affect the entire entity\nNote None | KafkaAuditHeaderClass\nKafka audit header. Currently remains unused in the open source.\n\n\n\nproperty changeType None | GenericAspectClass\nKey aspect of the entity being written\n\n\n\nproperty entityType None | str\nUrn of the entity being written\n\n\n\nproperty headers None | SystemMetadataClass\nSystem properties that one might want to attach to an event\n\n\n\n\nclass datahub.metadata.schemaclasses.MetricsClass(performanceMeasures=None, decisionThreshold=None)\nBases\n\nperformanceMeasures (Optional[List[str]])\ndecisionThreshold (Optional[List[str]])\n\n\n\n\n\nproperty decisionThreshold None | List[str]\nMeasures of MLModel performance\n\n\n\n\nclass datahub.metadata.schemaclasses.MySqlDDLClass(tableSchema)\nBases\ntableSchema (str)\n\n\n\n\nproperty tableSchema Aspect\nCarries information about the native CorpGroups a user is in.\n\nParameters List[str]\n\n\n\n\nclass datahub.metadata.schemaclasses.NotebookCellClass(type, textCell=None, queryCell=None, chartCell=None)\nBases\n\ntype (Union[str, NotebookCellTypeClass])\ntextCell (Optional[TextCellClass])\nqueryCell (Optional[QueryCellClass])\nchartCell (Optional[ChartCellClass])\n\n\n\n\n\nproperty chartCell None | QueryCellClass\nThe query cell content. The will be non-null only when all other cell field is null.\n\n\n\nproperty textCell str | NotebookCellTypeClass\nThe type of this Notebook cell\n\n\n\n\nclass datahub.metadata.schemaclasses.NotebookCellTypeClass\nBases Aspect\nContent in a Notebook\nNote\ncells (Optional[List[NotebookCellClass]])\n\n\n\n\nproperty cells Aspect\nInformation about a Notebook\nNote\n\ntitle (str)\nchangeAuditStamps (ChangeAuditStampsClass)\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\ndescription (Optional[str])\n\n\n\n\n\nproperty changeAuditStamps Dict[str, str]\nCustom property bag.\n\n\n\nproperty description None | str\nURL where the reference exist\n\n\n\nproperty title Aspect\nKey for a Notebook\n\nParameters str\nUnique id for the Notebook. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as \u2018querybook.com/notebook/773\u2019\n\n\n\nproperty notebookTool DictWrapper\nNotification settings for an actor or subscription.\n\nParameters None | EmailNotificationSettingsClass\nEmail Notification Settings\n\n\n\nproperty sinkTypes None | SlackNotificationSettingsClass\nSlack Notification Settings\n\n\n\n\nclass datahub.metadata.schemaclasses.NotificationSinkTypeClass\nBases DictWrapper\nNull field type.\n\n\n\nclass datahub.metadata.schemaclasses.NumberTypeClass\nBases long, integer, short, etc..\n\n\n\nclass datahub.metadata.schemaclasses.OidcSettingsClass(enabled, clientId, clientSecret, discoveryUri, userNameClaim=None, userNameClaimRegex=None, scope=None, clientAuthenticationMethod=None, jitProvisioningEnabled=None, preProvisioningRequired=None, extractGroupsEnabled=None, groupsClaim=None, responseType=None, responseMode=None, useNonce=None, readTimeout=None, extractJwtAccessTokenClaims=None, preferredJwsAlgorithm=None, preferredJwsAlgorithm2=None)\nBases\n\nenabled (bool)\nclientId (str)\nclientSecret (str)\ndiscoveryUri (str)\nuserNameClaim (Optional[str])\nuserNameClaimRegex (Optional[str])\nscope (Optional[str])\nclientAuthenticationMethod (Optional[str])\njitProvisioningEnabled (Optional[bool])\npreProvisioningRequired (Optional[bool])\nextractGroupsEnabled (Optional[bool])\ngroupsClaim (Optional[str])\nresponseType (Optional[str])\nresponseMode (Optional[str])\nuseNonce (Optional[bool])\nreadTimeout (Optional[int])\nextractJwtAccessTokenClaims (Optional[bool])\npreferredJwsAlgorithm (Optional[str])\npreferredJwsAlgorithm2 (Optional[str])\n\n\n\n\n\nproperty clientAuthenticationMethod\nADVANCED. Which authentication method to use to pass credentials (clientId and clientSecret) to the token endpoint\n\n\n\n\n\nproperty clientId str\nUnique client secret issued by the identity provider.\n\n\n\nproperty discoveryUri bool\nWhether OIDC SSO is enabled.\n\n\n\nproperty extractGroupsEnabled None | bool\nADVANCED. Whether to extract claims from JWT access token. Defaults to false.\n\n\n\nproperty groupsClaim None | bool\nADVANCED. Whether DataHub users should be provisioned on login if they do not exist. Defaults to true.\n\n\n\nproperty preProvisioningRequired None | str\nADVANCED. Which jws algorithm to use. Unused.\n\n\n\nproperty preferredJwsAlgorithm2 None | int\nADVANCED. Read timeout.\n\n\n\nproperty responseMode None | str\nADVANCED. Response type.\n\n\n\nproperty scope None | bool\nADVANCED. Use Nonce.\n\n\n\nproperty userNameClaim None | str\nADVANCED. TThe regex used to parse the DataHub username from the user name claim. Defaults to (.*) (all).\n\n\n\n\nclass datahub.metadata.schemaclasses.OperationClass(timestampMillis, operationType, lastUpdatedTimestamp, eventGranularity=None, partitionSpec=None, messageId=None, actor=None, customOperationType=None, numAffectedRows=None, affectedDatasets=None, sourceType=None, customProperties=None)\nBases\n\ntimestampMillis (int)\noperationType (Union[str, OperationTypeClass])\nlastUpdatedTimestamp (int)\neventGranularity (Optional[TimeWindowSizeClass])\npartitionSpec (Optional[PartitionSpecClass])\nmessageId (Optional[str])\nactor (Optional[str])\ncustomOperationType (Optional[str])\nnumAffectedRows (Optional[int])\naffectedDatasets (Optional[List[str]])\nsourceType (Union[None, str, OperationSourceTypeClass])\ncustomProperties (Optional[Dict[str, str]])\n\n\n\n\n\nASPECTTYPE None | str\nActor who issued this operation.\n\n\n\nproperty affectedDatasets None | str\nA custom type of operation. Required if operationType is CUSTOM.\n\n\n\nproperty customProperties None | TimeWindowSizeClass\nGranularity of the event if applicable\n\n\n\nproperty lastUpdatedTimestamp None | str\nThe optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.\n\n\n\nproperty numAffectedRows str | OperationTypeClass\nOperation type of change.\n\n\n\nproperty partitionSpec None | str | OperationSourceTypeClass\nSource Type\n\n\n\nproperty timestampMillis object\nThe source of an operation\n\n\nDATAPLATFORM = 'DATAPLATFORM'\n\n\n\nDATAPROCESS = 'DATAPROCESS'\n\n\n\n\nclass datahub.metadata.schemaclasses.OperationTypeClass\nBases DictWrapper\nSchema holder for oracle data definition language that describes an oracle table.\n\nParameters str\nThe native schema in the dataset\u2019s platform. This is a human readable (json blob) table schema.\n\n\n\n\nclass datahub.metadata.schemaclasses.OrcSchemaClass(schema)\nBases\nschema (str)\n\n\n\n\nproperty schema Aspect\nCarries information about where an entity originated from.\n\nParameters None | str\nOnly populated if type is EXTERNAL. The externalType of the entity, such as the name of the identity provider.\n\n\n\nproperty type object\nEnum to define where an entity originated from.\n\n\nEXTERNAL = 'EXTERNAL'\n\n\n\nNATIVE = 'NATIVE'\n\n\n\n\nclass datahub.metadata.schemaclasses.OtherSchemaClass(rawSchema)\nBases\nrawSchema (str)\n\n\n\n\nproperty rawSchema DictWrapper\nOwnership information\n\nParameters str\ncorpuserligroupname, and urnmultiProduct only corpuser is currently supported in the frontend.)\n\nType\nli\n\n\n\n\n\nproperty source str | OwnershipTypeClass\nThe type of the ownership\n\n\n\nproperty typeUrn Aspect\nOwnership information of an entity.\n\nParameters AuditStampClass\nAudit stamp containing who last modified the record and when. A value of 0 in the time field indicates missing data.\n\n\n\nproperty ownerTypes List[OwnerClass]\nList of owners of the entity.\n\n\n\n\nclass datahub.metadata.schemaclasses.OwnershipSourceClass(type, url=None)\nBases\n\ntype (Union[str, OwnershipSourceTypeClass])\nurl (Optional[str])\n\n\n\n\n\nproperty type None | str\nA reference URL for the source\n\n\n\n\nclass datahub.metadata.schemaclasses.OwnershipSourceTypeClass\nBases object\nAsset owner types\n\n\nBUSINESSOWNER = 'BUSINESSOWNER'\n\n\n\nCONSUMER = 'CONSUMER'\n\n\n\nCUSTOM = 'CUSTOM'\n\n\n\nDATAOWNER = 'DATAOWNER'\n\n\n\nDATASTEWARD = 'DATASTEWARD'\n\n\n\nDELEGATE = 'DELEGATE'\n\n\n\nDEVELOPER = 'DEVELOPER'\n\n\n\nNONE = 'NONE'\n\n\n\nPRODUCER = 'PRODUCER'\n\n\n\nSTAKEHOLDER = 'STAKEHOLDER'\n\n\n\nTECHNICALOWNER = 'TECHNICALOWNER'\n\n\n\n\nclass datahub.metadata.schemaclasses.OwnershipTypeInfoClass(name, created, lastModified, description=None)\nBases\n\nname (str)\ncreated (AuditStampClass)\nlastModified (AuditStampClass)\ndescription (Optional[str])\n\n\n\n\n\nproperty created None | str\nDescription of the Ownership Type\n\n\n\nproperty lastModified str\nDisplay name of the Ownership Type\n\n\n\n\nclass datahub.metadata.schemaclasses.OwnershipTypeKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\nArbitrary key-value parameters for an Entity Change Event. (any record).\n\n\n\nclass datahub.metadata.schemaclasses.PartitionSpecClass(partition, timePartition=None, type=None)\nBases\n\npartition (str)\ntimePartition (Optional[TimeWindowClass])\ntype (Union[str, PartitionTypeClass, None])\n\n\n\n\n\nproperty partition None | TimeWindowClass\nTime window of the partition, if we are able to extract it from the partition key.\n\n\n\nproperty type DictWrapper\nDefines how the data is partitioned\n\nParameters None | int\nThe created time for a given partition.\n\n\n\nproperty lastModifiedTime str\nA unique id / value for the partition for which statistics were collected,\ngenerated by applying the key definition to a given row.\n\n\n\n\nclass datahub.metadata.schemaclasses.PartitionTypeClass\nBases Aspect\nDefines how the data is partitioned for Data Lake tables (e.g. Hive, S3, Iceberg, Delta, Hudi, etc).\n\nParameters None | PartitionSummaryClass\nThe maximum partition as ordered\n\n\n\nproperty minPartition DictWrapper\nA DataHub Platform Event.\n\nParameters PlatformEventHeaderClass\nHeader information stored with the event.\n\n\n\nproperty name GenericPayloadClass\nThe event payload.\n\n\n\n\nclass datahub.metadata.schemaclasses.PlatformEventHeaderClass(timestampMillis)\nBases\ntimestampMillis (int)\n\n\n\n\nproperty timestampMillis Aspect\nPlatform Resource Info.\nThese entities are for miscelaneous data that is used in non-core parts of the system.\nFor instance, if we want to persist &amp; retrieve data from auxiliary integrations such as Slack or Microsoft Teams.\n\nParameters str\nThe primary key for this platform resource.\ne.g. for a slack member this would be the memberID.\nprimary keys specified here don\u2019t need to include any additional specificity for the\n\ndataPlatform\n\nThe @PlatformResourceKey is supposed to represent that\n\n\n\nproperty resourceType conversation, user, grant, etc.\nResource types are indexed for ease of access.\ne.g. Get me all platform resources of type user for the platform looker\n\n\n\nproperty secondaryKeys None | SerializedValueClass\nThe serialized value of this platform resource item.\n\n\n\n\nclass datahub.metadata.schemaclasses.PlatformResourceKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty idslack-instanceuser-info\nor guid(slack, slack-instance, slack-user-id, user-info) etc.\n\n\n\n\nclass datahub.metadata.schemaclasses.PlatformTypeClass\nBases object\nThe matching condition in a filter criterion\n\n\nEQUALS = 'EQUALS'\n\n\n\nSTARTSWITH = 'STARTSWITH'\n\n\n\n\nclass datahub.metadata.schemaclasses.PolicyMatchCriterionClass(field, values, condition=None)\nBases\n\nfield (str)\nvalues (List[str])\ncondition (Union[str, PolicyMatchConditionClass, None])\n\n\n\n\n\nproperty condition str\nThe name of the field that the criterion refers to\n\n\n\nproperty values DictWrapper\nThe filter for specifying the resource or actor to apply privileges to\n\nParameters List[PolicyMatchCriterionClass]\nA list of criteria to apply conjunctively (so all criteria must pass)\n\n\n\n\nclass datahub.metadata.schemaclasses.PostContentClass(title, type, description=None, link=None, media=None)\nBases\n\ntitle (str)\ntype (Union[str, PostContentTypeClass])\ndescription (Optional[str])\nlink (Optional[str])\nmedia (Optional[MediaClass])\n\n\n\n\n\nproperty description None | str\nOptional link that the post is associated with.\n\n\n\nproperty media str\nTitle of the post.\n\n\n\nproperty type object\nEnum defining the type of content held in a Post.\n\n\nLINK = 'LINK'\n\n\n\nTEXT = 'TEXT'\n\n\n\n\nclass datahub.metadata.schemaclasses.PostInfoClass(type, content, created, lastModified, auditStamp=None, target=None)\nBases\n\ntype (Union[str, PostTypeClass])\ncontent (PostContentClass)\ncreated (int)\nlastModified (int)\nauditStamp (Optional[AuditStampClass])\ntarget (Optional[str])\n\n\n\n\n\nproperty auditStamp PostContentClass\nContent stored in the post.\n\n\n\nproperty created int\nThe time at which the post was last modified\n\n\n\nproperty target str | PostTypeClass\nType of the Post.\n\n\n\n\nclass datahub.metadata.schemaclasses.PostKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id object\nEnum defining types of Posts.\n\n\nENTITYANNOUNCEMENT = 'ENTITYANNOUNCEMENT'\n\n\n\nHOMEPAGEANNOUNCEMENT = 'HOMEPAGEANNOUNCEMENT'\n\n\n\n\nclass datahub.metadata.schemaclasses.PrestoDDLClass(rawSchema)\nBases\nrawSchema (str)\n\n\n\n\nproperty rawSchema object\n\n\nMULTIPLE = 'MULTIPLE'\n\n\n\nSINGLE = 'SINGLE'\n\n\n\n\nclass datahub.metadata.schemaclasses.PropertyValueClass(value, description=None)\nBases\n\nvalue (Union[str, float])\ndescription (Optional[str])\n\n\n\n\n\nproperty description str | float\n\n\n\n\nclass datahub.metadata.schemaclasses.QuantileClass(quantile, value)\nBases\n\nquantile (str)\nvalue (str)\n\n\n\n\n\nproperty quantile str\n\n\n\n\nclass datahub.metadata.schemaclasses.QuantitativeAnalysesClass(unitaryResults=None, intersectionalResults=None)\nBases\n\nunitaryResults (Optional[str])\nintersectionalResults (Optional[str])\n\n\n\n\n\nproperty intersectionalResults None | str\nLink to a dashboard with results showing how the MLModel performed with respect to each factor\n\n\n\n\nclass datahub.metadata.schemaclasses.QueryCellClass(cellId, changeAuditStamps, rawQuery, cellTitle=None, lastExecuted=None)\nBases\n\ncellId (str)\nchangeAuditStamps (ChangeAuditStampsClass)\nrawQuery (str)\ncellTitle (Optional[str])\nlastExecuted (Optional[AuditStampClass])\n\n\n\n\n\nproperty cellId None | str\nTitle of the cell\n\n\n\nproperty changeAuditStamps None | AuditStampClass\nCaptures information about who last executed this query cell and when\n\n\n\nproperty rawQuery Aspect\nKey for a Query\n\nParameters str\nA unique id for the Query.\n\n\n\n\nclass datahub.metadata.schemaclasses.QueryLanguageClass\nBases Aspect\nInformation about a Query against one or more data assets (e.g. Tables or Views).\n\nParameters AuditStampClass\nAudit stamp capturing the time and actor who created the Query.\n\n\n\nproperty customProperties None | str\nThe Query description.\n\n\n\nproperty lastModified None | str\nOptional display name to identify the query.\n\n\n\nproperty origin str | QuerySourceClass\nThe source of the Query\n\n\n\nproperty statement object\n\n\nMANUAL = 'MANUAL'\n\n\n\nSYSTEM = 'SYSTEM'\n\n\n\n\nclass datahub.metadata.schemaclasses.QueryStatementClass(value, language=None)\nBases\n\nvalue (str)\nlanguage (Union[str, QueryLanguageClass, None])\n\n\n\n\n\nproperty language str\nThe query text\n\n\n\n\nclass datahub.metadata.schemaclasses.QuerySubjectClass(entity)\nBases\nentity (str)\n\n\n\n\nproperty entity Aspect\nInformation about the subjects of a particular Query, i.e. the assets\nbeing queried.\n\nParameters List[QuerySubjectClass]\nOne or more subjects of the query.\nIn single-asset queries (e.g. table select), this will contain the Table reference\nand optionally schema field references.\nIn multi-asset queries (e.g. table joins), this may contain multiple Table references\nand optionally schema field references.\n\n\n\n\nclass datahub.metadata.schemaclasses.QueryUsageStatisticsClass(timestampMillis, eventGranularity=None, partitionSpec=None, messageId=None, queryCount=None, queryCost=None, lastExecutedAt=None, uniqueUserCount=None, userCounts=None)\nBases\n\ntimestampMillis (int)\neventGranularity (Optional[TimeWindowSizeClass])\npartitionSpec (Optional[PartitionSpecClass])\nmessageId (Optional[str])\nqueryCount (Optional[int])\nqueryCost (Optional[float])\nlastExecutedAt (Optional[int])\nuniqueUserCount (Optional[int])\nuserCounts (Optional[List[DatasetUserUsageCountsClass]])\n\n\n\n\n\nASPECTTYPE None | TimeWindowSizeClass\nGranularity of the event if applicable\n\n\n\nproperty lastExecutedAt None | str\nThe optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.\n\n\n\nproperty partitionSpec None | float\nQuery cost for this query and bucket\n\n\n\nproperty queryCount int\nThe event timestamp field as epoch at UTC in milli seconds.\n\n\n\nproperty uniqueUserCount None | List[DatasetUserUsageCountsClass]\nUsers within this bucket, with frequency counts\n\n\n\n\nclass datahub.metadata.schemaclasses.RecordTypeClass\nBases DictWrapper\nIndividual Field Mapping of a relationship- one of several\n\nParameters str\n1\n\nType str\n1\n\nType DictWrapper\nBase class that encapsulates different retention policies.\nOnly one of the fields should be set\n\nParameters None | TimeBasedRetentionClass\n\n\n\nproperty version DictWrapper\nProperties of an applied Role. For now, just an Urn\n\nParameters str\nUrn of the External Role\n\n\n\n\nclass datahub.metadata.schemaclasses.RoleKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id Aspect\nCarries information about which roles a user or group is assigned to.\n\nParameters List[str]\n\n\n\n\nclass datahub.metadata.schemaclasses.RolePropertiesClass(name, type, description=None, requestUrl=None, created=None)\nBases\n\nname (str)\ntype (str)\ndescription (Optional[str])\nrequestUrl (Optional[str])\ncreated (Optional[AuditStampClass])\n\n\n\n\n\nproperty created None | str\nDescription of the IAM Role\n\n\n\nproperty name None | str\nLink to access external access management\n\n\n\nproperty type DictWrapper\nProvisioned users of a role\n\nParameters str\nLink provisioned corp user for a role\n\n\n\n\nclass datahub.metadata.schemaclasses.RowCountChangeClass(type, operator, parameters)\nBases\n\ntype (Union[str, AssertionValueChangeTypeClass])\noperator (Union[str, AssertionStdOperatorClass])\nparameters (AssertionStdParametersClass)\n\n\n\n\n\nproperty operator\nGREATERTHAN, GREATERTHANOREQUALTO, EQUALTO, LESSTHAN, LESSTHANOREQUALTO,\nBETWEEN.\n\n\n\nproperty parameters NUMBER.\n\n\n\nproperty type\nThe type of the value used to evaluate the assertion\n\n\n\n\n\n\nclass datahub.metadata.schemaclasses.RowCountTotalClass(operator, parameters)\nBases\n\noperator (Union[str, AssertionStdOperatorClass])\nparameters (AssertionStdParametersClass)\n\n\n\n\n\nproperty operator\nGREATERTHAN, GREATERTHANOREQUALTO, EQUALTO, LESSTHAN, LESSTHANOREQUALTO,\nBETWEEN.\n\n\n\nproperty parameters NUMBER.\n\n\n\n\nclass datahub.metadata.schemaclasses.RunResultTypeClass\nBases object\n\n\nEXACTMATCH = 'EXACTMATCH'\n\n\n\nSUBSET = 'SUBSET'\n\n\n\nSUPERSET = 'SUPERSET'\n\n\n\n\nclass datahub.metadata.schemaclasses.SchemaAssertionInfoClass(entity, schema, compatibility=None)\nBases\n\nentity (str)\nschema (SchemaMetadataClass)\ncompatibility (Union[str, SchemaAssertionCompatibilityClass, None])\n\n\n\n\n\nproperty compatibility str\nThe entity targeted by the assertion\n\n\n\nproperty schema DictWrapper\nExpectations for a logical schema\n\nParameters str\nThe assertion representing the schema contract.\n\n\n\n\nclass datahub.metadata.schemaclasses.SchemaFieldAliasesClass(aliases=None)\nBases\naliases (Optional[List[str]])\n\n\n\n\nproperty aliases DictWrapper\nSchemaField to describe metadata related to dataset schema.\n\nParameters None | AuditStampClass\nAn AuditStamp corresponding to the creation of this schema field.\n\n\n\nproperty description str\nFlattened name of the field. Field is computed from jsonPath field.\n\n\n\nproperty globalTags None | GlossaryTermsClass\nGlossary terms associated with the field\n\n\n\nproperty isPartOfKey None | bool\nFor Datasets which are partitioned, this determines the partitioning key.\nNote that multiple columns can be part of a partitioning key, but currently we do not support\nrendering the ordered partitioning key.\n\n\n\nproperty jsonPath None | str\nFor schema fields that have other properties that are not modeled explicitly,\nuse this field to serialize those properties into a JSON string\n\n\n\nproperty label None | AuditStampClass\nAn AuditStamp corresponding to the last modification of this schema field.\n\n\n\nproperty nativeDataType bool\nIndicates if this field is optional or nullable\n\n\n\nproperty recursive SchemaFieldDataTypeClass\nPlatform independent field type of the field.\n\n\n\n\nclass datahub.metadata.schemaclasses.SchemaFieldDataTypeClass(type)\nBases\ntype (Union[BooleanTypeClass, FixedTypeClass, StringTypeClass, BytesTypeClass, NumberTypeClass, DateTypeClass, TimeTypeClass, EnumTypeClass, NullTypeClass, MapTypeClass, ArrayTypeClass, UnionTypeClass, RecordTypeClass])\n\n\n\n\nproperty type Aspect\n\nParameters None | str\n\n\n\nproperty schemaFieldAliases Aspect\nKey for a SchemaField\n\nParameters str\nfieldPath identifying the schema field\n\n\n\nproperty parent DictWrapper\nA metadata snapshot for a specific schema field entity.\n\nParameters List[SchemaFieldKeyClass]\nThe list of metadata aspects associated with the dataset. Depending on the use case, this can either be all, or a selection, of supported aspects.\n\n\n\nproperty urn DictWrapper\nLightweight spec used for referencing a particular schema field.\n\nParameters str\nThe native field type\n\n\n\nproperty path str\nThe DataHub standard schema field type.\n\n\n\n\nclass datahub.metadata.schemaclasses.SchemaMetadataClass(schemaName, platform, version, hash, platformSchema, fields, created=None, lastModified=None, deleted=None, dataset=None, cluster=None, primaryKeys=None, foreignKeysSpecs=None, foreignKeys=None)\nBases\n\nschemaName (str)\nplatform (str)\nversion (int)\nhash (str)\nplatformSchema (Union[EspressoSchemaClass, OracleDDLClass, MySqlDDLClass, PrestoDDLClass, KafkaSchemaClass, BinaryJsonSchemaClass, OrcSchemaClass, SchemalessClass, KeyValueSchemaClass, OtherSchemaClass])\nfields (List[SchemaFieldClass])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\ndeleted (Optional[AuditStampClass])\ndataset (Optional[str])\ncluster (Optional[str])\nprimaryKeys (Optional[List[str]])\nforeignKeysSpecs (Optional[Dict[str, ForeignKeySpecClass]])\nforeignKeys (Optional[List[ForeignKeyConstraintClass]])\n\n\n\n\n\nproperty cluster AuditStampClass\nAn AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.\n\n\n\nproperty dataset None | AuditStampClass\nAn AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.\n\n\n\nproperty fields None | List[ForeignKeyConstraintClass]\nList of foreign key constraints for the schema\n\n\n\nproperty foreignKeysSpecs str\nthe SHA1 hash of the schema content\n\n\n\nproperty lastModified str\nplatform\nStandardized platform urn where schema is defined. The data platform Urn (urn\n\nType EspressoSchemaClass | OracleDDLClass | MySqlDDLClass | PrestoDDLClass | KafkaSchemaClass | BinaryJsonSchemaClass | OrcSchemaClass | SchemalessClass | KeyValueSchemaClass | OtherSchemaClass\nThe native schema in the dataset\u2019s platform.\n\n\n\nproperty primaryKeys str\nSchema name e.g. PageViewEvent, identity.Profile, ams.accountmanagementtracking\n\n\n\nproperty version DictWrapper\nThe dataset has no specific schema associated with it\n\n\n\nclass datahub.metadata.schemaclasses.SearchFieldTypeClass\nBases DictWrapper\nCaptures the serialized value of a (usually) schema-d blob.\n\nParameters bytes\nThe serialized blob value.\n\n\n\nproperty contentType None | str\nAn optional reference to the schema that models the object.\ne.g., \u2018com.linkedin.pegasus2avro.platformresource.slack.SlackConversation\u2019\n\n\n\nproperty schemaType object\n\n\nBINARY = 'BINARY'\n\n\n\nJSON = 'JSON'\n\n\n\n\nclass datahub.metadata.schemaclasses.SerializedValueSchemaTypeClass\nBases Aspect\nSiblings information of an entity.\n\nParameters bool\nIf this is the leader entity of the set of siblings\n\n\n\nproperty siblings DictWrapper\nSlack Notification settings for an actor.\n\nParameters None | List[str]\nOptional list of channels to send notifications to\n\n\n\nproperty userHandle Aspect\nInformation about a Slack user.\n\nParameters str\nThe display name of the Slack member.\n\n\n\nproperty email str\nThe unique identifier for the Slack member.\n\n\n\nproperty isAdmin bool\nWhether the member is a bot.\n\n\n\nproperty isDeleted bool\nWhether the member is an owner.\n\n\n\nproperty isPrimaryOwner None | int\nThe timestamp of when the member was last updated. (in seconds)\n\n\n\nproperty name None | str\nThe phone number of the Slack member.\n\n\n\nproperty profilePictureUrl str\nThe real name of the Slack member.\n\n\n\nproperty slackInstance None | str\nThe status emoji of the Slack member.\n\n\n\nproperty statusText str\nThe ID associated with the Slack team.\n\n\n\nproperty timezone None | int\nThe timezone offset of the Slack member.\n\n\n\nproperty title Aspect\nSource Code\n\nParameters List[SourceCodeUrlClass]\nSource Code along with types\n\n\n\n\nclass datahub.metadata.schemaclasses.SourceCodeUrlClass(type, sourceCodeUrl)\nBases\n\ntype (Union[str, SourceCodeUrlTypeClass])\nsourceCodeUrl (str)\n\n\n\n\n\nproperty sourceCodeUrl str | SourceCodeUrlTypeClass\nSource Code Url Types\n\n\n\n\nclass datahub.metadata.schemaclasses.SourceCodeUrlTypeClass\nBases DictWrapper\nAttributes defining a SQL Assertion\n\nParameters None | str | AssertionValueChangeTypeClass\na fixed absolute value or a relative percentage.\nThis value is required if the type is METRICCHANGE.\n\nType str\nThe entity targeted by this SQL check.\n\n\n\nproperty operator\nGREATERTHAN, GREATERTHANOREQUALTO, EQUALTO, LESSTHAN, LESSTHANOREQUALTO,\nBETWEEN.\n\n\n\nproperty parameters NUMBER.\n\n\n\nproperty statement str | SqlAssertionTypeClass\nThe type of the SQL assertion being monitored.\n\n\n\n\nclass datahub.metadata.schemaclasses.SqlAssertionTypeClass\nBases DictWrapper\nSSO Integrations, supported on the UI.\n\nParameters str\nAuth base URL.\n\n\n\nproperty oidcSettings Aspect\nThe lifecycle status metadata of an entity, e.g. dataset, metric, feature, etc.\nThis aspect is used to represent soft deletes conventionally.\n\nParameters bool\nWhether the entity has been removed (soft-deleted).\n\n\n\n\nclass datahub.metadata.schemaclasses.StringTypeClass\nBases DictWrapper\nA flexible carrier for structured results of an execution request.\nThe goal is to allow for free flow of structured responses from execution tasks to the orchestrator or observer.\nThe full spectrum of different execution report types is not intended to be modeled by this object.\n\nParameters str\nThe content-type of the serialized value (e.g. application/json, application/json;gzip etc.)\n\n\n\nproperty serializedValue str\nThe type of the structured report. (e.g. INGESTIONREPORT, TESTCONNECTIONREPORT, etc.)\n\n\n\n\nclass datahub.metadata.schemaclasses.StructuredPropertiesClass(properties)\nBases\nproperties (List[StructuredPropertyValueAssignmentClass])\n\n\n\n\nproperty properties Aspect\n\nParameters None | List[PropertyValueClass]\nA list of allowed values that the property is allowed to take.\nIf this is not specified, then the property can take any value of given type.\n\n\n\nproperty cardinality None | AuditStampClass\nCreated Audit stamp\n\n\n\nproperty description None | str\nThe display name of the property. This is the name that will be shown in the UI and can be used to look up the property id.\n\n\n\nproperty entityTypes bool\nWhether the structured property value is immutable once applied to an entity.\n\n\n\nproperty lastModified str\nThe fully qualified name of the property. e.g. io.acryl.datahub.myProperty\n\n\n\nproperty searchConfiguration None | Dict[str, List[str]]\nA map that allows for type specialization of the valueType.\ne.g. a valueType of urndataType [\u201durnentityTypelidatahub.corpGroup\u201d] }\n\n\n\nproperty valueTypelidatahub.date\n\n\n\nproperty version v1, v2\n\n20240610, 20240611\n\n\n\n\n\nclass datahub.metadata.schemaclasses.StructuredPropertyKeyClass(id)\nBases\nid (str)\n\n\n\n\nproperty id DictWrapper\n\nParameters str\nThe structured property that is required on this entity\n\n\n\n\nclass datahub.metadata.schemaclasses.StructuredPropertySettingsClass(isHidden=None, showInSearchFilters=None, showInAssetSummary=None, showAsAssetBadge=None, showInColumnsTable=None, lastModified=None)\nBases\n\nisHidden (Optional[bool])\nshowInSearchFilters (Optional[bool])\nshowInAssetSummary (Optional[bool])\nshowAsAssetBadge (Optional[bool])\nshowInColumnsTable (Optional[bool])\nlastModified (Optional[AuditStampClass])\n\n\n\n\n\nproperty isHidden None | AuditStampClass\nLast Modified Audit stamp\n\n\n\nproperty showAsAssetBadge bool\nWhether or not this asset should be displayed in the asset sidebar\n\n\n\nproperty showInColumnsTable bool\nWhether or not this asset should be displayed as a search filter\n\n\n\n\nclass datahub.metadata.schemaclasses.StructuredPropertyValueAssignmentClass(propertyUrn, values, created=None, lastModified=None)\nBases\n\npropertyUrn (str)\nvalues (List[Union[str, float]])\ncreated (Optional[AuditStampClass])\nlastModified (Optional[AuditStampClass])\n\n\n\n\n\nproperty created None | AuditStampClass\nAudit stamp containing who last modified this relationship edge and when\n\n\n\nproperty propertyUrn List[str | float]\nThe value assigned to the property.\n\n\n\n\nclass datahub.metadata.schemaclasses.SubTypesClass(typeNames)\nBases\ntypeNames (List[str])\n\n\n\n\nproperty typeNames Aspect\nMetadata associated with each metadata change that is processed by the system\n\nParameters int | None\nThe timestamp the metadata was observed at\n\n\n\nproperty lastRunId None | str\nThe ingestion pipeline id that produced the metadata. Populated in case of batch ingestion.\n\n\n\nproperty properties None | str\nThe model registry name that was used to process this event\n\n\n\nproperty registryVersion str | None\nThe original run id that produced the metadata. Populated in case of batch-ingestion.\n\n\n\nproperty version DictWrapper\nProperties of an applied tag. For now, just an Urn. In the future we can extend this with other properties, e.g.\npropagation parameters.\n\nParameters None | MetadataAttributionClass\nInformation about who, why, and how this metadata was applied\n\n\n\nproperty context str\nUrn of the applied tag\n\n\n\n\nclass datahub.metadata.schemaclasses.TagKeyClass(name)\nBases\nname (str)\n\n\n\n\nproperty name Aspect\nProperties associated with a Tag\n\nParameters None | str\nThe color associated with the Tag in Hex. For example #FFFFFF.\n\n\n\nproperty description str\nDisplay name of the tag\n\n\n\n\nclass datahub.metadata.schemaclasses.TagSnapshotClass(urn, aspects)\nBases\n\nurn (str)\naspects (List[Union[TagKeyClass, OwnershipClass, TagPropertiesClass, StatusClass]])\n\n\n\n\n\nproperty aspects str\nURN for the entity the metadata snapshot is associated with.\n\n\n\n\nclass datahub.metadata.schemaclasses.TelemetryClientIdClass(clientId)\nBases\nclientId (str)\n\n\n\n\nproperty clientId Aspect\nKey for the telemetry client ID, only one should ever exist\n\nParameters str\nThe telemetry entity name, which serves as a unique id\n\n\n\n\nclass datahub.metadata.schemaclasses.TestDefinitionClass(type, json=None)\nBases\n\ntype (Union[str, TestDefinitionTypeClass])\njson (Optional[str])\n\n\n\n\n\nproperty json str | TestDefinitionTypeClass\nThe Test Definition Type\n\n\n\n\nclass datahub.metadata.schemaclasses.TestDefinitionTypeClass\nBases Aspect\nInformation about a DataHub Test\n\nParameters str\nCategory of the test\n\n\n\nproperty definition None | str\nDescription of the test\n\n\n\nproperty name Aspect\nKey for a Test\n\nParameters str\nUnique id for the test\n\n\n\n\nclass datahub.metadata.schemaclasses.TestResultClass(test, type, testDefinitionMd5=None, lastComputed=None)\nBases\n\ntest (str)\ntype (Union[str, TestResultTypeClass])\ntestDefinitionMd5 (Optional[str])\nlastComputed (Optional[AuditStampClass])\n\n\n\n\n\nproperty lastComputed str\nThe urn of the test\n\n\n\nproperty testDefinitionMd5 str | TestResultTypeClass\nThe type of the result\n\n\n\n\nclass datahub.metadata.schemaclasses.TestResultTypeClass\nBases Aspect\nInformation about a Test Result\n\nParameters List[TestResultClass]\nResults that are failing\n\n\n\nproperty passing DictWrapper\nText cell in a Notebook, which will present content in text format\n\nParameters str\nUnique id for the cell. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as \u2018querybook.com/notebook/773/?cellId=1234\u2019\n\n\n\nproperty cellTitle ChangeAuditStampsClass\nCaptures information about who created/last modified/deleted this Notebook cell and when\n\n\n\nproperty text DictWrapper\nKeep records that are less than X seconds old\n\nParameters int\n\n\n\n\nclass datahub.metadata.schemaclasses.TimeStampClass(time, actor=None)\nBases\n\ntime (int)\nactor (Optional[str])\n\n\n\n\n\nproperty actor\nOptional\n\n\n\n\n\nproperty time DictWrapper\nTime field type. This should also be used for datetimes.\n\n\n\nclass datahub.metadata.schemaclasses.TimeWindowClass(startTimeMillis, length)\nBases\n\nstartTimeMillis (int)\nlength (TimeWindowSizeClass)\n\n\n\n\n\nproperty length int\nStart time as epoch at UTC.\n\n\n\n\nclass datahub.metadata.schemaclasses.TimeWindowSizeClass(unit, multiple=None)\nBases\n\nunit (Union[str, CalendarIntervalClass])\nmultiple (Optional[int])\n\n\n\n\n\nproperty multiple str | CalendarIntervalClass\nInterval unit such as minute/hour/day etc.\n\n\n\n\nclass datahub.metadata.schemaclasses.TrainingDataClass(trainingData)\nBases\ntrainingData (List[BaseDataClass])\n\n\n\n\nproperty trainingData object\nType of the transformation involved in generating destination fields from source fields.\n\n\nBLACKBOX = 'BLACKBOX'\n\n\n\nIDENTITY = 'IDENTITY'\n\n\n\n\nclass datahub.metadata.schemaclasses.UDFTransformerClass(udf)\nBases\nudf (str)\n\n\n\n\nproperty udf DictWrapper\nUnion field type.\n\nParameters None | List[str]\nList of types in union type.\n\n\n\n\nclass datahub.metadata.schemaclasses.UpstreamClass(dataset, type, auditStamp=None, created=None, properties=None, query=None)\nBases\n\ndataset (str)\ntype (Union[str, DatasetLineageTypeClass])\nauditStamp (Optional[AuditStampClass])\ncreated (Optional[AuditStampClass])\nproperties (Optional[Dict[str, str]])\nquery (Optional[str])\n\n\n\n\n\nproperty auditStamp None | AuditStampClass\nAudit stamp containing who created the lineage and when.\n\n\n\nproperty dataset None | Dict[str, str]\nA generic properties bag that allows us to store specific information on this graph edge.\n\n\n\nproperty query str | DatasetLineageTypeClass\nThe type of the lineage\n\n\n\n\nclass datahub.metadata.schemaclasses.UpstreamLineageClass(upstreams, fineGrainedLineages=None)\nBases\n\nupstreams (List[UpstreamClass])\nfineGrainedLineages (Optional[List[FineGrainedLineageClass]])\n\n\n\n\n\nproperty fineGrainedLineages List[UpstreamClass]\nList of upstream dataset lineage information\n\n\n\n\nclass datahub.metadata.schemaclasses.UrnForeignKeyClass(currentFieldPath)\nBases\ncurrentFieldPath (str)\n\n\n\n\nproperty currentFieldPath DictWrapper\nUsage data for a given resource, rolled up into a bucket.\n\nParameters int\nBucket start time in milliseconds\n\n\n\nproperty duration UsageAggregationMetricsClass\nMetrics associated with this bucket\n\n\n\nproperty resource DictWrapper\nMetrics for usage data for a given resource and bucket. Not all fields\nmake sense for all buckets, so every field is optional.\n\nParameters None | List[FieldUsageCountsClass]\nField-level usage stats\n\n\n\nproperty topSqlQueries None | int\nTotal SQL query count\n\n\n\nproperty uniqueUserCount None | List[UserUsageCountsClass]\nUsers within this bucket, with frequency counts\n\n\n\n\nclass datahub.metadata.schemaclasses.UserUsageCountsClass(count, user=None, userEmail=None)\nBases\n\ncount (int)\nuser (Optional[str])\nuserEmail (Optional[str])\n\n\n\n\n\nproperty count None | str\n\n\n\nproperty userEmail DictWrapper\n\nParameters int\n\n\n\nproperty value DictWrapper\nKeep max N latest records\n\nParameters int\n\n\n\n\nclass datahub.metadata.schemaclasses.VersionInfoClass(version, versionType, customProperties=None, externalUrl=None)\nBases\n\nversion (str)\nversionType (str)\ncustomProperties (Optional[Dict[str, str]])\nexternalUrl (Optional[str])\n\n\n\n\n\nproperty customProperties None | str\nURL where the reference exist\n\n\n\nproperty version str\nThe type of the version like git hash or md5 hash\n\n\n\n\nclass datahub.metadata.schemaclasses.VersionPropertiesClass(versionSet, version, sortId, aliases=None, comment=None, versioningScheme=None, sourceCreatedTimestamp=None, metadataCreatedTimestamp=None, isLatest=None)\nBases\n\nversionSet (str)\nversion (VersionTagClass)\nsortId (str)\naliases (Optional[List[VersionTagClass]])\ncomment (Optional[str])\nversioningScheme (Union[str, VersioningSchemeClass, None])\nsourceCreatedTimestamp (Optional[AuditStampClass])\nmetadataCreatedTimestamp (Optional[AuditStampClass])\nisLatest (Optional[bool])\n\n\n\n\n\nproperty aliases None | str\nComment documenting what this version was created for, changes, or represents\n\n\n\nproperty isLatest None | AuditStampClass\nTimestamp reflecting when the metadata for this version was created in DataHub\n\n\n\nproperty sortId None | AuditStampClass\nTimestamp reflecting when this asset version was created in the source system.\n\n\n\nproperty version str\nThe linked Version Set entity that ties multiple versioned assets together\n\n\n\nproperty versioningScheme Aspect\nKey for a Version Set entity\n\nParameters str\nType of entities included in version set, limits to a single entity type between linked versioned entities\n\n\n\nproperty id Aspect\n\nParameters Dict[str, str]\nCustom property bag.\n\n\n\nproperty latest str | VersioningSchemeClass\nWhat versioning scheme is being utilized for the versioned entities sort criterion. Static once set\n\n\n\n\nclass datahub.metadata.schemaclasses.VersionTagClass(versionTag=None, metadataAttribution=None)\nBases\n\nversionTag (Optional[str])\nmetadataAttribution (Optional[MetadataAttributionClass])\n\n\n\n\n\nproperty metadataAttribution None | str\n\n\n\n\nclass datahub.metadata.schemaclasses.VersioningSchemeClass\nBases Aspect\nDetails about a View.\ne.g. Gets activated when subTypes is view\n\nParameters None | str\nThe formatted view logic. This is particularly used for SQL sources, where the SQL\nlogic is formatted for better readability, and with dbt, where this contains the\ncompiled SQL logic.\n\n\n\nproperty materialized str\nThe view logic language / dialect\n\n\n\nproperty viewLogic DictWrapper\nAttributes defining a dataset Volume Assertion\n\nParameters str\nThe entity targeted by this Volume check.\n\n\n\nproperty filter None | IncrementingSegmentRowCountChangeClass\nProduce FAILURE Assertion Result if the asset\u2019s incrementing segment row count delta\ndoes not meet specific requirements. Required if type is \u2018INCREMENTINGSEGMENTROWCOUNTCHANGE\u2019\n\n\n\nproperty incrementingSegmentRowCountTotal None | RowCountChangeClass\nProduce FAILURE Assertion Result if the delta row count of the asset does not meet specific requirements\nwithin a given period of time.\nRequired if type is \u2018ROWCOUNTCHANGE\u2019\n\n\n\nproperty rowCountTotal str | VolumeAssertionTypeClass\nThe type of the volume assertion being monitored.\n\n\n\n\nclass datahub.metadata.schemaclasses.VolumeAssertionTypeClass\nBases object\nEnum to define the length of a bucket when doing aggregations\n\n\nDAY = 'DAY'\n\n\n\nHOUR = 'HOUR'\n\n\n\nMONTH = 'MONTH'\n\n\n\nWEEK = 'WEEK'\n\n\n\nYEAR = 'YEAR'\n\n\n\n\ndatahub.metadata.schemaclasses.getschematype(fullname)\n\nParameters\nRecordSchema\n\n\n\n\n"}}>"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/1.1.0/python-sdk/models"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/1.1.0/python-sdk/models" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/1.1.0/python-sdk/models" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://RK0UG797F3-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/learn/rss.xml" title="DataHub RSS Feed">
|
||
<link rel="alternate" type="application/atom+xml" href="/learn/atom.xml" title="DataHub Atom Feed">
|
||
|
||
<link rel="preconnect" href="https://www.google-analytics.com">
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script async src="https://www.googletagmanager.com/gtag/js?id=G-PKGVLETT4C"></script>
|
||
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-PKGVLETT4C",{})</script>
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script>window.dataLayer=window.dataLayer||[]</script>
|
||
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-5M8T9HNN",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script>
|
||
|
||
|
||
<link rel="search" type="application/opensearchdescription+xml" title="DataHub" href="/opensearch.xml">
|
||
|
||
|
||
|
||
|
||
<meta httpequiv="Content-Security-Policy" content="frame-ancestors 'self' https://*.acryl.io https://acryldata.io http://localhost:*">
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Manrope:wght@400;500;700&display=swap">
|
||
<script src="https://tools.luckyorange.com/core/lo.js?site-id=28ea8a38" async defer="defer"></script>
|
||
<script src="/scripts/rb2b.js" async defer="defer"></script>
|
||
<script src="https://app.revenuehero.io/scheduler.min.js"></script>
|
||
<script src="https://tag.clearbitscripts.com/v1/pk_2e321cabe30432a5c44c0424781aa35f/tags.js" referrerpolicy="strict-origin-when-cross-origin"></script>
|
||
<script src="/scripts/reo.js"></script>
|
||
<script id="runllm-widget-script" type="module" src="https://widget.runllm.com" crossorigin="true" runllm-name="DataHub" runllm-assistant-id="81" runllm-position="BOTTOM_RIGHT" runllm-keyboard-shortcut="Mod+j" runllm-preset="docusaurus" runllm-theme-color="#1890FF" runllm-brand-logo="https://docs.datahub.com/img/datahub-logo-color-mark.svg" runllm-community-url="https://datahub.com/slack" runllm-community-type="slack" runllm-disable-ask-a-person="true" async></script><link rel="stylesheet" href="/assets/css/styles.1e47f27f.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.7bcf907e.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.99352010.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5M8T9HNN" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus">
|
||
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="announcementBar_mb4j" style="background-color:transparent;color:#ffffff" role="banner"><div class="content_knG7 announcementBarContent_xLdY"><div class="shimmer-banner"><p><strong>CONTEXT:</strong> The Future of Agentic AI is On Demand</p><a href="https://datahub.com/resources/context/?utm_term=docs" target="_blank" class="button"><div>Watch Now<span> →</span></div></a></div></div></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a href="https://datahub.com" target="_blank" rel="noopener noreferrer" class="navbar__brand"><div class="navbar__logo"><img src="/img/datahub-logo-color-light-horizontal.svg" alt="DataHub Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/datahub-logo-color-dark-horizontal.svg" alt="DataHub Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link versionNavItem_cbn8">1.1.0</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/python-sdk/models">Next</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/1.1.0/python-sdk/models">1.1.0</a></li><li><hr class="dropdown-separator" style="margin: 0.4rem;"></li><li><div class="dropdown__link"><b>Archived versions</b></div></li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/features">1.0.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/0.15.0/features">0.15.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-8jkm4uler-acryldata.vercel.app/docs/0.14.1/features">0.14.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-eue2qafvn-acryldata.vercel.app/docs/features">0.14.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-psat3nzgi-acryldata.vercel.app/docs/features">0.13.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-lzxh86531-acryldata.vercel.app/docs/features">0.13.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-2uuxmgza2-acryldata.vercel.app/docs/features">0.12.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-irpoe2osc-acryldata.vercel.app/docs/features">0.11.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-1gv2yzn9d-acryldata.vercel.app/docs/features">0.10.5
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li></ul></div></div><div class="navbar__items navbar__items--right"><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs">Docs</a><a class="navbar__item navbar__link" href="/integrations">Integrations</a><a href="https://datahub.com/slack?utm_source=docs&utm_medium=header&utm_campaign=docs_header" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.slack-logo:hover {
|
||
opacity: 0.8;
|
||
}
|
||
</style>
|
||
<img class="slack-logo" src="https://upload.wikimedia.org/wikipedia/commons/d/d5/Slack_icon_2019.svg" , alt="slack" , height="20px" style="margin: 10px 0 0 0;">
|
||
</a><a href="https://github.com/datahub-project/datahub" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.github-logo:hover {
|
||
opacity: 0.8;
|
||
}
|
||
</style>
|
||
<img class="github-logo" src="https://upload.wikimedia.org/wikipedia/commons/9/91/Octicons-mark-github.svg" , alt="slack" , height="20px" style="margin: 10px 0 0 0;">
|
||
</a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Getting Started</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/1.1.0/features">What Is DataHub?</a><button aria-label="Toggle the collapsible sidebar category 'What Is DataHub?'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/1.1.0/category/features">Features</a><button aria-label="Toggle the collapsible sidebar category 'Features'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/1.1.0/managed-datahub/managed-datahub-overview">DataHub Cloud</a><button aria-label="Toggle the collapsible sidebar category 'DataHub Cloud'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Integrations</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/1.1.0/metadata-ingestion">Overview</a><button aria-label="Toggle the collapsible sidebar category 'Overview'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/metadata-ingestion/cli-ingestion">Quickstart Guides</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/1.1.0/metadata-ingestion/source_overview">Sources</a><button aria-label="Toggle the collapsible sidebar category 'Sources'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/metadata-ingestion/schedule_docs/intro">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>API & SDKs</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/metadata-modeling/metadata-model">DataHub's Open Metadata Standard</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/1.1.0/what-is-datahub/datahub-concepts">Concepts</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/1.1.0/metadata-standards">Metadata Standards</a><button aria-label="Toggle the collapsible sidebar category 'Metadata Standards'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/1.1.0/api/datahub-apis">APIs</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/api/graphql/overview">API</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/1.1.0/metadata-ingestion/as-a-library">Python SDK</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.1.0/metadata-ingestion/as-a-library">Python Emitter</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/docs/1.1.0/python-sdk/builder">Python SDK Reference</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.1.0/python-sdk/builder">Builder</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.1.0/python-sdk/clients">Client</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/1.1.0/python-sdk/models">Models</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.1.0/python-sdk/urns">URNs</a></li></ul></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/1.1.0/metadata-integration/java/as-a-library">Java SDK</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/1.1.0/cli">DataHub CLI</a><button aria-label="Toggle the collapsible sidebar category 'DataHub CLI'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/1.1.0/act-on-metadata">DataHub Actions</a><button aria-label="Toggle the collapsible sidebar category 'DataHub Actions'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/api/tutorials/datasets">API & SDK Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Admin</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/authentication">Authentication</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/authorization">Authorization</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/how/delete-metadata">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Deployment</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/1.1.0/category/deployment-guides">Deployment Guides</a><button aria-label="Toggle the collapsible sidebar category 'Deployment Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/deploy/confluent-cloud">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Developers</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/architecture/architecture">Architecture</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/developers">Developing on DataHub</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/advanced/mcp-mcl">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Community</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/1.1.0/category/community">Community</a><button aria-label="Toggle the collapsible sidebar category 'Community'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.1.0/releases">Release History</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="theme-doc-version-banner alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for <!-- -->DataHub<!-- --> <b>1.1.0</b>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/docs/python-sdk/models">latest version</a></b> (<!-- -->Next<!-- -->).</div></div><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Python SDK</span><meta itemprop="position" content="1"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Python SDK Reference</span><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Models</span><meta itemprop="position" content="3"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: 1.1.0</span><div class="theme-doc-markdown markdown"><header><h1>Models</h1></header><div><article class="bd-article" role="main">
|
||
<section id="module-datahub.metadata.schema_classes">
|
||
<span id="models"></span>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AccessClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AccessClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Aspect used for associating roles to a dataset or any asset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>roles</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.RoleAssociationClass" title="datahub.metadata.schema_classes.RoleAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RoleAssociationClass</span></code></a>]])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AccessClass.roles">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">roles</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.RoleAssociationClass" title="datahub.metadata.schema_classes.RoleAssociationClass"><span class="pre">RoleAssociationClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of Roles which needs to be associated</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AccessLevelClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AccessLevelClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The various access levels</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AccessLevelClass.PRIVATE">
|
||
<span class="sig-name descname"><span class="pre">PRIVATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PRIVATE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AccessLevelClass.PUBLIC">
|
||
<span class="sig-name descname"><span class="pre">PUBLIC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PUBLIC'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ActorsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ActorsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">users</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Provisioned users of a role</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>users</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.RoleUserClass" title="datahub.metadata.schema_classes.RoleUserClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RoleUserClass</span></code></a>]])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ActorsClass.users">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">users</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.RoleUserClass" title="datahub.metadata.schema_classes.RoleUserClass"><span class="pre">RoleUserClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of provisioned users of a role</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ArrayTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ArrayTypeClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nestedType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Array field type.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>nestedType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ArrayTypeClass.nestedType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nestedType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of types this array holds.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AspectBag</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">TypedDict</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.access">
|
||
<span class="sig-name descname"><span class="pre">access</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AccessClass" title="datahub.metadata.schema_classes.AccessClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccessClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.actors">
|
||
<span class="sig-name descname"><span class="pre">actors</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ActorsClass" title="datahub.metadata.schema_classes.ActorsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ActorsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.assertionActions">
|
||
<span class="sig-name descname"><span class="pre">assertionActions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionActionsClass" title="datahub.metadata.schema_classes.AssertionActionsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionActionsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.assertionInfo">
|
||
<span class="sig-name descname"><span class="pre">assertionInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionInfoClass" title="datahub.metadata.schema_classes.AssertionInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.assertionKey">
|
||
<span class="sig-name descname"><span class="pre">assertionKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionKeyClass" title="datahub.metadata.schema_classes.AssertionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.assertionRunEvent">
|
||
<span class="sig-name descname"><span class="pre">assertionRunEvent</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionRunEventClass" title="datahub.metadata.schema_classes.AssertionRunEventClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionRunEventClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.browsePaths">
|
||
<span class="sig-name descname"><span class="pre">browsePaths</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.browsePathsV2">
|
||
<span class="sig-name descname"><span class="pre">browsePathsV2</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsV2Class</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.businessAttributeInfo">
|
||
<span class="sig-name descname"><span class="pre">businessAttributeInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BusinessAttributeInfoClass" title="datahub.metadata.schema_classes.BusinessAttributeInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusinessAttributeInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.businessAttributeKey">
|
||
<span class="sig-name descname"><span class="pre">businessAttributeKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BusinessAttributeKeyClass" title="datahub.metadata.schema_classes.BusinessAttributeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusinessAttributeKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.businessAttributes">
|
||
<span class="sig-name descname"><span class="pre">businessAttributes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BusinessAttributesClass" title="datahub.metadata.schema_classes.BusinessAttributesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusinessAttributesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.chartInfo">
|
||
<span class="sig-name descname"><span class="pre">chartInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChartInfoClass" title="datahub.metadata.schema_classes.ChartInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.chartKey">
|
||
<span class="sig-name descname"><span class="pre">chartKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChartKeyClass" title="datahub.metadata.schema_classes.ChartKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.chartQuery">
|
||
<span class="sig-name descname"><span class="pre">chartQuery</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChartQueryClass" title="datahub.metadata.schema_classes.ChartQueryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartQueryClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.chartUsageStatistics">
|
||
<span class="sig-name descname"><span class="pre">chartUsageStatistics</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChartUsageStatisticsClass" title="datahub.metadata.schema_classes.ChartUsageStatisticsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartUsageStatisticsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.container">
|
||
<span class="sig-name descname"><span class="pre">container</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ContainerClass" title="datahub.metadata.schema_classes.ContainerClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContainerClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.containerKey">
|
||
<span class="sig-name descname"><span class="pre">containerKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ContainerKeyClass" title="datahub.metadata.schema_classes.ContainerKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContainerKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.containerProperties">
|
||
<span class="sig-name descname"><span class="pre">containerProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ContainerPropertiesClass" title="datahub.metadata.schema_classes.ContainerPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContainerPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.corpGroupEditableInfo">
|
||
<span class="sig-name descname"><span class="pre">corpGroupEditableInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpGroupEditableInfoClass" title="datahub.metadata.schema_classes.CorpGroupEditableInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpGroupEditableInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.corpGroupInfo">
|
||
<span class="sig-name descname"><span class="pre">corpGroupInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpGroupInfoClass" title="datahub.metadata.schema_classes.CorpGroupInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpGroupInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.corpGroupKey">
|
||
<span class="sig-name descname"><span class="pre">corpGroupKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpGroupKeyClass" title="datahub.metadata.schema_classes.CorpGroupKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpGroupKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.corpUserCredentials">
|
||
<span class="sig-name descname"><span class="pre">corpUserCredentials</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserCredentialsClass" title="datahub.metadata.schema_classes.CorpUserCredentialsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserCredentialsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.corpUserEditableInfo">
|
||
<span class="sig-name descname"><span class="pre">corpUserEditableInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserEditableInfoClass" title="datahub.metadata.schema_classes.CorpUserEditableInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserEditableInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.corpUserInfo">
|
||
<span class="sig-name descname"><span class="pre">corpUserInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserInfoClass" title="datahub.metadata.schema_classes.CorpUserInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.corpUserKey">
|
||
<span class="sig-name descname"><span class="pre">corpUserKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserKeyClass" title="datahub.metadata.schema_classes.CorpUserKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.corpUserSettings">
|
||
<span class="sig-name descname"><span class="pre">corpUserSettings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserSettingsClass" title="datahub.metadata.schema_classes.CorpUserSettingsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserSettingsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.corpUserStatus">
|
||
<span class="sig-name descname"><span class="pre">corpUserStatus</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserStatusClass" title="datahub.metadata.schema_classes.CorpUserStatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserStatusClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.cost">
|
||
<span class="sig-name descname"><span class="pre">cost</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CostClass" title="datahub.metadata.schema_classes.CostClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CostClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dashboardInfo">
|
||
<span class="sig-name descname"><span class="pre">dashboardInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DashboardInfoClass" title="datahub.metadata.schema_classes.DashboardInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dashboardKey">
|
||
<span class="sig-name descname"><span class="pre">dashboardKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DashboardKeyClass" title="datahub.metadata.schema_classes.DashboardKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dashboardUsageStatistics">
|
||
<span class="sig-name descname"><span class="pre">dashboardUsageStatistics</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DashboardUsageStatisticsClass" title="datahub.metadata.schema_classes.DashboardUsageStatisticsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardUsageStatisticsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataContractKey">
|
||
<span class="sig-name descname"><span class="pre">dataContractKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataContractKeyClass" title="datahub.metadata.schema_classes.DataContractKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataContractKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataContractProperties">
|
||
<span class="sig-name descname"><span class="pre">dataContractProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataContractPropertiesClass" title="datahub.metadata.schema_classes.DataContractPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataContractPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataContractStatus">
|
||
<span class="sig-name descname"><span class="pre">dataContractStatus</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataContractStatusClass" title="datahub.metadata.schema_classes.DataContractStatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataContractStatusClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataFlowInfo">
|
||
<span class="sig-name descname"><span class="pre">dataFlowInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataFlowInfoClass" title="datahub.metadata.schema_classes.DataFlowInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataFlowKey">
|
||
<span class="sig-name descname"><span class="pre">dataFlowKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataFlowKeyClass" title="datahub.metadata.schema_classes.DataFlowKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubAccessTokenInfo">
|
||
<span class="sig-name descname"><span class="pre">dataHubAccessTokenInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubAccessTokenInfoClass" title="datahub.metadata.schema_classes.DataHubAccessTokenInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubAccessTokenInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubAccessTokenKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubAccessTokenKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubAccessTokenKeyClass" title="datahub.metadata.schema_classes.DataHubAccessTokenKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubAccessTokenKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubActionKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubActionKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubActionKeyClass" title="datahub.metadata.schema_classes.DataHubActionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubActionKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubConnectionDetails">
|
||
<span class="sig-name descname"><span class="pre">dataHubConnectionDetails</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubConnectionDetailsClass" title="datahub.metadata.schema_classes.DataHubConnectionDetailsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubConnectionDetailsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubConnectionKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubConnectionKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubConnectionKeyClass" title="datahub.metadata.schema_classes.DataHubConnectionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubConnectionKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubExecutionRequestInput">
|
||
<span class="sig-name descname"><span class="pre">dataHubExecutionRequestInput</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ExecutionRequestInputClass" title="datahub.metadata.schema_classes.ExecutionRequestInputClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutionRequestInputClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubExecutionRequestKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubExecutionRequestKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ExecutionRequestKeyClass" title="datahub.metadata.schema_classes.ExecutionRequestKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutionRequestKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubExecutionRequestResult">
|
||
<span class="sig-name descname"><span class="pre">dataHubExecutionRequestResult</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ExecutionRequestResultClass" title="datahub.metadata.schema_classes.ExecutionRequestResultClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutionRequestResultClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubExecutionRequestSignal">
|
||
<span class="sig-name descname"><span class="pre">dataHubExecutionRequestSignal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ExecutionRequestSignalClass" title="datahub.metadata.schema_classes.ExecutionRequestSignalClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutionRequestSignalClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubIngestionSourceInfo">
|
||
<span class="sig-name descname"><span class="pre">dataHubIngestionSourceInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass" title="datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubIngestionSourceInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubIngestionSourceKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubIngestionSourceKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass" title="datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubIngestionSourceKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubOpenAPISchemaKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubOpenAPISchemaKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass" title="datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubOpenAPISchemaKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubPersonaInfo">
|
||
<span class="sig-name descname"><span class="pre">dataHubPersonaInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubPersonaInfoClass" title="datahub.metadata.schema_classes.DataHubPersonaInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPersonaInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubPersonaKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubPersonaKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubPersonaKeyClass" title="datahub.metadata.schema_classes.DataHubPersonaKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPersonaKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubPolicyInfo">
|
||
<span class="sig-name descname"><span class="pre">dataHubPolicyInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubPolicyInfoClass" title="datahub.metadata.schema_classes.DataHubPolicyInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPolicyInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubPolicyKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubPolicyKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubPolicyKeyClass" title="datahub.metadata.schema_classes.DataHubPolicyKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPolicyKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubRetentionConfig">
|
||
<span class="sig-name descname"><span class="pre">dataHubRetentionConfig</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubRetentionConfigClass" title="datahub.metadata.schema_classes.DataHubRetentionConfigClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRetentionConfigClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubRetentionKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubRetentionKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubRetentionKeyClass" title="datahub.metadata.schema_classes.DataHubRetentionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRetentionKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubRoleInfo">
|
||
<span class="sig-name descname"><span class="pre">dataHubRoleInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubRoleInfoClass" title="datahub.metadata.schema_classes.DataHubRoleInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRoleInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubRoleKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubRoleKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubRoleKeyClass" title="datahub.metadata.schema_classes.DataHubRoleKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRoleKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubSecretKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubSecretKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubSecretKeyClass" title="datahub.metadata.schema_classes.DataHubSecretKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubSecretKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubSecretValue">
|
||
<span class="sig-name descname"><span class="pre">dataHubSecretValue</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubSecretValueClass" title="datahub.metadata.schema_classes.DataHubSecretValueClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubSecretValueClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubStepStateKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubStepStateKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubStepStateKeyClass" title="datahub.metadata.schema_classes.DataHubStepStateKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubStepStateKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubStepStateProperties">
|
||
<span class="sig-name descname"><span class="pre">dataHubStepStateProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubStepStatePropertiesClass" title="datahub.metadata.schema_classes.DataHubStepStatePropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubStepStatePropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubUpgradeKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubUpgradeKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubUpgradeKeyClass" title="datahub.metadata.schema_classes.DataHubUpgradeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubUpgradeKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubUpgradeRequest">
|
||
<span class="sig-name descname"><span class="pre">dataHubUpgradeRequest</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubUpgradeRequestClass" title="datahub.metadata.schema_classes.DataHubUpgradeRequestClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubUpgradeRequestClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubUpgradeResult">
|
||
<span class="sig-name descname"><span class="pre">dataHubUpgradeResult</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubUpgradeResultClass" title="datahub.metadata.schema_classes.DataHubUpgradeResultClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubUpgradeResultClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubViewInfo">
|
||
<span class="sig-name descname"><span class="pre">dataHubViewInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubViewInfoClass" title="datahub.metadata.schema_classes.DataHubViewInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubViewInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataHubViewKey">
|
||
<span class="sig-name descname"><span class="pre">dataHubViewKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubViewKeyClass" title="datahub.metadata.schema_classes.DataHubViewKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubViewKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataJobInfo">
|
||
<span class="sig-name descname"><span class="pre">dataJobInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataJobInfoClass" title="datahub.metadata.schema_classes.DataJobInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataJobInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataJobInputOutput">
|
||
<span class="sig-name descname"><span class="pre">dataJobInputOutput</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataJobInputOutputClass" title="datahub.metadata.schema_classes.DataJobInputOutputClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataJobInputOutputClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataJobKey">
|
||
<span class="sig-name descname"><span class="pre">dataJobKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataJobKeyClass" title="datahub.metadata.schema_classes.DataJobKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataJobKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataPlatformInfo">
|
||
<span class="sig-name descname"><span class="pre">dataPlatformInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInfoClass" title="datahub.metadata.schema_classes.DataPlatformInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataPlatformInstance">
|
||
<span class="sig-name descname"><span class="pre">dataPlatformInstance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataPlatformInstanceKey">
|
||
<span class="sig-name descname"><span class="pre">dataPlatformInstanceKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceKeyClass" title="datahub.metadata.schema_classes.DataPlatformInstanceKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataPlatformInstanceProperties">
|
||
<span class="sig-name descname"><span class="pre">dataPlatformInstanceProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass" title="datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstancePropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataPlatformKey">
|
||
<span class="sig-name descname"><span class="pre">dataPlatformKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformKeyClass" title="datahub.metadata.schema_classes.DataPlatformKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataProcessInfo">
|
||
<span class="sig-name descname"><span class="pre">dataProcessInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessInfoClass" title="datahub.metadata.schema_classes.DataProcessInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataProcessInstanceInput">
|
||
<span class="sig-name descname"><span class="pre">dataProcessInstanceInput</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessInstanceInputClass" title="datahub.metadata.schema_classes.DataProcessInstanceInputClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInstanceInputClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataProcessInstanceKey">
|
||
<span class="sig-name descname"><span class="pre">dataProcessInstanceKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessInstanceKeyClass" title="datahub.metadata.schema_classes.DataProcessInstanceKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInstanceKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataProcessInstanceOutput">
|
||
<span class="sig-name descname"><span class="pre">dataProcessInstanceOutput</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessInstanceOutputClass" title="datahub.metadata.schema_classes.DataProcessInstanceOutputClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInstanceOutputClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataProcessInstanceProperties">
|
||
<span class="sig-name descname"><span class="pre">dataProcessInstanceProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessInstancePropertiesClass" title="datahub.metadata.schema_classes.DataProcessInstancePropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInstancePropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataProcessInstanceRelationships">
|
||
<span class="sig-name descname"><span class="pre">dataProcessInstanceRelationships</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass" title="datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInstanceRelationshipsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataProcessInstanceRunEvent">
|
||
<span class="sig-name descname"><span class="pre">dataProcessInstanceRunEvent</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessInstanceRunEventClass" title="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInstanceRunEventClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataProcessKey">
|
||
<span class="sig-name descname"><span class="pre">dataProcessKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessKeyClass" title="datahub.metadata.schema_classes.DataProcessKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataProductKey">
|
||
<span class="sig-name descname"><span class="pre">dataProductKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProductKeyClass" title="datahub.metadata.schema_classes.DataProductKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProductKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataProductProperties">
|
||
<span class="sig-name descname"><span class="pre">dataProductProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProductPropertiesClass" title="datahub.metadata.schema_classes.DataProductPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProductPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataTransformLogic">
|
||
<span class="sig-name descname"><span class="pre">dataTransformLogic</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataTransformLogicClass" title="datahub.metadata.schema_classes.DataTransformLogicClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataTransformLogicClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataTypeInfo">
|
||
<span class="sig-name descname"><span class="pre">dataTypeInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataTypeInfoClass" title="datahub.metadata.schema_classes.DataTypeInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataTypeInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dataTypeKey">
|
||
<span class="sig-name descname"><span class="pre">dataTypeKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataTypeKeyClass" title="datahub.metadata.schema_classes.DataTypeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataTypeKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.datahubIngestionCheckpoint">
|
||
<span class="sig-name descname"><span class="pre">datahubIngestionCheckpoint</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatahubIngestionCheckpointClass" title="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatahubIngestionCheckpointClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.datahubIngestionRunSummary">
|
||
<span class="sig-name descname"><span class="pre">datahubIngestionRunSummary</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass" title="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatahubIngestionRunSummaryClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.datasetDeprecation">
|
||
<span class="sig-name descname"><span class="pre">datasetDeprecation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetDeprecationClass" title="datahub.metadata.schema_classes.DatasetDeprecationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetDeprecationClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.datasetKey">
|
||
<span class="sig-name descname"><span class="pre">datasetKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetKeyClass" title="datahub.metadata.schema_classes.DatasetKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.datasetProfile">
|
||
<span class="sig-name descname"><span class="pre">datasetProfile</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetProfileClass" title="datahub.metadata.schema_classes.DatasetProfileClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetProfileClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.datasetProperties">
|
||
<span class="sig-name descname"><span class="pre">datasetProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetPropertiesClass" title="datahub.metadata.schema_classes.DatasetPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.datasetUpstreamLineage">
|
||
<span class="sig-name descname"><span class="pre">datasetUpstreamLineage</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetUpstreamLineageClass" title="datahub.metadata.schema_classes.DatasetUpstreamLineageClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetUpstreamLineageClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.datasetUsageStatistics">
|
||
<span class="sig-name descname"><span class="pre">datasetUsageStatistics</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetUsageStatisticsClass" title="datahub.metadata.schema_classes.DatasetUsageStatisticsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetUsageStatisticsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.deprecation">
|
||
<span class="sig-name descname"><span class="pre">deprecation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeprecationClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.displayProperties">
|
||
<span class="sig-name descname"><span class="pre">displayProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DisplayPropertiesClass" title="datahub.metadata.schema_classes.DisplayPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.documentation">
|
||
<span class="sig-name descname"><span class="pre">documentation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DocumentationClass" title="datahub.metadata.schema_classes.DocumentationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DocumentationClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.domainKey">
|
||
<span class="sig-name descname"><span class="pre">domainKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DomainKeyClass" title="datahub.metadata.schema_classes.DomainKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DomainKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.domainProperties">
|
||
<span class="sig-name descname"><span class="pre">domainProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DomainPropertiesClass" title="datahub.metadata.schema_classes.DomainPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DomainPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.domains">
|
||
<span class="sig-name descname"><span class="pre">domains</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DomainsClass" title="datahub.metadata.schema_classes.DomainsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DomainsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.dynamicFormAssignment">
|
||
<span class="sig-name descname"><span class="pre">dynamicFormAssignment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DynamicFormAssignmentClass" title="datahub.metadata.schema_classes.DynamicFormAssignmentClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DynamicFormAssignmentClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableChartProperties">
|
||
<span class="sig-name descname"><span class="pre">editableChartProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableChartPropertiesClass" title="datahub.metadata.schema_classes.EditableChartPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableChartPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableContainerProperties">
|
||
<span class="sig-name descname"><span class="pre">editableContainerProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableContainerPropertiesClass" title="datahub.metadata.schema_classes.EditableContainerPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableContainerPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableDashboardProperties">
|
||
<span class="sig-name descname"><span class="pre">editableDashboardProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableDashboardPropertiesClass" title="datahub.metadata.schema_classes.EditableDashboardPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableDashboardPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableDataFlowProperties">
|
||
<span class="sig-name descname"><span class="pre">editableDataFlowProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableDataFlowPropertiesClass" title="datahub.metadata.schema_classes.EditableDataFlowPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableDataFlowPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableDataJobProperties">
|
||
<span class="sig-name descname"><span class="pre">editableDataJobProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableDataJobPropertiesClass" title="datahub.metadata.schema_classes.EditableDataJobPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableDataJobPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableDatasetProperties">
|
||
<span class="sig-name descname"><span class="pre">editableDatasetProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableDatasetPropertiesClass" title="datahub.metadata.schema_classes.EditableDatasetPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableDatasetPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableERModelRelationshipProperties">
|
||
<span class="sig-name descname"><span class="pre">editableERModelRelationshipProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass" title="datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableERModelRelationshipPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableMlFeatureProperties">
|
||
<span class="sig-name descname"><span class="pre">editableMlFeatureProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableMLFeaturePropertiesClass" title="datahub.metadata.schema_classes.EditableMLFeaturePropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableMLFeaturePropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableMlFeatureTableProperties">
|
||
<span class="sig-name descname"><span class="pre">editableMlFeatureTableProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableMLFeatureTablePropertiesClass" title="datahub.metadata.schema_classes.EditableMLFeatureTablePropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableMLFeatureTablePropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableMlModelGroupProperties">
|
||
<span class="sig-name descname"><span class="pre">editableMlModelGroupProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableMLModelGroupPropertiesClass" title="datahub.metadata.schema_classes.EditableMLModelGroupPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableMLModelGroupPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableMlModelProperties">
|
||
<span class="sig-name descname"><span class="pre">editableMlModelProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableMLModelPropertiesClass" title="datahub.metadata.schema_classes.EditableMLModelPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableMLModelPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableMlPrimaryKeyProperties">
|
||
<span class="sig-name descname"><span class="pre">editableMlPrimaryKeyProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableMLPrimaryKeyPropertiesClass" title="datahub.metadata.schema_classes.EditableMLPrimaryKeyPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableMLPrimaryKeyPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableNotebookProperties">
|
||
<span class="sig-name descname"><span class="pre">editableNotebookProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableNotebookPropertiesClass" title="datahub.metadata.schema_classes.EditableNotebookPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableNotebookPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.editableSchemaMetadata">
|
||
<span class="sig-name descname"><span class="pre">editableSchemaMetadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableSchemaMetadataClass" title="datahub.metadata.schema_classes.EditableSchemaMetadataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableSchemaMetadataClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.embed">
|
||
<span class="sig-name descname"><span class="pre">embed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EmbedClass" title="datahub.metadata.schema_classes.EmbedClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EmbedClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.entityTypeInfo">
|
||
<span class="sig-name descname"><span class="pre">entityTypeInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EntityTypeInfoClass" title="datahub.metadata.schema_classes.EntityTypeInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EntityTypeInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.entityTypeKey">
|
||
<span class="sig-name descname"><span class="pre">entityTypeKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EntityTypeKeyClass" title="datahub.metadata.schema_classes.EntityTypeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EntityTypeKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.erModelRelationshipKey">
|
||
<span class="sig-name descname"><span class="pre">erModelRelationshipKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ERModelRelationshipKeyClass" title="datahub.metadata.schema_classes.ERModelRelationshipKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ERModelRelationshipKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.erModelRelationshipProperties">
|
||
<span class="sig-name descname"><span class="pre">erModelRelationshipProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass" title="datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ERModelRelationshipPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.formInfo">
|
||
<span class="sig-name descname"><span class="pre">formInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FormInfoClass" title="datahub.metadata.schema_classes.FormInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.formKey">
|
||
<span class="sig-name descname"><span class="pre">formKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FormKeyClass" title="datahub.metadata.schema_classes.FormKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.forms">
|
||
<span class="sig-name descname"><span class="pre">forms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FormsClass" title="datahub.metadata.schema_classes.FormsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.globalSettingsInfo">
|
||
<span class="sig-name descname"><span class="pre">globalSettingsInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalSettingsInfoClass" title="datahub.metadata.schema_classes.GlobalSettingsInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalSettingsInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.globalSettingsKey">
|
||
<span class="sig-name descname"><span class="pre">globalSettingsKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalSettingsKeyClass" title="datahub.metadata.schema_classes.GlobalSettingsKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalSettingsKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.globalTags">
|
||
<span class="sig-name descname"><span class="pre">globalTags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.glossaryNodeInfo">
|
||
<span class="sig-name descname"><span class="pre">glossaryNodeInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryNodeInfoClass" title="datahub.metadata.schema_classes.GlossaryNodeInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryNodeInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.glossaryNodeKey">
|
||
<span class="sig-name descname"><span class="pre">glossaryNodeKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryNodeKeyClass" title="datahub.metadata.schema_classes.GlossaryNodeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryNodeKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.glossaryRelatedTerms">
|
||
<span class="sig-name descname"><span class="pre">glossaryRelatedTerms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryRelatedTermsClass" title="datahub.metadata.schema_classes.GlossaryRelatedTermsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryRelatedTermsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.glossaryTermInfo">
|
||
<span class="sig-name descname"><span class="pre">glossaryTermInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermInfoClass" title="datahub.metadata.schema_classes.GlossaryTermInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.glossaryTermKey">
|
||
<span class="sig-name descname"><span class="pre">glossaryTermKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermKeyClass" title="datahub.metadata.schema_classes.GlossaryTermKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.glossaryTerms">
|
||
<span class="sig-name descname"><span class="pre">glossaryTerms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.groupMembership">
|
||
<span class="sig-name descname"><span class="pre">groupMembership</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GroupMembershipClass" title="datahub.metadata.schema_classes.GroupMembershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GroupMembershipClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.icebergCatalogInfo">
|
||
<span class="sig-name descname"><span class="pre">icebergCatalogInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IcebergCatalogInfoClass" title="datahub.metadata.schema_classes.IcebergCatalogInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IcebergCatalogInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.icebergWarehouseInfo">
|
||
<span class="sig-name descname"><span class="pre">icebergWarehouseInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IcebergWarehouseInfoClass" title="datahub.metadata.schema_classes.IcebergWarehouseInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IcebergWarehouseInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.incidentInfo">
|
||
<span class="sig-name descname"><span class="pre">incidentInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentInfoClass" title="datahub.metadata.schema_classes.IncidentInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.incidentKey">
|
||
<span class="sig-name descname"><span class="pre">incidentKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentKeyClass" title="datahub.metadata.schema_classes.IncidentKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.incidentSource">
|
||
<span class="sig-name descname"><span class="pre">incidentSource</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentSourceClass" title="datahub.metadata.schema_classes.IncidentSourceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentSourceClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.incidentsSummary">
|
||
<span class="sig-name descname"><span class="pre">incidentsSummary</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentsSummaryClass" title="datahub.metadata.schema_classes.IncidentsSummaryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentsSummaryClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.inputFields">
|
||
<span class="sig-name descname"><span class="pre">inputFields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InputFieldsClass" title="datahub.metadata.schema_classes.InputFieldsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InputFieldsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.institutionalMemory">
|
||
<span class="sig-name descname"><span class="pre">institutionalMemory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstitutionalMemoryClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.intendedUse">
|
||
<span class="sig-name descname"><span class="pre">intendedUse</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IntendedUseClass" title="datahub.metadata.schema_classes.IntendedUseClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntendedUseClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.inviteToken">
|
||
<span class="sig-name descname"><span class="pre">inviteToken</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InviteTokenClass" title="datahub.metadata.schema_classes.InviteTokenClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InviteTokenClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.inviteTokenKey">
|
||
<span class="sig-name descname"><span class="pre">inviteTokenKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InviteTokenKeyClass" title="datahub.metadata.schema_classes.InviteTokenKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InviteTokenKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlFeatureKey">
|
||
<span class="sig-name descname"><span class="pre">mlFeatureKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureKeyClass" title="datahub.metadata.schema_classes.MLFeatureKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlFeatureProperties">
|
||
<span class="sig-name descname"><span class="pre">mlFeatureProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLFeaturePropertiesClass" title="datahub.metadata.schema_classes.MLFeaturePropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeaturePropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlFeatureTableKey">
|
||
<span class="sig-name descname"><span class="pre">mlFeatureTableKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureTableKeyClass" title="datahub.metadata.schema_classes.MLFeatureTableKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureTableKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlFeatureTableProperties">
|
||
<span class="sig-name descname"><span class="pre">mlFeatureTableProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureTablePropertiesClass" title="datahub.metadata.schema_classes.MLFeatureTablePropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureTablePropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlHyperParam">
|
||
<span class="sig-name descname"><span class="pre">mlHyperParam</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLHyperParamClass" title="datahub.metadata.schema_classes.MLHyperParamClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLHyperParamClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlMetric">
|
||
<span class="sig-name descname"><span class="pre">mlMetric</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLMetricClass" title="datahub.metadata.schema_classes.MLMetricClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLMetricClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelCaveatsAndRecommendations">
|
||
<span class="sig-name descname"><span class="pre">mlModelCaveatsAndRecommendations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CaveatsAndRecommendationsClass" title="datahub.metadata.schema_classes.CaveatsAndRecommendationsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CaveatsAndRecommendationsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelDeploymentKey">
|
||
<span class="sig-name descname"><span class="pre">mlModelDeploymentKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelDeploymentKeyClass" title="datahub.metadata.schema_classes.MLModelDeploymentKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelDeploymentKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelDeploymentProperties">
|
||
<span class="sig-name descname"><span class="pre">mlModelDeploymentProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass" title="datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelDeploymentPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelEthicalConsiderations">
|
||
<span class="sig-name descname"><span class="pre">mlModelEthicalConsiderations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EthicalConsiderationsClass" title="datahub.metadata.schema_classes.EthicalConsiderationsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EthicalConsiderationsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelEvaluationData">
|
||
<span class="sig-name descname"><span class="pre">mlModelEvaluationData</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EvaluationDataClass" title="datahub.metadata.schema_classes.EvaluationDataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvaluationDataClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelFactorPrompts">
|
||
<span class="sig-name descname"><span class="pre">mlModelFactorPrompts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelFactorPromptsClass" title="datahub.metadata.schema_classes.MLModelFactorPromptsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelFactorPromptsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelGroupKey">
|
||
<span class="sig-name descname"><span class="pre">mlModelGroupKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelGroupKeyClass" title="datahub.metadata.schema_classes.MLModelGroupKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelGroupKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelGroupProperties">
|
||
<span class="sig-name descname"><span class="pre">mlModelGroupProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelGroupPropertiesClass" title="datahub.metadata.schema_classes.MLModelGroupPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelGroupPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelKey">
|
||
<span class="sig-name descname"><span class="pre">mlModelKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelKeyClass" title="datahub.metadata.schema_classes.MLModelKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelMetrics">
|
||
<span class="sig-name descname"><span class="pre">mlModelMetrics</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MetricsClass" title="datahub.metadata.schema_classes.MetricsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetricsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelProperties">
|
||
<span class="sig-name descname"><span class="pre">mlModelProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelPropertiesClass" title="datahub.metadata.schema_classes.MLModelPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelQuantitativeAnalyses">
|
||
<span class="sig-name descname"><span class="pre">mlModelQuantitativeAnalyses</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.QuantitativeAnalysesClass" title="datahub.metadata.schema_classes.QuantitativeAnalysesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QuantitativeAnalysesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlModelTrainingData">
|
||
<span class="sig-name descname"><span class="pre">mlModelTrainingData</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TrainingDataClass" title="datahub.metadata.schema_classes.TrainingDataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrainingDataClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlPrimaryKeyKey">
|
||
<span class="sig-name descname"><span class="pre">mlPrimaryKeyKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLPrimaryKeyKeyClass" title="datahub.metadata.schema_classes.MLPrimaryKeyKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLPrimaryKeyKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlPrimaryKeyProperties">
|
||
<span class="sig-name descname"><span class="pre">mlPrimaryKeyProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass" title="datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLPrimaryKeyPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.mlTrainingRunProperties">
|
||
<span class="sig-name descname"><span class="pre">mlTrainingRunProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLTrainingRunPropertiesClass" title="datahub.metadata.schema_classes.MLTrainingRunPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLTrainingRunPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.nativeGroupMembership">
|
||
<span class="sig-name descname"><span class="pre">nativeGroupMembership</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.NativeGroupMembershipClass" title="datahub.metadata.schema_classes.NativeGroupMembershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">NativeGroupMembershipClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.notebookContent">
|
||
<span class="sig-name descname"><span class="pre">notebookContent</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.NotebookContentClass" title="datahub.metadata.schema_classes.NotebookContentClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotebookContentClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.notebookInfo">
|
||
<span class="sig-name descname"><span class="pre">notebookInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.NotebookInfoClass" title="datahub.metadata.schema_classes.NotebookInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotebookInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.notebookKey">
|
||
<span class="sig-name descname"><span class="pre">notebookKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.NotebookKeyClass" title="datahub.metadata.schema_classes.NotebookKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotebookKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.operation">
|
||
<span class="sig-name descname"><span class="pre">operation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OperationClass" title="datahub.metadata.schema_classes.OperationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.origin">
|
||
<span class="sig-name descname"><span class="pre">origin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OriginClass" title="datahub.metadata.schema_classes.OriginClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OriginClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.ownership">
|
||
<span class="sig-name descname"><span class="pre">ownership</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.ownershipTypeInfo">
|
||
<span class="sig-name descname"><span class="pre">ownershipTypeInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipTypeInfoClass" title="datahub.metadata.schema_classes.OwnershipTypeInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipTypeInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.ownershipTypeKey">
|
||
<span class="sig-name descname"><span class="pre">ownershipTypeKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipTypeKeyClass" title="datahub.metadata.schema_classes.OwnershipTypeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipTypeKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.partitionsSummary">
|
||
<span class="sig-name descname"><span class="pre">partitionsSummary</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionsSummaryClass" title="datahub.metadata.schema_classes.PartitionsSummaryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionsSummaryClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.platformResourceInfo">
|
||
<span class="sig-name descname"><span class="pre">platformResourceInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PlatformResourceInfoClass" title="datahub.metadata.schema_classes.PlatformResourceInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlatformResourceInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.platformResourceKey">
|
||
<span class="sig-name descname"><span class="pre">platformResourceKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PlatformResourceKeyClass" title="datahub.metadata.schema_classes.PlatformResourceKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlatformResourceKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.postInfo">
|
||
<span class="sig-name descname"><span class="pre">postInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PostInfoClass" title="datahub.metadata.schema_classes.PostInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PostInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.postKey">
|
||
<span class="sig-name descname"><span class="pre">postKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PostKeyClass" title="datahub.metadata.schema_classes.PostKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PostKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.propertyDefinition">
|
||
<span class="sig-name descname"><span class="pre">propertyDefinition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StructuredPropertyDefinitionClass" title="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructuredPropertyDefinitionClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.queryKey">
|
||
<span class="sig-name descname"><span class="pre">queryKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.QueryKeyClass" title="datahub.metadata.schema_classes.QueryKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.queryProperties">
|
||
<span class="sig-name descname"><span class="pre">queryProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.QueryPropertiesClass" title="datahub.metadata.schema_classes.QueryPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.querySubjects">
|
||
<span class="sig-name descname"><span class="pre">querySubjects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.QuerySubjectsClass" title="datahub.metadata.schema_classes.QuerySubjectsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QuerySubjectsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.queryUsageStatistics">
|
||
<span class="sig-name descname"><span class="pre">queryUsageStatistics</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.QueryUsageStatisticsClass" title="datahub.metadata.schema_classes.QueryUsageStatisticsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryUsageStatisticsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.roleKey">
|
||
<span class="sig-name descname"><span class="pre">roleKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.RoleKeyClass" title="datahub.metadata.schema_classes.RoleKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RoleKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.roleMembership">
|
||
<span class="sig-name descname"><span class="pre">roleMembership</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.RoleMembershipClass" title="datahub.metadata.schema_classes.RoleMembershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RoleMembershipClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.roleProperties">
|
||
<span class="sig-name descname"><span class="pre">roleProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.RolePropertiesClass" title="datahub.metadata.schema_classes.RolePropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RolePropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.schemaFieldAliases">
|
||
<span class="sig-name descname"><span class="pre">schemaFieldAliases</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldAliasesClass" title="datahub.metadata.schema_classes.SchemaFieldAliasesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldAliasesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.schemaFieldKey">
|
||
<span class="sig-name descname"><span class="pre">schemaFieldKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldKeyClass" title="datahub.metadata.schema_classes.SchemaFieldKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.schemaMetadata">
|
||
<span class="sig-name descname"><span class="pre">schemaMetadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaMetadataClass" title="datahub.metadata.schema_classes.SchemaMetadataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaMetadataClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.schemafieldInfo">
|
||
<span class="sig-name descname"><span class="pre">schemafieldInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldInfoClass" title="datahub.metadata.schema_classes.SchemaFieldInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.siblings">
|
||
<span class="sig-name descname"><span class="pre">siblings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SiblingsClass" title="datahub.metadata.schema_classes.SiblingsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SiblingsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.slackUserInfo">
|
||
<span class="sig-name descname"><span class="pre">slackUserInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SlackUserInfoClass" title="datahub.metadata.schema_classes.SlackUserInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SlackUserInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.sourceCode">
|
||
<span class="sig-name descname"><span class="pre">sourceCode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SourceCodeClass" title="datahub.metadata.schema_classes.SourceCodeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceCodeClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.status">
|
||
<span class="sig-name descname"><span class="pre">status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.structuredProperties">
|
||
<span class="sig-name descname"><span class="pre">structuredProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StructuredPropertiesClass" title="datahub.metadata.schema_classes.StructuredPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructuredPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.structuredPropertyKey">
|
||
<span class="sig-name descname"><span class="pre">structuredPropertyKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StructuredPropertyKeyClass" title="datahub.metadata.schema_classes.StructuredPropertyKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructuredPropertyKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.structuredPropertySettings">
|
||
<span class="sig-name descname"><span class="pre">structuredPropertySettings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StructuredPropertySettingsClass" title="datahub.metadata.schema_classes.StructuredPropertySettingsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructuredPropertySettingsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.subTypes">
|
||
<span class="sig-name descname"><span class="pre">subTypes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SubTypesClass" title="datahub.metadata.schema_classes.SubTypesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubTypesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.systemMetadata">
|
||
<span class="sig-name descname"><span class="pre">systemMetadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SystemMetadataClass" title="datahub.metadata.schema_classes.SystemMetadataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SystemMetadataClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.tagKey">
|
||
<span class="sig-name descname"><span class="pre">tagKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TagKeyClass" title="datahub.metadata.schema_classes.TagKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.tagProperties">
|
||
<span class="sig-name descname"><span class="pre">tagProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TagPropertiesClass" title="datahub.metadata.schema_classes.TagPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.telemetryClientId">
|
||
<span class="sig-name descname"><span class="pre">telemetryClientId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TelemetryClientIdClass" title="datahub.metadata.schema_classes.TelemetryClientIdClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TelemetryClientIdClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.telemetryKey">
|
||
<span class="sig-name descname"><span class="pre">telemetryKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TelemetryKeyClass" title="datahub.metadata.schema_classes.TelemetryKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TelemetryKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.testInfo">
|
||
<span class="sig-name descname"><span class="pre">testInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TestInfoClass" title="datahub.metadata.schema_classes.TestInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TestInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.testKey">
|
||
<span class="sig-name descname"><span class="pre">testKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TestKeyClass" title="datahub.metadata.schema_classes.TestKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TestKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.testResults">
|
||
<span class="sig-name descname"><span class="pre">testResults</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TestResultsClass" title="datahub.metadata.schema_classes.TestResultsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TestResultsClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.upstreamLineage">
|
||
<span class="sig-name descname"><span class="pre">upstreamLineage</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.UpstreamLineageClass" title="datahub.metadata.schema_classes.UpstreamLineageClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpstreamLineageClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.versionInfo">
|
||
<span class="sig-name descname"><span class="pre">versionInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersionInfoClass" title="datahub.metadata.schema_classes.VersionInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionInfoClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.versionProperties">
|
||
<span class="sig-name descname"><span class="pre">versionProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersionPropertiesClass" title="datahub.metadata.schema_classes.VersionPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.versionSetKey">
|
||
<span class="sig-name descname"><span class="pre">versionSetKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersionSetKeyClass" title="datahub.metadata.schema_classes.VersionSetKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionSetKeyClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.versionSetProperties">
|
||
<span class="sig-name descname"><span class="pre">versionSetProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersionSetPropertiesClass" title="datahub.metadata.schema_classes.VersionSetPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionSetPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AspectBag.viewProperties">
|
||
<span class="sig-name descname"><span class="pre">viewProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ViewPropertiesClass" title="datahub.metadata.schema_classes.ViewPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ViewPropertiesClass</span></code></a></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionActionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionActionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>The Actions about an Assertion.
|
||
In the future, we’ll likely extend this model to support additional
|
||
parameters or options related to the assertion actions.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionActionTypeClass" title="datahub.metadata.schema_classes.AssertionActionTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionActionTypeClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionActionClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionActionTypeClass" title="datahub.metadata.schema_classes.AssertionActionTypeClass"><span class="pre">AssertionActionTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the Action</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionActionTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionActionTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionActionTypeClass.RAISE_INCIDENT">
|
||
<span class="sig-name descname"><span class="pre">RAISE_INCIDENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'RAISE_INCIDENT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionActionTypeClass.RESOLVE_INCIDENT">
|
||
<span class="sig-name descname"><span class="pre">RESOLVE_INCIDENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'RESOLVE_INCIDENT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionActionsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionActionsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">onSuccess</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">onFailure</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>The Actions about an Assertion</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>onSuccess</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionActionClass" title="datahub.metadata.schema_classes.AssertionActionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionActionClass</span></code></a>]])</p></li>
|
||
<li><p><strong>onFailure</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionActionClass" title="datahub.metadata.schema_classes.AssertionActionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionActionClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionActionsClass.onFailure">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">onFailure</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionActionClass" title="datahub.metadata.schema_classes.AssertionActionClass"><span class="pre">AssertionActionClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Actions to be executed on failed assertion run.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionActionsClass.onSuccess">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">onSuccess</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionActionClass" title="datahub.metadata.schema_classes.AssertionActionClass"><span class="pre">AssertionActionClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Actions to be executed on successful assertion run.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datasetAssertion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">freshnessAssertion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volumeAssertion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sqlAssertion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldAssertion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schemaAssertion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customAssertion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastUpdated</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about an assertion</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionTypeClass" title="datahub.metadata.schema_classes.AssertionTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>datasetAssertion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DatasetAssertionInfoClass" title="datahub.metadata.schema_classes.DatasetAssertionInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetAssertionInfoClass</span></code></a>])</p></li>
|
||
<li><p><strong>freshnessAssertion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FreshnessAssertionInfoClass" title="datahub.metadata.schema_classes.FreshnessAssertionInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FreshnessAssertionInfoClass</span></code></a>])</p></li>
|
||
<li><p><strong>volumeAssertion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.VolumeAssertionInfoClass" title="datahub.metadata.schema_classes.VolumeAssertionInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VolumeAssertionInfoClass</span></code></a>])</p></li>
|
||
<li><p><strong>sqlAssertion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SqlAssertionInfoClass" title="datahub.metadata.schema_classes.SqlAssertionInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SqlAssertionInfoClass</span></code></a>])</p></li>
|
||
<li><p><strong>fieldAssertion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FieldAssertionInfoClass" title="datahub.metadata.schema_classes.FieldAssertionInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldAssertionInfoClass</span></code></a>])</p></li>
|
||
<li><p><strong>schemaAssertion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SchemaAssertionInfoClass" title="datahub.metadata.schema_classes.SchemaAssertionInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaAssertionInfoClass</span></code></a>])</p></li>
|
||
<li><p><strong>customAssertion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.CustomAssertionInfoClass" title="datahub.metadata.schema_classes.CustomAssertionInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomAssertionInfoClass</span></code></a>])</p></li>
|
||
<li><p><strong>source</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionSourceClass" title="datahub.metadata.schema_classes.AssertionSourceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionSourceClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastUpdated</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.customAssertion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customAssertion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CustomAssertionInfoClass" title="datahub.metadata.schema_classes.CustomAssertionInfoClass"><span class="pre">CustomAssertionInfoClass</span></a></em></dt>
|
||
<dd><p>A Custom Assertion definition. This field is populated when type is CUSTOM.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.datasetAssertion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">datasetAssertion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetAssertionInfoClass" title="datahub.metadata.schema_classes.DatasetAssertionInfoClass"><span class="pre">DatasetAssertionInfoClass</span></a></em></dt>
|
||
<dd><p>A Dataset Assertion definition. This field is populated when the type is DATASET.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>An optional human-readable description of the assertion</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.fieldAssertion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldAssertion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FieldAssertionInfoClass" title="datahub.metadata.schema_classes.FieldAssertionInfoClass"><span class="pre">FieldAssertionInfoClass</span></a></em></dt>
|
||
<dd><p>A Field Assertion definition. This field is populated when the type is FIELD.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.freshnessAssertion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">freshnessAssertion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FreshnessAssertionInfoClass" title="datahub.metadata.schema_classes.FreshnessAssertionInfoClass"><span class="pre">FreshnessAssertionInfoClass</span></a></em></dt>
|
||
<dd><p>An Freshness Assertion definition. This field is populated when the type is FRESHNESS.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.lastUpdated">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastUpdated</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>The time at which the assertion was last updated and the actor who updated it.
|
||
This field is only present for Native assertions updated after this field was introduced.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.schemaAssertion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schemaAssertion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaAssertionInfoClass" title="datahub.metadata.schema_classes.SchemaAssertionInfoClass"><span class="pre">SchemaAssertionInfoClass</span></a></em></dt>
|
||
<dd><p>An schema Assertion definition. This field is populated when the type is DATA_SCHEMA</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.source">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">source</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionSourceClass" title="datahub.metadata.schema_classes.AssertionSourceClass"><span class="pre">AssertionSourceClass</span></a></em></dt>
|
||
<dd><p>The source or origin of the Assertion definition.</p>
|
||
<p>If the source type of the Assertion is EXTERNAL, it is expected to have a corresponding dataPlatformInstance aspect detailing
|
||
the platform where it was ingested from.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.sqlAssertion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sqlAssertion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SqlAssertionInfoClass" title="datahub.metadata.schema_classes.SqlAssertionInfoClass"><span class="pre">SqlAssertionInfoClass</span></a></em></dt>
|
||
<dd><p>A SQL Assertion definition. This field is populated when the type is SQL.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionTypeClass" title="datahub.metadata.schema_classes.AssertionTypeClass"><span class="pre">AssertionTypeClass</span></a></em></dt>
|
||
<dd><p>Type of assertion. Assertion types can evolve to span Datasets, Flows (Pipelines), Models, Features etc.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionInfoClass.volumeAssertion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">volumeAssertion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VolumeAssertionInfoClass" title="datahub.metadata.schema_classes.VolumeAssertionInfoClass"><span class="pre">VolumeAssertionInfoClass</span></a></em></dt>
|
||
<dd><p>An Volume Assertion definition. This field is populated when the type is VOLUME.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">assertionId</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Assertion</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>assertionId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionKeyClass.assertionId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">assertionId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique id for the assertion.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionResultClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rowCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">missingCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unexpectedCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actualAggValue</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nativeResults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>The result of running an assertion</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionResultTypeClass" title="datahub.metadata.schema_classes.AssertionResultTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionResultTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>rowCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>missingCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>unexpectedCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>actualAggValue</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>])</p></li>
|
||
<li><p><strong>nativeResults</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>error</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionResultErrorClass" title="datahub.metadata.schema_classes.AssertionResultErrorClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionResultErrorClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultClass.actualAggValue">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actualAggValue</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span></em></dt>
|
||
<dd><p>Observed aggregate value for evaluated batch</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultClass.error">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">error</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionResultErrorClass" title="datahub.metadata.schema_classes.AssertionResultErrorClass"><span class="pre">AssertionResultErrorClass</span></a></em></dt>
|
||
<dd><p>The error object if AssertionResultType is an Error</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>External URL where full results are available. Only present when assertion source is not native.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultClass.missingCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">missingCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Number of rows with missing value for evaluated batch</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultClass.nativeResults">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nativeResults</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Other results of evaluation</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultClass.rowCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rowCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Number of rows for evaluated batch</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionResultTypeClass" title="datahub.metadata.schema_classes.AssertionResultTypeClass"><span class="pre">AssertionResultTypeClass</span></a></em></dt>
|
||
<dd><p>The final result, e.g. either SUCCESS, FAILURE, or ERROR.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultClass.unexpectedCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unexpectedCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Number of rows with unexpected value for evaluated batch</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionResultErrorClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">properties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>An error encountered when evaluating an AssertionResult</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionResultErrorTypeClass" title="datahub.metadata.schema_classes.AssertionResultErrorTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionResultErrorTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>properties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorClass.properties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">properties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Additional metadata depending on the type of error</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionResultErrorTypeClass" title="datahub.metadata.schema_classes.AssertionResultErrorTypeClass"><span class="pre">AssertionResultErrorTypeClass</span></a></em></dt>
|
||
<dd><p>The type of error encountered</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionResultErrorTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorTypeClass.CUSTOM_SQL_ERROR">
|
||
<span class="sig-name descname"><span class="pre">CUSTOM_SQL_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CUSTOM_SQL_ERROR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorTypeClass.FIELD_ASSERTION_ERROR">
|
||
<span class="sig-name descname"><span class="pre">FIELD_ASSERTION_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FIELD_ASSERTION_ERROR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorTypeClass.INSUFFICIENT_DATA">
|
||
<span class="sig-name descname"><span class="pre">INSUFFICIENT_DATA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'INSUFFICIENT_DATA'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorTypeClass.INVALID_PARAMETERS">
|
||
<span class="sig-name descname"><span class="pre">INVALID_PARAMETERS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'INVALID_PARAMETERS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorTypeClass.INVALID_SOURCE_TYPE">
|
||
<span class="sig-name descname"><span class="pre">INVALID_SOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'INVALID_SOURCE_TYPE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorTypeClass.SOURCE_CONNECTION_ERROR">
|
||
<span class="sig-name descname"><span class="pre">SOURCE_CONNECTION_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SOURCE_CONNECTION_ERROR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorTypeClass.SOURCE_QUERY_FAILED">
|
||
<span class="sig-name descname"><span class="pre">SOURCE_QUERY_FAILED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SOURCE_QUERY_FAILED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorTypeClass.UNKNOWN_ERROR">
|
||
<span class="sig-name descname"><span class="pre">UNKNOWN_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNKNOWN_ERROR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultErrorTypeClass.UNSUPPORTED_PLATFORM">
|
||
<span class="sig-name descname"><span class="pre">UNSUPPORTED_PLATFORM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNSUPPORTED_PLATFORM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionResultTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The final result of evaluating an assertion, e.g. SUCCESS, FAILURE, or ERROR.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultTypeClass.ERROR">
|
||
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ERROR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultTypeClass.FAILURE">
|
||
<span class="sig-name descname"><span class="pre">FAILURE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FAILURE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultTypeClass.INIT">
|
||
<span class="sig-name descname"><span class="pre">INIT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'INIT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionResultTypeClass.SUCCESS">
|
||
<span class="sig-name descname"><span class="pre">SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SUCCESS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionRunEventClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMillis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">asserteeUrn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">assertionUrn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runtimeContext</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batchSpec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eventGranularity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partitionSpec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messageId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>An event representing the current status of evaluating an assertion on a batch.
|
||
AssertionRunEvent should be used for reporting the status of a run as an assertion evaluation progresses.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>timestampMillis</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>runId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>asserteeUrn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>status</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionRunStatusClass" title="datahub.metadata.schema_classes.AssertionRunStatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionRunStatusClass</span></code></a>])</p></li>
|
||
<li><p><strong>assertionUrn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>result</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionResultClass" title="datahub.metadata.schema_classes.AssertionResultClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionResultClass</span></code></a>])</p></li>
|
||
<li><p><strong>runtimeContext</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>batchSpec</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.BatchSpecClass" title="datahub.metadata.schema_classes.BatchSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BatchSpecClass</span></code></a>])</p></li>
|
||
<li><p><strong>eventGranularity</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeWindowSizeClass</span></code></a>])</p></li>
|
||
<li><p><strong>partitionSpec</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionSpecClass</span></code></a>])</p></li>
|
||
<li><p><strong>messageId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass.ASPECT_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ASPECT_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timeseries'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass.asserteeUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">asserteeUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass.assertionUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">assertionUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass.batchSpec">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">batchSpec</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BatchSpecClass" title="datahub.metadata.schema_classes.BatchSpecClass"><span class="pre">BatchSpecClass</span></a></em></dt>
|
||
<dd><p>Specification of the batch which this run is evaluating</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass.eventGranularity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">eventGranularity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><span class="pre">TimeWindowSizeClass</span></a></em></dt>
|
||
<dd><p>Granularity of the event if applicable</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass.messageId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">messageId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass.partitionSpec">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">partitionSpec</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><span class="pre">PartitionSpecClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The optional partition specification.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass.result">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionResultClass" title="datahub.metadata.schema_classes.AssertionResultClass"><span class="pre">AssertionResultClass</span></a></em></dt>
|
||
<dd><p>Results of assertion, present if the status is COMPLETE</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass.runId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">runId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Native (platform-specific) identifier for this run</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass.runtimeContext">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">runtimeContext</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Runtime parameters of evaluation</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass.status">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionRunStatusClass" title="datahub.metadata.schema_classes.AssertionRunStatusClass"><span class="pre">AssertionRunStatusClass</span></a></em></dt>
|
||
<dd><p>The status of the assertion run as per this timeseries event.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunEventClass.timestampMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The event timestamp field as epoch at UTC in milli seconds.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunStatusClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionRunStatusClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The lifecycle status of an assertion run.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionRunStatusClass.COMPLETE">
|
||
<span class="sig-name descname"><span class="pre">COMPLETE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'COMPLETE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionSourceClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionSourceClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>The source of an assertion</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionSourceTypeClass" title="datahub.metadata.schema_classes.AssertionSourceTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionSourceTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionSourceClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>The time at which the assertion was initially created and the author who created it.
|
||
This field is only present for Native assertions created after this field was introduced.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionSourceClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionSourceTypeClass" title="datahub.metadata.schema_classes.AssertionSourceTypeClass"><span class="pre">AssertionSourceTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the Assertion Source</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionSourceTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionSourceTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionSourceTypeClass.EXTERNAL">
|
||
<span class="sig-name descname"><span class="pre">EXTERNAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EXTERNAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionSourceTypeClass.INFERRED">
|
||
<span class="sig-name descname"><span class="pre">INFERRED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'INFERRED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionSourceTypeClass.NATIVE">
|
||
<span class="sig-name descname"><span class="pre">NATIVE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NATIVE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionStdAggregationClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The function that is applied to the aggregation input (schema, rows, column values) before evaluating an operator.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.COLUMNS">
|
||
<span class="sig-name descname"><span class="pre">COLUMNS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'COLUMNS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.COLUMN_COUNT">
|
||
<span class="sig-name descname"><span class="pre">COLUMN_COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'COLUMN_COUNT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.IDENTITY">
|
||
<span class="sig-name descname"><span class="pre">IDENTITY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IDENTITY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.MAX">
|
||
<span class="sig-name descname"><span class="pre">MAX</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MAX'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.MEAN">
|
||
<span class="sig-name descname"><span class="pre">MEAN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MEAN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.MEDIAN">
|
||
<span class="sig-name descname"><span class="pre">MEDIAN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MEDIAN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.MIN">
|
||
<span class="sig-name descname"><span class="pre">MIN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MIN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.NULL_COUNT">
|
||
<span class="sig-name descname"><span class="pre">NULL_COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NULL_COUNT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.NULL_PROPORTION">
|
||
<span class="sig-name descname"><span class="pre">NULL_PROPORTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NULL_PROPORTION'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.ROW_COUNT">
|
||
<span class="sig-name descname"><span class="pre">ROW_COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ROW_COUNT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.STDDEV">
|
||
<span class="sig-name descname"><span class="pre">STDDEV</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STDDEV'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.SUM">
|
||
<span class="sig-name descname"><span class="pre">SUM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SUM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.UNIQUE_COUNT">
|
||
<span class="sig-name descname"><span class="pre">UNIQUE_COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNIQUE_COUNT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.UNIQUE_PROPORTION">
|
||
<span class="sig-name descname"><span class="pre">UNIQUE_PROPORTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNIQUE_PROPORTION'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdAggregationClass.UNIQUE_PROPOTION">
|
||
<span class="sig-name descname"><span class="pre">UNIQUE_PROPOTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNIQUE_PROPOTION'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionStdOperatorClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>A boolean operator that is applied on the input to an assertion, after an aggregation function has been applied.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.BETWEEN">
|
||
<span class="sig-name descname"><span class="pre">BETWEEN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BETWEEN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.CONTAIN">
|
||
<span class="sig-name descname"><span class="pre">CONTAIN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CONTAIN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.END_WITH">
|
||
<span class="sig-name descname"><span class="pre">END_WITH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'END_WITH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.EQUAL_TO">
|
||
<span class="sig-name descname"><span class="pre">EQUAL_TO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EQUAL_TO'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.GREATER_THAN">
|
||
<span class="sig-name descname"><span class="pre">GREATER_THAN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'GREATER_THAN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.GREATER_THAN_OR_EQUAL_TO">
|
||
<span class="sig-name descname"><span class="pre">GREATER_THAN_OR_EQUAL_TO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'GREATER_THAN_OR_EQUAL_TO'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.IN">
|
||
<span class="sig-name descname"><span class="pre">IN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.IS_FALSE">
|
||
<span class="sig-name descname"><span class="pre">IS_FALSE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IS_FALSE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.IS_TRUE">
|
||
<span class="sig-name descname"><span class="pre">IS_TRUE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IS_TRUE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.LESS_THAN">
|
||
<span class="sig-name descname"><span class="pre">LESS_THAN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LESS_THAN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.LESS_THAN_OR_EQUAL_TO">
|
||
<span class="sig-name descname"><span class="pre">LESS_THAN_OR_EQUAL_TO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LESS_THAN_OR_EQUAL_TO'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.NOT_EQUAL_TO">
|
||
<span class="sig-name descname"><span class="pre">NOT_EQUAL_TO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NOT_EQUAL_TO'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.NOT_IN">
|
||
<span class="sig-name descname"><span class="pre">NOT_IN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NOT_IN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.NOT_NULL">
|
||
<span class="sig-name descname"><span class="pre">NOT_NULL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NOT_NULL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.NULL">
|
||
<span class="sig-name descname"><span class="pre">NULL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NULL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.REGEX_MATCH">
|
||
<span class="sig-name descname"><span class="pre">REGEX_MATCH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'REGEX_MATCH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdOperatorClass.START_WITH">
|
||
<span class="sig-name descname"><span class="pre">START_WITH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'START_WITH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParameterClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionStdParameterClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Single parameter for AssertionStdOperators.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParameterTypeClass" title="datahub.metadata.schema_classes.AssertionStdParameterTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdParameterTypeClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParameterClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParameterTypeClass" title="datahub.metadata.schema_classes.AssertionStdParameterTypeClass"><span class="pre">AssertionStdParameterTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the parameter</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParameterClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The parameter value</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParameterTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionStdParameterTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParameterTypeClass.LIST">
|
||
<span class="sig-name descname"><span class="pre">LIST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LIST'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParameterTypeClass.NUMBER">
|
||
<span class="sig-name descname"><span class="pre">NUMBER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NUMBER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParameterTypeClass.SET">
|
||
<span class="sig-name descname"><span class="pre">SET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SET'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParameterTypeClass.STRING">
|
||
<span class="sig-name descname"><span class="pre">STRING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STRING'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParameterTypeClass.UNKNOWN">
|
||
<span class="sig-name descname"><span class="pre">UNKNOWN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNKNOWN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParametersClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionStdParametersClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxValue</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minValue</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Parameters for AssertionStdOperators.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>value</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParameterClass" title="datahub.metadata.schema_classes.AssertionStdParameterClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdParameterClass</span></code></a>])</p></li>
|
||
<li><p><strong>maxValue</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParameterClass" title="datahub.metadata.schema_classes.AssertionStdParameterClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdParameterClass</span></code></a>])</p></li>
|
||
<li><p><strong>minValue</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParameterClass" title="datahub.metadata.schema_classes.AssertionStdParameterClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdParameterClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParametersClass.maxValue">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maxValue</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParameterClass" title="datahub.metadata.schema_classes.AssertionStdParameterClass"><span class="pre">AssertionStdParameterClass</span></a></em></dt>
|
||
<dd><p>The maxValue parameter of an assertion</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParametersClass.minValue">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">minValue</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParameterClass" title="datahub.metadata.schema_classes.AssertionStdParameterClass"><span class="pre">AssertionStdParameterClass</span></a></em></dt>
|
||
<dd><p>The minValue parameter of an assertion</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionStdParametersClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParameterClass" title="datahub.metadata.schema_classes.AssertionStdParameterClass"><span class="pre">AssertionStdParameterClass</span></a></em></dt>
|
||
<dd><p>The value parameter of an assertion</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionTypeClass.CUSTOM">
|
||
<span class="sig-name descname"><span class="pre">CUSTOM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CUSTOM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionTypeClass.DATASET">
|
||
<span class="sig-name descname"><span class="pre">DATASET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATASET'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionTypeClass.DATA_SCHEMA">
|
||
<span class="sig-name descname"><span class="pre">DATA_SCHEMA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATA_SCHEMA'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionTypeClass.FIELD">
|
||
<span class="sig-name descname"><span class="pre">FIELD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FIELD'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionTypeClass.FRESHNESS">
|
||
<span class="sig-name descname"><span class="pre">FRESHNESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FRESHNESS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionTypeClass.SQL">
|
||
<span class="sig-name descname"><span class="pre">SQL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SQL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionTypeClass.VOLUME">
|
||
<span class="sig-name descname"><span class="pre">VOLUME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'VOLUME'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionValueChangeTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AssertionValueChangeTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>An enum to represent a type of change in an assertion value, metric, or measurement.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionValueChangeTypeClass.ABSOLUTE">
|
||
<span class="sig-name descname"><span class="pre">ABSOLUTE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ABSOLUTE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AssertionValueChangeTypeClass.PERCENTAGE">
|
||
<span class="sig-name descname"><span class="pre">PERCENTAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PERCENTAGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AuditStampClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AuditStampClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">impersonator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>actor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>impersonator</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>message</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AuditStampClass.actor">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AuditStampClass.impersonator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">impersonator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AuditStampClass.message">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">message</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>was the change created by an automated process, or manually.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Additional context around how DataHub was informed of the particular change. For example</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AuditStampClass.time">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AzkabanJobTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">AzkabanJobTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The various types of support azkaban jobs</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AzkabanJobTypeClass.COMMAND">
|
||
<span class="sig-name descname"><span class="pre">COMMAND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'COMMAND'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AzkabanJobTypeClass.GLUE">
|
||
<span class="sig-name descname"><span class="pre">GLUE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'GLUE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AzkabanJobTypeClass.HADOOP_JAVA">
|
||
<span class="sig-name descname"><span class="pre">HADOOP_JAVA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'HADOOP_JAVA'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AzkabanJobTypeClass.HADOOP_SHELL">
|
||
<span class="sig-name descname"><span class="pre">HADOOP_SHELL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'HADOOP_SHELL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AzkabanJobTypeClass.HIVE">
|
||
<span class="sig-name descname"><span class="pre">HIVE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'HIVE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AzkabanJobTypeClass.PIG">
|
||
<span class="sig-name descname"><span class="pre">PIG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PIG'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.AzkabanJobTypeClass.SQL">
|
||
<span class="sig-name descname"><span class="pre">SQL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SQL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BaseDataClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">BaseDataClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">motivation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preProcessing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>BaseData record</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dataset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>motivation</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>preProcessing</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BaseDataClass.dataset">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dataset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>What dataset were used in the MLModel?</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BaseDataClass.motivation">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">motivation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Why was this dataset chosen?</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BaseDataClass.preProcessing">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">preProcessing</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>How was the data preprocessed (e.g., tokenization of sentences, cropping of images, any filtering such as dropping images without faces)?</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BatchSpecClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">BatchSpecClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nativeBatchId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A batch on which certain operations, e.g. data quality evaluation, is done.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>nativeBatchId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>query</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BatchSpecClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BatchSpecClass.limit">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">limit</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Any limit to the number of rows in the batch, if applied</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BatchSpecClass.nativeBatchId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nativeBatchId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native identifier as specified by the system operating on the batch.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BatchSpecClass.query">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">query</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A query that identifies a batch of data</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BinaryJsonSchemaClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">BinaryJsonSchemaClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">schema</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Schema text of binary JSON schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BinaryJsonSchemaClass.schema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native schema text for binary JSON file format.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BooleanTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">BooleanTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Boolean field type.</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BrowsePathEntryClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">BrowsePathEntryClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">urn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Represents a single level in an entity’s browsePathV2</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>urn</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BrowsePathEntryClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The ID of the browse path entry. This is what gets stored in the index.
|
||
If there’s an urn associated with this entry, id and urn will be the same</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BrowsePathEntryClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional urn pointing to some entity in DataHub</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BrowsePathsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">BrowsePathsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">paths</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Shared aspect containing Browse Paths to be indexed for an entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>paths</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BrowsePathsClass.paths">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paths</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A list of valid browse paths for the entity.</p>
|
||
<p>Browse paths are expected to be forward slash-separated strings. For example: ‘prod/snowflake/datasetName’</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BrowsePathsV2Class">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">BrowsePathsV2Class</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Shared aspect containing a Browse Path to be indexed for an entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathEntryClass" title="datahub.metadata.schema_classes.BrowsePathEntryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathEntryClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BrowsePathsV2Class.path">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathEntryClass" title="datahub.metadata.schema_classes.BrowsePathEntryClass"><span class="pre">BrowsePathEntryClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A valid browse path for the entity. This field is provided by DataHub by default.
|
||
This aspect is a newer version of browsePaths where we can encode more information in the path.
|
||
This path is also based on containers for a given entity if it has containers.</p>
|
||
<p>This is stored in elasticsearch as unit-separator delimited strings and only includes platform specific folders or containers.
|
||
These paths should not include high level info captured elsewhere ie. Platform and Environment.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeAssociationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">BusinessAttributeAssociationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">businessAttributeUrn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>businessAttributeUrn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeAssociationClass.businessAttributeUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">businessAttributeUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the applied businessAttribute</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">BusinessAttributeInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fieldPath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">globalTags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">glossaryTerms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a BusinessAttribute</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>fieldPath</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>globalTags</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>])</p></li>
|
||
<li><p><strong>glossaryTerms</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermsClass</span></code></a>])</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>deleted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldDataTypeClass" title="datahub.metadata.schema_classes.SchemaFieldDataTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldDataTypeClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeInfoClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeInfoClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeInfoClass.deleted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deleted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeInfoClass.fieldPath">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldPath</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>FieldPath uniquely identifying the SchemaField this metadata is associated with</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeInfoClass.globalTags">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">globalTags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a></em></dt>
|
||
<dd><p>Tags associated with the field</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeInfoClass.glossaryTerms">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">glossaryTerms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><span class="pre">GlossaryTermsClass</span></a></em></dt>
|
||
<dd><p>Glossary terms associated with the field</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeInfoClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the BusinessAttribute</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldDataTypeClass" title="datahub.metadata.schema_classes.SchemaFieldDataTypeClass"><span class="pre">SchemaFieldDataTypeClass</span></a></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">BusinessAttributeKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Query</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributeKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the Business Attribute.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">BusinessAttributesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">businessAttribute</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>BusinessAttribute aspect used for applying it to an entity</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>businessAttribute</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.BusinessAttributeAssociationClass" title="datahub.metadata.schema_classes.BusinessAttributeAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusinessAttributeAssociationClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BusinessAttributesClass.businessAttribute">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">businessAttribute</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BusinessAttributeAssociationClass" title="datahub.metadata.schema_classes.BusinessAttributeAssociationClass"><span class="pre">BusinessAttributeAssociationClass</span></a></em></dt>
|
||
<dd><p>Business Attribute for this field.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.BytesTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">BytesTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Bytes field type.</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CalendarIntervalClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CalendarIntervalClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CalendarIntervalClass.DAY">
|
||
<span class="sig-name descname"><span class="pre">DAY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DAY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CalendarIntervalClass.HOUR">
|
||
<span class="sig-name descname"><span class="pre">HOUR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'HOUR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CalendarIntervalClass.MINUTE">
|
||
<span class="sig-name descname"><span class="pre">MINUTE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MINUTE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CalendarIntervalClass.MONTH">
|
||
<span class="sig-name descname"><span class="pre">MONTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MONTH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CalendarIntervalClass.QUARTER">
|
||
<span class="sig-name descname"><span class="pre">QUARTER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'QUARTER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CalendarIntervalClass.SECOND">
|
||
<span class="sig-name descname"><span class="pre">SECOND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SECOND'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CalendarIntervalClass.WEEK">
|
||
<span class="sig-name descname"><span class="pre">WEEK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'WEEK'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CalendarIntervalClass.YEAR">
|
||
<span class="sig-name descname"><span class="pre">YEAR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'YEAR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CaveatDetailsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CaveatDetailsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">needsFurtherTesting</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">caveatDescription</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groupsNotRepresented</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>This section should list additional concerns that were not covered in the previous sections. For example, did the results suggest any further testing? Were there any relevant groups that were not represented in the evaluation dataset? Are there additional recommendations for model use?</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>needsFurtherTesting</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>caveatDescription</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>groupsNotRepresented</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CaveatDetailsClass.caveatDescription">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">caveatDescription</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Caveat Description
|
||
For ex: Given gender classes are binary (male/not male), which we include as male/female. Further work needed to evaluate across a spectrum of genders.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CaveatDetailsClass.groupsNotRepresented">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">groupsNotRepresented</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Relevant groups that were not represented in the evaluation dataset?</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CaveatDetailsClass.needsFurtherTesting">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">needsFurtherTesting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Did the results suggest any further testing?</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CaveatsAndRecommendationsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CaveatsAndRecommendationsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caveats</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recommendations</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idealDatasetCharacteristics</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>This section should list additional concerns that were not covered in the previous sections. For example, did the results suggest any further testing? Were there any relevant groups that were not represented in the evaluation dataset? Are there additional recommendations for model use?</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>caveats</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.CaveatDetailsClass" title="datahub.metadata.schema_classes.CaveatDetailsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CaveatDetailsClass</span></code></a>])</p></li>
|
||
<li><p><strong>recommendations</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>idealDatasetCharacteristics</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CaveatsAndRecommendationsClass.caveats">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">caveats</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CaveatDetailsClass" title="datahub.metadata.schema_classes.CaveatDetailsClass"><span class="pre">CaveatDetailsClass</span></a></em></dt>
|
||
<dd><p>This section should list additional concerns that were not covered in the previous sections. For example, did the results suggest any further testing? Were there any relevant groups that were not represented in the evaluation dataset?</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CaveatsAndRecommendationsClass.idealDatasetCharacteristics">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">idealDatasetCharacteristics</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Ideal characteristics of an evaluation dataset for this MLModel</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CaveatsAndRecommendationsClass.recommendations">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">recommendations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Recommendations on where this MLModel should be used.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChangeAuditStampsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ChangeAuditStampsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into various lifecycle stages, and who acted to move it into those lifecycle stages. The recommended best practice is to include this record in your record schema, and annotate its fields as @readOnly in your resource. See <a class="github reference external" href="https://github.com/linkedin/rest.li/wiki/Validation-in-Rest.li#restli-validation-annotations">linkedin/rest.li</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>deleted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChangeAuditStampsClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChangeAuditStampsClass.deleted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deleted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChangeAuditStampsClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChangeTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ChangeTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Descriptor for a change action</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChangeTypeClass.CREATE">
|
||
<span class="sig-name descname"><span class="pre">CREATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CREATE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChangeTypeClass.CREATE_ENTITY">
|
||
<span class="sig-name descname"><span class="pre">CREATE_ENTITY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CREATE_ENTITY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChangeTypeClass.DELETE">
|
||
<span class="sig-name descname"><span class="pre">DELETE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DELETE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChangeTypeClass.PATCH">
|
||
<span class="sig-name descname"><span class="pre">PATCH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PATCH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChangeTypeClass.RESTATE">
|
||
<span class="sig-name descname"><span class="pre">RESTATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'RESTATE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChangeTypeClass.UPDATE">
|
||
<span class="sig-name descname"><span class="pre">UPDATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UPDATE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChangeTypeClass.UPSERT">
|
||
<span class="sig-name descname"><span class="pre">UPSERT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UPSERT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartCellClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ChartCellClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cellId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">changeAuditStamps</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cellTitle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Chart cell in a notebook, which will present content in chart format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cellId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>changeAuditStamps</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" title="datahub.metadata.schema_classes.ChangeAuditStampsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChangeAuditStampsClass</span></code></a>)</p></li>
|
||
<li><p><strong>cellTitle</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartCellClass.cellId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cellId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique id for the cell. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as ‘querybook.com/notebook/773/?cellId=1234’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartCellClass.cellTitle">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cellTitle</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Title of the cell</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartCellClass.changeAuditStamps">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">changeAuditStamps</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" title="datahub.metadata.schema_classes.ChangeAuditStampsClass"><span class="pre">ChangeAuditStampsClass</span></a></em></dt>
|
||
<dd><p>Captures information about who created/last modified/deleted this Notebook cell and when</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ChartInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chartUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputEdges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastRefreshed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a chart</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>title</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>lastModified</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" title="datahub.metadata.schema_classes.ChangeAuditStampsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChangeAuditStampsClass</span></code></a>)</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>chartUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>inputs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>inputEdges</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClass</span></code></a>]])</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.ChartTypeClass" title="datahub.metadata.schema_classes.ChartTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>access</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AccessLevelClass" title="datahub.metadata.schema_classes.AccessLevelClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccessLevelClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastRefreshed</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartInfoClass.access">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">access</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AccessLevelClass" title="datahub.metadata.schema_classes.AccessLevelClass"><span class="pre">AccessLevelClass</span></a></em></dt>
|
||
<dd><p>Access level for the chart</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartInfoClass.chartUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">chartUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL for the chart. This could be used as an external link on DataHub to allow users access/view the chart</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartInfoClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Detailed description about the chart</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartInfoClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartInfoClass.inputEdges">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inputEdges</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><span class="pre">EdgeClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Data sources for the chart</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartInfoClass.inputs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inputs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Data sources for the chart
|
||
Deprecated! Use inputEdges instead.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartInfoClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" title="datahub.metadata.schema_classes.ChangeAuditStampsClass"><span class="pre">ChangeAuditStampsClass</span></a></em></dt>
|
||
<dd><p>Captures information about who created/last modified/deleted this chart and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartInfoClass.lastRefreshed">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastRefreshed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The time when this chart last refreshed</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartInfoClass.title">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Title of the chart</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChartTypeClass" title="datahub.metadata.schema_classes.ChartTypeClass"><span class="pre">ChartTypeClass</span></a></em></dt>
|
||
<dd><p>Type of the chart</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ChartKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dashboardTool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chartId</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Chart</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dashboardTool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>chartId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartKeyClass.chartId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">chartId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique id for the chart. This id should be globally unique for a dashboarding tool even when there are multiple deployments of it. As an example, chart URL could be used here for Looker such as ‘looker.linkedin.com/looks/1234’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartKeyClass.dashboardTool">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dashboardTool</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the dashboard tool such as looker, redash etc.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartQueryClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ChartQueryClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rawQuery</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information for chart query which is used for getting data of the chart</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>rawQuery</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.ChartQueryTypeClass" title="datahub.metadata.schema_classes.ChartQueryTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartQueryTypeClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartQueryClass.rawQuery">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rawQuery</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Raw query to build a chart from input datasets</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartQueryClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChartQueryTypeClass" title="datahub.metadata.schema_classes.ChartQueryTypeClass"><span class="pre">ChartQueryTypeClass</span></a></em></dt>
|
||
<dd><p>Chart query type</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartQueryTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ChartQueryTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartQueryTypeClass.LOOKML">
|
||
<span class="sig-name descname"><span class="pre">LOOKML</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LOOKML'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartQueryTypeClass.SQL">
|
||
<span class="sig-name descname"><span class="pre">SQL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SQL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ChartSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific Chart entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.ChartKeyClass" title="datahub.metadata.schema_classes.ChartKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.ChartInfoClass" title="datahub.metadata.schema_classes.ChartInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartInfoClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.ChartQueryClass" title="datahub.metadata.schema_classes.ChartQueryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartQueryClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.EditableChartPropertiesClass" title="datahub.metadata.schema_classes.EditableChartPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableChartPropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstitutionalMemoryClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsV2Class</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.ChartKeyClass" title="datahub.metadata.schema_classes.ChartKeyClass"><span class="pre">ChartKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChartInfoClass" title="datahub.metadata.schema_classes.ChartInfoClass"><span class="pre">ChartInfoClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChartQueryClass" title="datahub.metadata.schema_classes.ChartQueryClass"><span class="pre">ChartQueryClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableChartPropertiesClass" title="datahub.metadata.schema_classes.EditableChartPropertiesClass"><span class="pre">EditableChartPropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><span class="pre">BrowsePathsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><span class="pre">GlossaryTermsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><span class="pre">InstitutionalMemoryClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><span class="pre">DataPlatformInstanceClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><span class="pre">BrowsePathsV2Class</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the chart. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ChartTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The various types of charts</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartTypeClass.AREA">
|
||
<span class="sig-name descname"><span class="pre">AREA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'AREA'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartTypeClass.BAR">
|
||
<span class="sig-name descname"><span class="pre">BAR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BAR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartTypeClass.BOX_PLOT">
|
||
<span class="sig-name descname"><span class="pre">BOX_PLOT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BOX_PLOT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartTypeClass.COHORT">
|
||
<span class="sig-name descname"><span class="pre">COHORT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'COHORT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartTypeClass.HISTOGRAM">
|
||
<span class="sig-name descname"><span class="pre">HISTOGRAM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'HISTOGRAM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartTypeClass.LINE">
|
||
<span class="sig-name descname"><span class="pre">LINE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LINE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartTypeClass.PIE">
|
||
<span class="sig-name descname"><span class="pre">PIE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PIE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartTypeClass.SCATTER">
|
||
<span class="sig-name descname"><span class="pre">SCATTER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SCATTER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartTypeClass.TABLE">
|
||
<span class="sig-name descname"><span class="pre">TABLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TABLE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartTypeClass.TEXT">
|
||
<span class="sig-name descname"><span class="pre">TEXT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TEXT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartTypeClass.WORD_CLOUD">
|
||
<span class="sig-name descname"><span class="pre">WORD_CLOUD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'WORD_CLOUD'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartUsageStatisticsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ChartUsageStatisticsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMillis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eventGranularity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partitionSpec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messageId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">viewsCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uniqueUserCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">userCounts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Experimental (Subject to breaking change) – Stats corresponding to chart’s usage.</p>
|
||
<p>If this aspect represents the latest snapshot of the statistics about a Chart, the eventGranularity field should be null.
|
||
If this aspect represents a bucketed window of usage statistics (e.g. over a day), then the eventGranularity field should be set accordingly.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>timestampMillis</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>eventGranularity</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeWindowSizeClass</span></code></a>])</p></li>
|
||
<li><p><strong>partitionSpec</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionSpecClass</span></code></a>])</p></li>
|
||
<li><p><strong>messageId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>viewsCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>uniqueUserCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>userCounts</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.ChartUserUsageCountsClass" title="datahub.metadata.schema_classes.ChartUserUsageCountsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartUserUsageCountsClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartUsageStatisticsClass.ASPECT_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ASPECT_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timeseries'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartUsageStatisticsClass.eventGranularity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">eventGranularity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><span class="pre">TimeWindowSizeClass</span></a></em></dt>
|
||
<dd><p>Granularity of the event if applicable</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartUsageStatisticsClass.messageId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">messageId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartUsageStatisticsClass.partitionSpec">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">partitionSpec</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><span class="pre">PartitionSpecClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The optional partition specification.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartUsageStatisticsClass.timestampMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The event timestamp field as epoch at UTC in milli seconds.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartUsageStatisticsClass.uniqueUserCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uniqueUserCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Unique user count</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartUsageStatisticsClass.userCounts">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">userCounts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.ChartUserUsageCountsClass" title="datahub.metadata.schema_classes.ChartUserUsageCountsClass"><span class="pre">ChartUserUsageCountsClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Users within this bucket, with frequency counts</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartUsageStatisticsClass.viewsCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">viewsCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The total number of times chart has been viewed</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartUserUsageCountsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ChartUserUsageCountsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">viewsCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Records a single user’s usage counts for a given resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>viewsCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartUserUsageCountsClass.user">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The unique id of the user.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ChartUserUsageCountsClass.viewsCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">viewsCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The number of times the user has viewed the chart</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ConditionClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The matching condition in a filter criterion</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.ANCESTORS_INCL">
|
||
<span class="sig-name descname"><span class="pre">ANCESTORS_INCL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ANCESTORS_INCL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.CONTAIN">
|
||
<span class="sig-name descname"><span class="pre">CONTAIN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CONTAIN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.DESCENDANTS_INCL">
|
||
<span class="sig-name descname"><span class="pre">DESCENDANTS_INCL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DESCENDANTS_INCL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.END_WITH">
|
||
<span class="sig-name descname"><span class="pre">END_WITH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'END_WITH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.EQUAL">
|
||
<span class="sig-name descname"><span class="pre">EQUAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EQUAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.EXISTS">
|
||
<span class="sig-name descname"><span class="pre">EXISTS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EXISTS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.GREATER_THAN">
|
||
<span class="sig-name descname"><span class="pre">GREATER_THAN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'GREATER_THAN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.GREATER_THAN_OR_EQUAL_TO">
|
||
<span class="sig-name descname"><span class="pre">GREATER_THAN_OR_EQUAL_TO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'GREATER_THAN_OR_EQUAL_TO'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.IEQUAL">
|
||
<span class="sig-name descname"><span class="pre">IEQUAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IEQUAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.IN">
|
||
<span class="sig-name descname"><span class="pre">IN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.IS_NULL">
|
||
<span class="sig-name descname"><span class="pre">IS_NULL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IS_NULL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.LESS_THAN">
|
||
<span class="sig-name descname"><span class="pre">LESS_THAN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LESS_THAN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.LESS_THAN_OR_EQUAL_TO">
|
||
<span class="sig-name descname"><span class="pre">LESS_THAN_OR_EQUAL_TO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LESS_THAN_OR_EQUAL_TO'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.RELATED_INCL">
|
||
<span class="sig-name descname"><span class="pre">RELATED_INCL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'RELATED_INCL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConditionClass.START_WITH">
|
||
<span class="sig-name descname"><span class="pre">START_WITH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'START_WITH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConjunctiveCriterionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ConjunctiveCriterionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">and_</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A list of criterion and’d together.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>and_</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.CriterionClass" title="datahub.metadata.schema_classes.CriterionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CriterionClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ConjunctiveCriterionClass.and_">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">and_</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.CriterionClass" title="datahub.metadata.schema_classes.CriterionClass"><span class="pre">CriterionClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A list of and criteria the filter applies to the query</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ContainerClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">container</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Link from an asset to its parent container</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>container</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerClass.container">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">container</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The parent container of an asset</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ContainerKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for an Asset Container</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>guid</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerKeyClass.guid">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">guid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique guid for container</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ContainerPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualifiedName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a Asset Container as received from a 3rd party source system</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>qualifiedName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>env</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FabricTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><span class="pre">TimeStampClass</span></a></em></dt>
|
||
<dd><p>A timestamp documenting when the asset was created in the source Data Platform (not on DataHub)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerPropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the Asset Container as it exists inside a source system</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerPropertiesClass.env">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">env</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><span class="pre">FabricTypeClass</span></a></em></dt>
|
||
<dd><p>Environment for this flow</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerPropertiesClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><span class="pre">TimeStampClass</span></a></em></dt>
|
||
<dd><p>A timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerPropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the Asset Container</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ContainerPropertiesClass.qualifiedName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">qualifiedName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Fully-qualified name of the Container</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupEditableInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpGroupEditableInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pictureLink</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slack</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Group information that can be edited from UI</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>pictureLink</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>slack</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>email</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupEditableInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A description of the group</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupEditableInfoClass.email">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">email</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Email address to contact the group</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupEditableInfoClass.pictureLink">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pictureLink</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A URL which points to a picture which user wants to set as the photo for the group</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupEditableInfoClass.slack">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">slack</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Slack channel for the group</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpGroupInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">admins</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">members</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">displayName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slack</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a Corp Group ingested from a third party source</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>admins</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>members</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>displayName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>email</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>slack</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupInfoClass.admins">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">admins</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>owners of this group
|
||
Deprecated! Replaced by Ownership aspect.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupInfoClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Created Audit stamp</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A description of the group.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupInfoClass.displayName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">displayName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the group.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupInfoClass.email">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">email</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>email of this group</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupInfoClass.groups">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">groups</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of groups in this group.
|
||
Deprecated! This field is unused.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupInfoClass.members">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">members</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of ldap urn in this group.
|
||
Deprecated! Replaced by GroupMembership aspect.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupInfoClass.slack">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">slack</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Slack channel for the group</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpGroupKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a CorpGroup</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The URL-encoded name of the AD/LDAP group. Serves as a globally unique identifier within DataHub.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpGroupSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific CorpGroup entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.CorpGroupKeyClass" title="datahub.metadata.schema_classes.CorpGroupKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpGroupKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.CorpGroupInfoClass" title="datahub.metadata.schema_classes.CorpGroupInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpGroupInfoClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpGroupKeyClass" title="datahub.metadata.schema_classes.CorpGroupKeyClass"><span class="pre">CorpGroupKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpGroupInfoClass" title="datahub.metadata.schema_classes.CorpGroupInfoClass"><span class="pre">CorpGroupInfoClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the LdapUser. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpGroupSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpUserAppearanceSettingsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">showSimplifiedHomepage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">showThemeV2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Settings for a user around the appearance of their DataHub UI</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>showSimplifiedHomepage</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>showThemeV2</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass.showSimplifiedHomepage">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">showSimplifiedHomepage</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Flag whether the user should see a homepage with only datasets, charts and dashboards. Intended for users
|
||
who have less operational use cases for the datahub tool.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass.showThemeV2">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">showThemeV2</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Flag controlling whether the V2 UI for DataHub is shown.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserCredentialsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpUserCredentialsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">salt</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hashedPassword</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">passwordResetToken</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">passwordResetTokenExpirationTimeMillis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Corp user credentials</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>salt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>hashedPassword</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>passwordResetToken</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>passwordResetTokenExpirationTimeMillis</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserCredentialsClass.hashedPassword">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hashedPassword</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Hashed password generated by concatenating salt and password, then hashing</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserCredentialsClass.passwordResetToken">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">passwordResetToken</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional token needed to reset a user’s password. Can only be set by the admin.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserCredentialsClass.passwordResetTokenExpirationTimeMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">passwordResetTokenExpirationTimeMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>When the password reset token expires.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserCredentialsClass.salt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">salt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Salt used to hash password</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpUserEditableInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">aboutMe</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">teams</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skills</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pictureLink</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">displayName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platforms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persona</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slack</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">phone</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">informationSources</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Linkedin corp user information that can be edited from UI</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>aboutMe</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>teams</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>skills</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>pictureLink</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>displayName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>title</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>platforms</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>persona</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>slack</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>phone</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>email</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>informationSources</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass.aboutMe">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aboutMe</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>About me section of the user</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass.displayName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">displayName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>DataHub-native display name</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass.email">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">email</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Email address to contact the user</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass.informationSources">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">informationSources</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Information sources that have been used to populate this CorpUserEditableInfo.
|
||
These include platform resources, such as Slack members or Looker users.
|
||
They can also refer to other semantic urns in the future.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass.persona">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">persona</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The user’s persona type, based on their role</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass.phone">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">phone</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Phone number to contact the user</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass.pictureLink">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pictureLink</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A URL which points to a picture which user wants to set as a profile photo</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass.platforms">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platforms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The platforms that the user commonly works with</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass.skills">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">skills</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Skills that the user possesses e.g. Machine Learning</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass.slack">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">slack</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Slack handle for the user</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass.teams">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">teams</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Teams that the user belongs to e.g. Metadata</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserEditableInfoClass.title">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>DataHub-native Title, e.g. ‘Software Engineer’</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpUserInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">active</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">displayName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">managerUrn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">departmentId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">departmentName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">firstName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fullName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">countryCode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">system</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Linkedin corp user information</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>active</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>displayName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>email</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>title</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>managerUrn</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>departmentId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>departmentName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>firstName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>lastName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>fullName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>countryCode</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>system</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.active">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">active</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>//iwww.corp.linkedin.com/wiki/cf/display/GTSD/Accessing+Active+Directory+via+LDAP+tools</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Deprecated! Use CorpUserStatus instead. Whether the corpUser is active, ref</p>
|
||
</dd>
|
||
<dt class="field-even">Type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>https</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.countryCode">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">countryCode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>two uppercase letters country code. e.g. US</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.departmentId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">departmentId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>department id this user belong to</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.departmentName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">departmentName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>department name this user belong to</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.displayName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">displayName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>displayName of this user , e.g. Hang Zhang(DataHQ)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.email">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">email</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>email address of this user</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.firstName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">firstName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>first name of this user</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.fullName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fullName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Common name of this user, format is firstName + lastName (split by a whitespace)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.lastName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>last name of this user</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.managerUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">managerUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>direct manager of this user</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.system">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">system</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>Whether the corpUser is a system user.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserInfoClass.title">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>title of this user</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpUserKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a CorpUser</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserKeyClass.username">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">username</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the AD/LDAP user.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserSettingsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpUserSettingsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">appearance</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">views</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notificationSettings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Settings that a user can customize through the datahub ui</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>appearance</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass" title="datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserAppearanceSettingsClass</span></code></a>)</p></li>
|
||
<li><p><strong>views</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserViewsSettingsClass" title="datahub.metadata.schema_classes.CorpUserViewsSettingsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserViewsSettingsClass</span></code></a>])</p></li>
|
||
<li><p><strong>notificationSettings</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.NotificationSettingsClass" title="datahub.metadata.schema_classes.NotificationSettingsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotificationSettingsClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserSettingsClass.appearance">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">appearance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass" title="datahub.metadata.schema_classes.CorpUserAppearanceSettingsClass"><span class="pre">CorpUserAppearanceSettingsClass</span></a></em></dt>
|
||
<dd><p>Settings for a user around the appearance of their DataHub U</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserSettingsClass.notificationSettings">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">notificationSettings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.NotificationSettingsClass" title="datahub.metadata.schema_classes.NotificationSettingsClass"><span class="pre">NotificationSettingsClass</span></a></em></dt>
|
||
<dd><p>Notification settings for a user</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserSettingsClass.views">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">views</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserViewsSettingsClass" title="datahub.metadata.schema_classes.CorpUserViewsSettingsClass"><span class="pre">CorpUserViewsSettingsClass</span></a></em></dt>
|
||
<dd><p>User preferences for the Views feature.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpUserSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific CorpUser entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserKeyClass" title="datahub.metadata.schema_classes.CorpUserKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserInfoClass" title="datahub.metadata.schema_classes.CorpUserInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserInfoClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserEditableInfoClass" title="datahub.metadata.schema_classes.CorpUserEditableInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserEditableInfoClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserStatusClass" title="datahub.metadata.schema_classes.CorpUserStatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserStatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GroupMembershipClass" title="datahub.metadata.schema_classes.GroupMembershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GroupMembershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserKeyClass" title="datahub.metadata.schema_classes.CorpUserKeyClass"><span class="pre">CorpUserKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserInfoClass" title="datahub.metadata.schema_classes.CorpUserInfoClass"><span class="pre">CorpUserInfoClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserEditableInfoClass" title="datahub.metadata.schema_classes.CorpUserEditableInfoClass"><span class="pre">CorpUserEditableInfoClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserStatusClass" title="datahub.metadata.schema_classes.CorpUserStatusClass"><span class="pre">CorpUserStatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GroupMembershipClass" title="datahub.metadata.schema_classes.GroupMembershipClass"><span class="pre">GroupMembershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the CorpUser. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserStatusClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpUserStatusClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>The status of the user, e.g. provisioned, active, suspended, etc.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>lastModified</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserStatusClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who last modified the status and when.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserStatusClass.status">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Status of the user, e.g. PROVISIONED / ACTIVE / SUSPENDED</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserViewsSettingsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CorpUserViewsSettingsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">defaultView</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Settings related to the ‘Views’ feature.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>defaultView</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CorpUserViewsSettingsClass.defaultView">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">defaultView</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The default View which is selected for the user.
|
||
If none is chosen, then this value will be left blank.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CostClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CostClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">costType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cost</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>costType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.CostTypeClass" title="datahub.metadata.schema_classes.CostTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CostTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>cost</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.CostCostClass" title="datahub.metadata.schema_classes.CostCostClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CostCostClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CostClass.cost">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cost</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CostCostClass" title="datahub.metadata.schema_classes.CostCostClass"><span class="pre">CostCostClass</span></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CostClass.costType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">costType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CostTypeClass" title="datahub.metadata.schema_classes.CostTypeClass"><span class="pre">CostTypeClass</span></a></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CostCostClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CostCostClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fieldDiscriminator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">costId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">costCode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>fieldDiscriminator</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.CostCostDiscriminatorClass" title="datahub.metadata.schema_classes.CostCostDiscriminatorClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CostCostDiscriminatorClass</span></code></a>])</p></li>
|
||
<li><p><strong>costId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>])</p></li>
|
||
<li><p><strong>costCode</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CostCostClass.costCode">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">costCode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CostCostClass.costId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">costId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CostCostClass.fieldDiscriminator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldDiscriminator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CostCostDiscriminatorClass" title="datahub.metadata.schema_classes.CostCostDiscriminatorClass"><span class="pre">CostCostDiscriminatorClass</span></a></em></dt>
|
||
<dd><p>Contains the name of the field that has its value set.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CostCostDiscriminatorClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CostCostDiscriminatorClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CostCostDiscriminatorClass.costCode">
|
||
<span class="sig-name descname"><span class="pre">costCode</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'costCode'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CostCostDiscriminatorClass.costId">
|
||
<span class="sig-name descname"><span class="pre">costId</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'costId'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CostTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CostTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Type of Cost Code</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CostTypeClass.ORG_COST_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ORG_COST_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ORG_COST_TYPE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CriterionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CriterionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">condition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">negated</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A criterion for matching a field with given value</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>field</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>values</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>condition</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.ConditionClass" title="datahub.metadata.schema_classes.ConditionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConditionClass</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>])</p></li>
|
||
<li><p><strong>negated</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CriterionClass.condition">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ConditionClass" title="datahub.metadata.schema_classes.ConditionClass"><span class="pre">ConditionClass</span></a></em></dt>
|
||
<dd><p>The condition for the criterion, e.g. EQUAL, START_WITH</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CriterionClass.field">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">field</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the field that the criterion refers to</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CriterionClass.negated">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">negated</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the condition should be negated</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CriterionClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The value of the intended field</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CriterionClass.values">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">values</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Values. one of which the intended field should match
|
||
Note, if values is set, the above “value” field will be ignored</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CustomAssertionInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">CustomAssertionInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entity</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logic</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes that are applicable to Custom Assertions</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>field</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>logic</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CustomAssertionInfoClass.entity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The entity targeted by this assertion.
|
||
This can have support more entityTypes (e.g. dataJob) in future</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CustomAssertionInfoClass.field">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">field</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>dataset schema field targeted by this assertion.</p>
|
||
<p>This field is expected to be provided if the assertion is on dataset field</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CustomAssertionInfoClass.logic">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">logic</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.CustomAssertionInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The type of custom assertion.
|
||
This is how your assertion will appear categorized in DataHub UI.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DashboardInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">charts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chartEdges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datasets</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datasetEdges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dashboards</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dashboardUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastRefreshed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a dashboard</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>title</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>lastModified</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" title="datahub.metadata.schema_classes.ChangeAuditStampsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChangeAuditStampsClass</span></code></a>)</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>charts</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>chartEdges</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClass</span></code></a>]])</p></li>
|
||
<li><p><strong>datasets</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>datasetEdges</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClass</span></code></a>]])</p></li>
|
||
<li><p><strong>dashboards</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClass</span></code></a>]])</p></li>
|
||
<li><p><strong>dashboardUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>access</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AccessLevelClass" title="datahub.metadata.schema_classes.AccessLevelClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccessLevelClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastRefreshed</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.access">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">access</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AccessLevelClass" title="datahub.metadata.schema_classes.AccessLevelClass"><span class="pre">AccessLevelClass</span></a></em></dt>
|
||
<dd><p>Access level for the dashboard</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.chartEdges">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">chartEdges</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><span class="pre">EdgeClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Charts in a dashboard</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.charts">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">charts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Charts in a dashboard
|
||
Deprecated! Use chartEdges instead.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.dashboardUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dashboardUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL for the dashboard. This could be used as an external link on DataHub to allow users access/view the dashboard</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.dashboards">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dashboards</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><span class="pre">EdgeClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Dashboards included by this dashboard.
|
||
Some dashboard entities (e.g. PowerBI Apps) can contain other dashboards.</p>
|
||
<p>The Edge’s sourceUrn should never be set, as it will always be the base dashboard.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.datasetEdges">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">datasetEdges</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><span class="pre">EdgeClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Datasets consumed by a dashboard</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.datasets">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">datasets</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Datasets consumed by a dashboard
|
||
Deprecated! Use datasetEdges instead.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Detailed description about the dashboard</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" title="datahub.metadata.schema_classes.ChangeAuditStampsClass"><span class="pre">ChangeAuditStampsClass</span></a></em></dt>
|
||
<dd><p>Captures information about who created/last modified/deleted this dashboard and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.lastRefreshed">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastRefreshed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The time when this dashboard last refreshed</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardInfoClass.title">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Title of the dashboard</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DashboardKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dashboardTool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dashboardId</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Dashboard</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dashboardTool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>dashboardId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardKeyClass.dashboardId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dashboardId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique id for the dashboard. This id should be globally unique for a dashboarding tool even when there are multiple deployments of it. As an example, dashboard URL could be used here for Looker such as ‘looker.linkedin.com/dashboards/1234’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardKeyClass.dashboardTool">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dashboardTool</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the dashboard tool such as looker, redash etc.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DashboardSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific Dashboard entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DashboardKeyClass" title="datahub.metadata.schema_classes.DashboardKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DashboardInfoClass" title="datahub.metadata.schema_classes.DashboardInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardInfoClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.EditableDashboardPropertiesClass" title="datahub.metadata.schema_classes.EditableDashboardPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableDashboardPropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstitutionalMemoryClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsV2Class</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DashboardKeyClass" title="datahub.metadata.schema_classes.DashboardKeyClass"><span class="pre">DashboardKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DashboardInfoClass" title="datahub.metadata.schema_classes.DashboardInfoClass"><span class="pre">DashboardInfoClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableDashboardPropertiesClass" title="datahub.metadata.schema_classes.EditableDashboardPropertiesClass"><span class="pre">EditableDashboardPropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><span class="pre">BrowsePathsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><span class="pre">GlossaryTermsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><span class="pre">InstitutionalMemoryClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><span class="pre">DataPlatformInstanceClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><span class="pre">BrowsePathsV2Class</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the dashboard. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DashboardUsageStatisticsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMillis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eventGranularity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partitionSpec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messageId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">viewsCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executionsCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uniqueUserCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">userCounts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">favoritesCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastViewedAt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Experimental (Subject to breaking change) – Stats corresponding to dashboard’s usage.</p>
|
||
<p>If this aspect represents the latest snapshot of the statistics about a Dashboard, the eventGranularity field should be null.
|
||
If this aspect represents a bucketed window of usage statistics (e.g. over a day), then the eventGranularity field should be set accordingly.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>timestampMillis</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>eventGranularity</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeWindowSizeClass</span></code></a>])</p></li>
|
||
<li><p><strong>partitionSpec</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionSpecClass</span></code></a>])</p></li>
|
||
<li><p><strong>messageId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>viewsCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>executionsCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>uniqueUserCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>userCounts</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DashboardUserUsageCountsClass" title="datahub.metadata.schema_classes.DashboardUserUsageCountsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardUserUsageCountsClass</span></code></a>]])</p></li>
|
||
<li><p><strong>favoritesCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>lastViewedAt</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass.ASPECT_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ASPECT_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timeseries'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass.eventGranularity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">eventGranularity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><span class="pre">TimeWindowSizeClass</span></a></em></dt>
|
||
<dd><p>Granularity of the event if applicable</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass.executionsCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">executionsCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The total number of dashboard executions (refreshes / syncs)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass.favoritesCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">favoritesCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The total number of times that the dashboard has been favorited</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass.lastViewedAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastViewedAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Last viewed at</p>
|
||
<p>This should not be set in cases where statistics are windowed.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass.messageId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">messageId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass.partitionSpec">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">partitionSpec</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><span class="pre">PartitionSpecClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The optional partition specification.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass.timestampMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The event timestamp field as epoch at UTC in milli seconds.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass.uniqueUserCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uniqueUserCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Unique user count</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass.userCounts">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">userCounts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DashboardUserUsageCountsClass" title="datahub.metadata.schema_classes.DashboardUserUsageCountsClass"><span class="pre">DashboardUserUsageCountsClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Users within this bucket, with frequency counts</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUsageStatisticsClass.viewsCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">viewsCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The total number of times dashboard has been viewed</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUserUsageCountsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DashboardUserUsageCountsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">viewsCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executionsCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usageCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">userEmail</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Records a single user’s usage counts for a given resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>viewsCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>executionsCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>usageCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>userEmail</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUserUsageCountsClass.executionsCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">executionsCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The number of times the user has executed (refreshed) the dashboard</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUserUsageCountsClass.usageCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">usageCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Normalized numeric metric representing user’s dashboard usage – the number of times the user executed or viewed the dashboard.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUserUsageCountsClass.user">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The unique id of the user.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUserUsageCountsClass.userEmail">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">userEmail</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>If user_email is set, we attempt to resolve the user’s urn upon ingest</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DashboardUserUsageCountsClass.viewsCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">viewsCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The number of times the user has viewed the dashboard</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataContractKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Data Contract</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique id for the contract</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataContractPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">freshness</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataQuality</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rawContract</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a data contract</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>schema</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SchemaContractClass" title="datahub.metadata.schema_classes.SchemaContractClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaContractClass</span></code></a>]])</p></li>
|
||
<li><p><strong>freshness</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FreshnessContractClass" title="datahub.metadata.schema_classes.FreshnessContractClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FreshnessContractClass</span></code></a>]])</p></li>
|
||
<li><p><strong>dataQuality</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataQualityContractClass" title="datahub.metadata.schema_classes.DataQualityContractClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataQualityContractClass</span></code></a>]])</p></li>
|
||
<li><p><strong>rawContract</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractPropertiesClass.dataQuality">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dataQuality</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DataQualityContractClass" title="datahub.metadata.schema_classes.DataQualityContractClass"><span class="pre">DataQualityContractClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>An optional set of Data Quality contracts, e.g. table and column level contract constraints.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractPropertiesClass.entity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The entity that this contract is associated with. Currently, we only support Dataset contracts, but
|
||
in the future we may also support Data Product level contracts.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractPropertiesClass.freshness">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">freshness</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.FreshnessContractClass" title="datahub.metadata.schema_classes.FreshnessContractClass"><span class="pre">FreshnessContractClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>An optional set of FRESHNESS contracts. If this is a dataset contract, there will only be one.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractPropertiesClass.rawContract">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rawContract</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>YAML-formatted contract definition</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractPropertiesClass.schema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaContractClass" title="datahub.metadata.schema_classes.SchemaContractClass"><span class="pre">SchemaContractClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>An optional set of schema contracts. If this is a dataset contract, there will only be one.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractStateClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataContractStateClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractStateClass.ACTIVE">
|
||
<span class="sig-name descname"><span class="pre">ACTIVE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ACTIVE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractStateClass.PENDING">
|
||
<span class="sig-name descname"><span class="pre">PENDING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PENDING'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractStatusClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataContractStatusClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about the status of a data contract</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>state</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataContractStateClass" title="datahub.metadata.schema_classes.DataContractStateClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataContractStateClass</span></code></a>])</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractStatusClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataContractStatusClass.state">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">state</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataContractStateClass" title="datahub.metadata.schema_classes.DataContractStateClass"><span class="pre">DataContractStateClass</span></a></em></dt>
|
||
<dd><p>The latest state of the data contract</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataFlowInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a Data processing flow</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>project</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>env</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FabricTypeClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowInfoClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><span class="pre">TimeStampClass</span></a></em></dt>
|
||
<dd><p>A timestamp documenting when the asset was created in the source Data Platform (not on DataHub)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowInfoClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Flow description</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowInfoClass.env">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">env</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><span class="pre">FabricTypeClass</span></a></em></dt>
|
||
<dd><p>Environment for this flow</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowInfoClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowInfoClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><span class="pre">TimeStampClass</span></a></em></dt>
|
||
<dd><p>A timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Flow name</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowInfoClass.project">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">project</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional project/namespace associated with the flow</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataFlowKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">orchestrator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flowId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Data Flow</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>orchestrator</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>flowId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowKeyClass.cluster">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cluster</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Cluster where the flow is executed</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowKeyClass.flowId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">flowId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique Identifier of the data flow</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowKeyClass.orchestrator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">orchestrator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Workflow manager like azkaban, airflow which orchestrates the flow</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataFlowSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific DataFlow entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataFlowKeyClass" title="datahub.metadata.schema_classes.DataFlowKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataFlowInfoClass" title="datahub.metadata.schema_classes.DataFlowInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowInfoClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.EditableDataFlowPropertiesClass" title="datahub.metadata.schema_classes.EditableDataFlowPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableDataFlowPropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstitutionalMemoryClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsV2Class</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DataFlowKeyClass" title="datahub.metadata.schema_classes.DataFlowKeyClass"><span class="pre">DataFlowKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataFlowInfoClass" title="datahub.metadata.schema_classes.DataFlowInfoClass"><span class="pre">DataFlowInfoClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableDataFlowPropertiesClass" title="datahub.metadata.schema_classes.EditableDataFlowPropertiesClass"><span class="pre">EditableDataFlowPropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><span class="pre">BrowsePathsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><span class="pre">GlossaryTermsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><span class="pre">InstitutionalMemoryClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><span class="pre">DataPlatformInstanceClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><span class="pre">BrowsePathsV2Class</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the data flow. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataFlowSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubAccessTokenInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubAccessTokenInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actorUrn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ownerUrn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">createdAt</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expiresAt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a DataHub Access Token</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>actorUrn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>ownerUrn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>createdAt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>expiresAt</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubAccessTokenInfoClass.actorUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actorUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the actor to which this access token belongs to.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubAccessTokenInfoClass.createdAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">createdAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>When the token was created.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubAccessTokenInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the token if defined.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubAccessTokenInfoClass.expiresAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">expiresAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>When the token expires.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubAccessTokenInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>User defined name for the access token if defined.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubAccessTokenInfoClass.ownerUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ownerUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the actor which created this access token.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubAccessTokenKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubAccessTokenKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a DataHub Access Token</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubAccessTokenKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Access token’s SHA-256 hashed JWT signature</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubActionKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubActionKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a DataHub Action Pipeline</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubActionKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the Action, either generated or provided</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubActorFilterClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubActorFilterClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">users</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resourceOwners</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resourceOwnersTypes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allUsers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allGroups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Information used to filter DataHub actors.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>users</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>groups</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>resourceOwners</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>resourceOwnersTypes</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>allUsers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>allGroups</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>roles</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubActorFilterClass.allGroups">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">allGroups</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the filter should apply to all groups.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubActorFilterClass.allUsers">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">allUsers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the filter should apply to all users.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubActorFilterClass.groups">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">groups</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A specific set of groups to apply the policy to (disjunctive)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubActorFilterClass.resourceOwners">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">resourceOwners</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the filter should return true for owners of a particular resource.
|
||
Only applies to policies of type ‘Metadata’, which have a resource associated with them.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubActorFilterClass.resourceOwnersTypes">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">resourceOwnersTypes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Define type of ownership for the policy</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubActorFilterClass.roles">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">roles</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A specific set of roles to apply the policy to (disjunctive).</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubActorFilterClass.users">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">users</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A specific set of users to apply the policy to (disjunctive)</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubConnectionDetailsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubConnectionDetailsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a connection to an external platform.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass" title="datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubConnectionDetailsTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>json</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataHubJsonConnectionClass" title="datahub.metadata.schema_classes.DataHubJsonConnectionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubJsonConnectionClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubConnectionDetailsClass.json">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">json</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubJsonConnectionClass" title="datahub.metadata.schema_classes.DataHubJsonConnectionClass"><span class="pre">DataHubJsonConnectionClass</span></a></em></dt>
|
||
<dd><p>An JSON payload containing raw connection details.
|
||
This will be present if the type is JSON.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubConnectionDetailsClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the connection</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubConnectionDetailsClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass" title="datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass"><span class="pre">DataHubConnectionDetailsTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the connection. This defines the schema / encoding of the connection details.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubConnectionDetailsTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubConnectionDetailsTypeClass.JSON">
|
||
<span class="sig-name descname"><span class="pre">JSON</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'JSON'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubConnectionKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubConnectionKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Connection</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubConnectionKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique identifier for the connection.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubIngestionSourceConfigClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recipe</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executorId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debugMode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extraArgs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>recipe</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>executorId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>debugMode</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>extraArgs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass.debugMode">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">debugMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether or not to run this ingestion source in debug mode</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass.executorId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">executorId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The id of the executor to use to execute the ingestion run</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass.extraArgs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">extraArgs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Extra arguments for the ingestion run.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass.recipe">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">recipe</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The JSON recipe to use for ingestion</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The PyPI version of the datahub CLI to use when executing a recipe</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubIngestionSourceInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schedule</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Info about a DataHub ingestion source</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>config</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass" title="datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubIngestionSourceConfigClass</span></code></a>)</p></li>
|
||
<li><p><strong>platform</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>schedule</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass" title="datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubIngestionSourceScheduleClass</span></code></a>])</p></li>
|
||
<li><p><strong>source</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass" title="datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubIngestionSourceSourceClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass.config">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass" title="datahub.metadata.schema_classes.DataHubIngestionSourceConfigClass"><span class="pre">DataHubIngestionSourceConfigClass</span></a></em></dt>
|
||
<dd><p>Parameters associated with the Ingestion Source</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The display name of the ingestion source</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Data Platform URN associated with the source</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass.schedule">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schedule</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass" title="datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass"><span class="pre">DataHubIngestionSourceScheduleClass</span></a></em></dt>
|
||
<dd><p>The schedule on which the ingestion source is executed</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass.source">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">source</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass" title="datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass"><span class="pre">DataHubIngestionSourceSourceClass</span></a></em></dt>
|
||
<dd><p>The source or origin of the Ingestion Source</p>
|
||
<p>Currently CLI and UI do not provide an explicit source.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The type of the source itself, e.g. mysql, bigquery, bigquery-usage. Should match the recipe.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubIngestionSourceKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a DataHub ingestion source</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the Ingestion Source, either generated or provided</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubIngestionSourceScheduleClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interval</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timezone</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>The schedule associated with an ingestion source.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>timezone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass.interval">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">interval</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A cron-formatted execution interval, as a cron string, e.g. * * * * *</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceScheduleClass.timezone">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timezone</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Timezone in which the cron interval applies, e.g. America/Los Angeles</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubIngestionSourceSourceClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass" title="datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubIngestionSourceSourceTypeClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceSourceClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass" title="datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass"><span class="pre">DataHubIngestionSourceSourceTypeClass</span></a></em></dt>
|
||
<dd><p>The source type of the ingestion source</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubIngestionSourceSourceTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubIngestionSourceSourceTypeClass.SYSTEM">
|
||
<span class="sig-name descname"><span class="pre">SYSTEM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SYSTEM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubJsonConnectionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubJsonConnectionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">encryptedBlob</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A set of connection details consisting of an encrypted JSON blob.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>encryptedBlob</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubJsonConnectionClass.encryptedBlob">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">encryptedBlob</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The encrypted JSON connection details.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubOpenAPISchemaKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Query</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubOpenAPISchemaKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the DataHub OpenAPI schema.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPersonaInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubPersonaInfoClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Placeholder aspect for persona type info</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPersonaKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubPersonaKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a persona type</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPersonaKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the persona type</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicyInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubPolicyInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">displayName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">privileges</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actors</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resources</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">editable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastUpdatedTimestamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a DataHub (UI) access policy.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>displayName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>state</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>privileges</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>actors</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.DataHubActorFilterClass" title="datahub.metadata.schema_classes.DataHubActorFilterClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubActorFilterClass</span></code></a>)</p></li>
|
||
<li><p><strong>resources</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataHubResourceFilterClass" title="datahub.metadata.schema_classes.DataHubResourceFilterClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubResourceFilterClass</span></code></a>])</p></li>
|
||
<li><p><strong>editable</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>lastUpdatedTimestamp</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicyInfoClass.actors">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actors</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubActorFilterClass" title="datahub.metadata.schema_classes.DataHubActorFilterClass"><span class="pre">DataHubActorFilterClass</span></a></em></dt>
|
||
<dd><p>The actors that the policy applies to.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicyInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the Policy</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicyInfoClass.displayName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">displayName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the Policy</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicyInfoClass.editable">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">editable</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the policy should be editable via the UI</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicyInfoClass.lastUpdatedTimestamp">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastUpdatedTimestamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Timestamp when the policy was last updated</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicyInfoClass.privileges">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">privileges</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The privileges that the policy grants.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicyInfoClass.resources">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">resources</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubResourceFilterClass" title="datahub.metadata.schema_classes.DataHubResourceFilterClass"><span class="pre">DataHubResourceFilterClass</span></a></em></dt>
|
||
<dd><p>The resource that the policy applies to. Not required for some ‘Platform’ privileges.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicyInfoClass.state">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">state</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The state of policy, ACTIVE or INACTIVE</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicyInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The type of policy</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicyKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubPolicyKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a DataHub Policy</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicyKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the DataHub access policy record. Generated on the server side at policy creation time.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicySnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubPolicySnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for DataHub Access Policy data.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataHubPolicyKeyClass" title="datahub.metadata.schema_classes.DataHubPolicyKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPolicyKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataHubPolicyInfoClass" title="datahub.metadata.schema_classes.DataHubPolicyInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPolicyInfoClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicySnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubPolicyKeyClass" title="datahub.metadata.schema_classes.DataHubPolicyKeyClass"><span class="pre">DataHubPolicyKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubPolicyInfoClass" title="datahub.metadata.schema_classes.DataHubPolicyInfoClass"><span class="pre">DataHubPolicyInfoClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the DataHub access policy.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubPolicySnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubResourceFilterClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubResourceFilterClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resources</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allResources</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Information used to filter DataHub resource.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>resources</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>allResources</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>filter</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PolicyMatchFilterClass" title="datahub.metadata.schema_classes.PolicyMatchFilterClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PolicyMatchFilterClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubResourceFilterClass.allResources">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">allResources</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the policy should be applied to all assets matching the filter.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubResourceFilterClass.filter">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filter</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PolicyMatchFilterClass" title="datahub.metadata.schema_classes.PolicyMatchFilterClass"><span class="pre">PolicyMatchFilterClass</span></a></em></dt>
|
||
<dd><p>Filter to apply privileges to</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubResourceFilterClass.resources">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">resources</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A specific set of resources to apply the policy to, e.g. asset urns</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubResourceFilterClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The type of resource that the policy applies to. This will most often be a data asset entity name, for
|
||
example ‘dataset’. It is not strictly required because in the future we will want to support filtering a resource
|
||
by domain, as well.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRetentionConfigClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubRetentionConfigClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">retention</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>retention</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.RetentionClass" title="datahub.metadata.schema_classes.RetentionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RetentionClass</span></code></a>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRetentionConfigClass.retention">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">retention</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.RetentionClass" title="datahub.metadata.schema_classes.RetentionClass"><span class="pre">RetentionClass</span></a></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRetentionKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubRetentionKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entityName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspectName</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a DataHub Retention</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>entityName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspectName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRetentionKeyClass.aspectName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspectName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Aspect name to apply retention to. * (or empty) for applying defaults.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRetentionKeyClass.entityName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entityName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Entity name to apply retention to. * (or empty) for applying defaults.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRetentionSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubRetentionSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for DataHub Access Policy data.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataHubRetentionKeyClass" title="datahub.metadata.schema_classes.DataHubRetentionKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRetentionKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataHubRetentionConfigClass" title="datahub.metadata.schema_classes.DataHubRetentionConfigClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRetentionConfigClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRetentionSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubRetentionKeyClass" title="datahub.metadata.schema_classes.DataHubRetentionKeyClass"><span class="pre">DataHubRetentionKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubRetentionConfigClass" title="datahub.metadata.schema_classes.DataHubRetentionConfigClass"><span class="pre">DataHubRetentionConfigClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the DataHub access policy.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRetentionSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRoleInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubRoleInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">editable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a DataHub Role.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>editable</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRoleInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the Role</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRoleInfoClass.editable">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">editable</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the role should be editable via the UI</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRoleInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the Role</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRoleKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubRoleKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a DataHub Role</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubRoleKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the DataHub role record. Generated on the server side at role creation time.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubSearchConfigClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fieldName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">queryByDefault</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enableAutocomplete</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">addToFilters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">addHasValuesToFilters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filterNameOverride</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hasValuesFilterNameOverride</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boostScore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hasValuesFieldName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numValuesFieldName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weightsPerFieldValue</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldNameAliases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Configuration for how any given field should be indexed and matched in the DataHub search index.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>fieldName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>fieldType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.SearchFieldTypeClass" title="datahub.metadata.schema_classes.SearchFieldTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SearchFieldTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>queryByDefault</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>enableAutocomplete</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>addToFilters</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>addHasValuesToFilters</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>filterNameOverride</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>hasValuesFilterNameOverride</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>boostScore</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>])</p></li>
|
||
<li><p><strong>hasValuesFieldName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>numValuesFieldName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>weightsPerFieldValue</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]])</p></li>
|
||
<li><p><strong>fieldNameAliases</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.addHasValuesToFilters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">addHasValuesToFilters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether or not to add the “has values” to filters.
|
||
check if this is conditional on addToFilters being true</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.addToFilters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">addToFilters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether or not to add field to filters.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.boostScore">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">boostScore</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em></dt>
|
||
<dd><p>Boost multiplier to the match score. Matches on fields with higher boost score ranks higher</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.enableAutocomplete">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">enableAutocomplete</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether we should use the field for default autocomplete</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.fieldName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the field in the search index. Defaults to the field name otherwise</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.fieldNameAliases">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldNameAliases</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>(Optional) Aliases for this given field that can be used for sorting etc.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.fieldType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SearchFieldTypeClass" title="datahub.metadata.schema_classes.SearchFieldTypeClass"><span class="pre">SearchFieldTypeClass</span></a></em></dt>
|
||
<dd><p>Type of the field. Defines how the field is indexed and matched</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.filterNameOverride">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filterNameOverride</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the filter</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.hasValuesFieldName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hasValuesFieldName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>If set, add a index field of the given name that checks whether the field exists</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.hasValuesFilterNameOverride">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hasValuesFilterNameOverride</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the has values filter</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.numValuesFieldName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numValuesFieldName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>If set, add a index field of the given name that checks the number of elements</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.queryByDefault">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">queryByDefault</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether we should match the field for the default search query</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSearchConfigClass.weightsPerFieldValue">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">weightsPerFieldValue</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>(Optional) Weights to apply to score for a given value</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSecretKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubSecretKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a DataHub Secret</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSecretKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the Secret</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSecretValueClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubSecretValueClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>The value of a DataHub Secret</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSecretValueClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Created Audit stamp</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSecretValueClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the secret</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSecretValueClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The display name for the secret</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubSecretValueClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The AES-encrypted value of the DataHub secret.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubStepStateKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubStepStateKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a DataHub Step State</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubStepStateKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the state</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubStepStatePropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubStepStatePropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lastModified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">properties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>The properties associated with a DataHub step state</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>lastModified</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>properties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubStepStatePropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp describing the last person to update it.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubStepStatePropertiesClass.properties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">properties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Description of the secret</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubUpgradeKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a DataHubUpgrade</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeRequestClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubUpgradeRequestClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information collected when kicking off a DataHubUpgrade</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>timestampMs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeRequestClass.timestampMs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Timestamp when we started this DataHubUpgrade</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeRequestClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Version of this upgrade</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeResultClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubUpgradeResultClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information collected when a DataHubUpgrade successfully finishes</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>timestampMs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>state</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataHubUpgradeStateClass" title="datahub.metadata.schema_classes.DataHubUpgradeStateClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubUpgradeStateClass</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>])</p></li>
|
||
<li><p><strong>result</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeResultClass.result">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Result map to place helpful information about this upgrade job</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeResultClass.state">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">state</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubUpgradeStateClass" title="datahub.metadata.schema_classes.DataHubUpgradeStateClass"><span class="pre">DataHubUpgradeStateClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>Upgrade state UpgradeResult.Result</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeResultClass.timestampMs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Timestamp when we started this DataHubUpgrade</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeStateClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubUpgradeStateClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeStateClass.ABORTED">
|
||
<span class="sig-name descname"><span class="pre">ABORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ABORTED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeStateClass.FAILED">
|
||
<span class="sig-name descname"><span class="pre">FAILED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FAILED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeStateClass.IN_PROGRESS">
|
||
<span class="sig-name descname"><span class="pre">IN_PROGRESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IN_PROGRESS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubUpgradeStateClass.SUCCEEDED">
|
||
<span class="sig-name descname"><span class="pre">SUCCEEDED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SUCCEEDED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewDefinitionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubViewDefinitionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entityTypes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A View definition.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>entityTypes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>filter</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.FilterClass" title="datahub.metadata.schema_classes.FilterClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FilterClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewDefinitionClass.entityTypes">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entityTypes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The Entity Types in the scope of the View.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewDefinitionClass.filter">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filter</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FilterClass" title="datahub.metadata.schema_classes.FilterClass"><span class="pre">FilterClass</span></a></em></dt>
|
||
<dd><p>The filter criteria, which represents the view itself</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubViewInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">definition</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a DataHub View. – TODO: Understand whether an entity type filter is required.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataHubViewTypeClass" title="datahub.metadata.schema_classes.DataHubViewTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubViewTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>definition</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.DataHubViewDefinitionClass" title="datahub.metadata.schema_classes.DataHubViewDefinitionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubViewDefinitionClass</span></code></a>)</p></li>
|
||
<li><p><strong>created</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>lastModified</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewInfoClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp capturing the time and actor who created the View.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewInfoClass.definition">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubViewDefinitionClass" title="datahub.metadata.schema_classes.DataHubViewDefinitionClass"><span class="pre">DataHubViewDefinitionClass</span></a></em></dt>
|
||
<dd><p>The view itself</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the view</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewInfoClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp capturing the time and actor who last modified the View.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the View</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubViewTypeClass" title="datahub.metadata.schema_classes.DataHubViewTypeClass"><span class="pre">DataHubViewTypeClass</span></a></em></dt>
|
||
<dd><p>The type of View</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubViewKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a DataHub View</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the View</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataHubViewTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewTypeClass.GLOBAL">
|
||
<span class="sig-name descname"><span class="pre">GLOBAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'GLOBAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataHubViewTypeClass.PERSONAL">
|
||
<span class="sig-name descname"><span class="pre">PERSONAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PERSONAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataJobInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flowUrn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a Data processing job</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AzkabanJobTypeClass" title="datahub.metadata.schema_classes.AzkabanJobTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AzkabanJobTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>flowUrn</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>status</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.JobStatusClass" title="datahub.metadata.schema_classes.JobStatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">JobStatusClass</span></code></a>])</p></li>
|
||
<li><p><strong>env</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FabricTypeClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInfoClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><span class="pre">TimeStampClass</span></a></em></dt>
|
||
<dd><p>A timestamp documenting when the asset was created in the source Data Platform (not on DataHub)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInfoClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Job description</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInfoClass.env">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">env</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><span class="pre">FabricTypeClass</span></a></em></dt>
|
||
<dd><p>Environment for this job</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInfoClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInfoClass.flowUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">flowUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>DataFlow urn that this job is part of</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInfoClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><span class="pre">TimeStampClass</span></a></em></dt>
|
||
<dd><p>A timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Job name</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInfoClass.status">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.JobStatusClass" title="datahub.metadata.schema_classes.JobStatusClass"><span class="pre">JobStatusClass</span></a></em></dt>
|
||
<dd><p>Status of the job - Deprecated for Data Process Instance model.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AzkabanJobTypeClass" title="datahub.metadata.schema_classes.AzkabanJobTypeClass"><span class="pre">AzkabanJobTypeClass</span></a></em></dt>
|
||
<dd><p>Datajob type
|
||
<em>NOTE*</em>: AzkabanJobType is deprecated. Please use strings instead.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInputOutputClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataJobInputOutputClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inputDatasets</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outputDatasets</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputDatasetEdges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outputDatasetEdges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputDatajobs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputDatajobEdges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputDatasetFields</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outputDatasetFields</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fineGrainedLineages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about the inputs and outputs of a Data processing job</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>inputDatasets</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>outputDatasets</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>inputDatasetEdges</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClass</span></code></a>]])</p></li>
|
||
<li><p><strong>outputDatasetEdges</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClass</span></code></a>]])</p></li>
|
||
<li><p><strong>inputDatajobs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>inputDatajobEdges</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClass</span></code></a>]])</p></li>
|
||
<li><p><strong>inputDatasetFields</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>outputDatasetFields</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>fineGrainedLineages</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FineGrainedLineageClass" title="datahub.metadata.schema_classes.FineGrainedLineageClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FineGrainedLineageClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInputOutputClass.fineGrainedLineages">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fineGrainedLineages</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.FineGrainedLineageClass" title="datahub.metadata.schema_classes.FineGrainedLineageClass"><span class="pre">FineGrainedLineageClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Fine-grained column-level lineages
|
||
Not currently supported in the UI
|
||
Use UpstreamLineage aspect for datasets to express Column Level Lineage for the UI</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInputOutputClass.inputDatajobEdges">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inputDatajobEdges</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><span class="pre">EdgeClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Input datajobs that this data job depends on</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInputOutputClass.inputDatajobs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inputDatajobs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Input datajobs that this data job depends on
|
||
Deprecated! Use inputDatajobEdges instead.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInputOutputClass.inputDatasetEdges">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inputDatasetEdges</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><span class="pre">EdgeClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Input datasets consumed by the data job during processing</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInputOutputClass.inputDatasetFields">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inputDatasetFields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Fields of the input datasets used by this job</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInputOutputClass.inputDatasets">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inputDatasets</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Input datasets consumed by the data job during processing
|
||
Deprecated! Use inputDatasetEdges instead.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInputOutputClass.outputDatasetEdges">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">outputDatasetEdges</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><span class="pre">EdgeClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Output datasets produced by the data job during processing</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInputOutputClass.outputDatasetFields">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">outputDatasetFields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Fields of the output datasets this job writes to</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobInputOutputClass.outputDatasets">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">outputDatasets</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Output datasets produced by the data job during processing
|
||
Deprecated! Use outputDatasetEdges instead.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataJobKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flow</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jobId</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Data Job</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>flow</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>jobId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobKeyClass.flow">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">flow</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Standardized data processing flow urn representing the flow for the job</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobKeyClass.jobId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">jobId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique Identifier of the data job</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataJobSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific DataJob entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataJobKeyClass" title="datahub.metadata.schema_classes.DataJobKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataJobKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataJobInfoClass" title="datahub.metadata.schema_classes.DataJobInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataJobInfoClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataJobInputOutputClass" title="datahub.metadata.schema_classes.DataJobInputOutputClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataJobInputOutputClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.EditableDataJobPropertiesClass" title="datahub.metadata.schema_classes.EditableDataJobPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableDataJobPropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstitutionalMemoryClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsV2Class</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DataJobKeyClass" title="datahub.metadata.schema_classes.DataJobKeyClass"><span class="pre">DataJobKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataJobInfoClass" title="datahub.metadata.schema_classes.DataJobInfoClass"><span class="pre">DataJobInfoClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataJobInputOutputClass" title="datahub.metadata.schema_classes.DataJobInputOutputClass"><span class="pre">DataJobInputOutputClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableDataJobPropertiesClass" title="datahub.metadata.schema_classes.EditableDataJobPropertiesClass"><span class="pre">EditableDataJobPropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><span class="pre">BrowsePathsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><span class="pre">GlossaryTermsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><span class="pre">InstitutionalMemoryClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><span class="pre">DataPlatformInstanceClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><span class="pre">BrowsePathsV2Class</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the data job. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataJobSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataPlatformInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datasetNameDelimiter</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">displayName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logoUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a data platform</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.PlatformTypeClass" title="datahub.metadata.schema_classes.PlatformTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlatformTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>datasetNameDelimiter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>displayName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>logoUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInfoClass.datasetNameDelimiter">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">datasetNameDelimiter</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The delimiter in the dataset names on the data platform, e.g. ‘/’ for HDFS and ‘.’ for Oracle</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInfoClass.displayName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">displayName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name that will be used for displaying a platform type.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInfoClass.logoUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">logoUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The URL for a logo associated with the platform</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the data platform</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PlatformTypeClass" title="datahub.metadata.schema_classes.PlatformTypeClass"><span class="pre">PlatformTypeClass</span></a></em></dt>
|
||
<dd><p>Platform type this data platform describes</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInstanceClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataPlatformInstanceClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>The specific instance of the data platform that this entity belongs to</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>instance</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInstanceClass.instance">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">instance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Instance of the data platform (e.g. db instance)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInstanceClass.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Data Platform</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInstanceKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataPlatformInstanceKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Dataset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>instance</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInstanceKeyClass.instance">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">instance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique instance id</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInstanceKeyClass.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Data platform urn associated with the instance</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataPlatformInstancePropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a Data Platform Instance</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the Data Platform Instance</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformInstancePropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the Data Platform Instance</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataPlatformKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platformName</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Data Platform</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>platformName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformKeyClass.platformName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platformName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Data platform name i.e. hdfs, oracle, espresso</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataPlatformSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific dataplatform entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformKeyClass" title="datahub.metadata.schema_classes.DataPlatformKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInfoClass" title="datahub.metadata.schema_classes.DataPlatformInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInfoClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformKeyClass" title="datahub.metadata.schema_classes.DataPlatformKeyClass"><span class="pre">DataPlatformKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInfoClass" title="datahub.metadata.schema_classes.DataPlatformInfoClass"><span class="pre">DataPlatformInfoClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the data platform. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataPlatformSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProcessInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inputs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outputs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>The inputs and outputs of this data process</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>inputs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>outputs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInfoClass.inputs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inputs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>the inputs of the data process</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInfoClass.outputs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">outputs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>the outputs of the data process</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceInputClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProcessInstanceInputClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inputs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputEdges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about the inputs datasets of a Data process</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>inputs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>inputEdges</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceInputClass.inputEdges">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inputEdges</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><span class="pre">EdgeClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Input assets consumed by the data process instance, with additional metadata.
|
||
Counts as lineage.
|
||
Will eventually deprecate the inputs field.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceInputClass.inputs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inputs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Input assets consumed</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProcessInstanceKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for an Asset DataProcessInstance</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the DataProcessInstance . Should be separate from the name used for displaying a DataProcessInstance.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceOutputClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProcessInstanceOutputClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">outputs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outputEdges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about the outputs of a Data process</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>outputs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>outputEdges</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceOutputClass.outputEdges">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">outputEdges</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.EdgeClass" title="datahub.metadata.schema_classes.EdgeClass"><span class="pre">EdgeClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Output assets produced by the data process instance during processing, with additional metadata.
|
||
Counts as lineage.
|
||
Will eventually deprecate the outputs field.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceOutputClass.outputs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">outputs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Output assets produced</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstancePropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProcessInstancePropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>The inputs and outputs of this data process</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>created</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessTypeClass" title="datahub.metadata.schema_classes.DataProcessTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessTypeClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstancePropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who reported the lineage and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstancePropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstancePropertiesClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstancePropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Process name</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstancePropertiesClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessTypeClass" title="datahub.metadata.schema_classes.DataProcessTypeClass"><span class="pre">DataProcessTypeClass</span></a></em></dt>
|
||
<dd><p>Process type</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProcessInstanceRelationshipsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">upstreamInstances</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parentTemplate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parentInstance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about Data process relationships</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>upstreamInstances</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>parentTemplate</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>parentInstance</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass.parentInstance">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parentInstance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The parent DataProcessInstance where it belongs to.
|
||
If it is a Airflow Task then it should belong to an Airflow Dag run as well
|
||
which will be another DataProcessInstance</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass.parentTemplate">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parentTemplate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The parent entity whose run instance it is</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRelationshipsClass.upstreamInstances">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upstreamInstances</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Input DataProcessInstance which triggered this dataprocess instance</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProcessInstanceRunEventClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMillis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eventGranularity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partitionSpec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messageId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attempt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">durationMillis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>An event representing the current status of data process run.
|
||
DataProcessRunEvent should be used for reporting the status of a dataProcess’ run.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>timestampMillis</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>status</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessRunStatusClass" title="datahub.metadata.schema_classes.DataProcessRunStatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessRunStatusClass</span></code></a>])</p></li>
|
||
<li><p><strong>eventGranularity</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeWindowSizeClass</span></code></a>])</p></li>
|
||
<li><p><strong>partitionSpec</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionSpecClass</span></code></a>])</p></li>
|
||
<li><p><strong>messageId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>attempt</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>result</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessInstanceRunResultClass" title="datahub.metadata.schema_classes.DataProcessInstanceRunResultClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInstanceRunResultClass</span></code></a>])</p></li>
|
||
<li><p><strong>durationMillis</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass.ASPECT_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ASPECT_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timeseries'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass.attempt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">attempt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Return the try number that this Instance Run is in</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass.durationMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">durationMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The duration of the run in milliseconds.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass.eventGranularity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">eventGranularity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><span class="pre">TimeWindowSizeClass</span></a></em></dt>
|
||
<dd><p>Granularity of the event if applicable</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass.messageId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">messageId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass.partitionSpec">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">partitionSpec</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><span class="pre">PartitionSpecClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The optional partition specification.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass.result">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessInstanceRunResultClass" title="datahub.metadata.schema_classes.DataProcessInstanceRunResultClass"><span class="pre">DataProcessInstanceRunResultClass</span></a></em></dt>
|
||
<dd><p>The final result of the Data Processing run.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass.status">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessRunStatusClass" title="datahub.metadata.schema_classes.DataProcessRunStatusClass"><span class="pre">DataProcessRunStatusClass</span></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunEventClass.timestampMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The event timestamp field as epoch at UTC in milli seconds.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunResultClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProcessInstanceRunResultClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nativeResultType</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.RunResultTypeClass" title="datahub.metadata.schema_classes.RunResultTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RunResultTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>nativeResultType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunResultClass.nativeResultType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nativeResultType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>It identifies the system where the native result comes from like Airflow, Azkaban, etc..</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessInstanceRunResultClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.RunResultTypeClass" title="datahub.metadata.schema_classes.RunResultTypeClass"><span class="pre">RunResultTypeClass</span></a></em></dt>
|
||
<dd><p>The final result, e.g. SUCCESS, FAILURE, SKIPPED, or UP_FOR_RETRY.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProcessKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">orchestrator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">origin</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Data Process</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>orchestrator</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>origin</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FabricTypeClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Process name i.e. an ETL job name</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessKeyClass.orchestrator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">orchestrator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Standardized Orchestrator where data process is defined.
|
||
TODO: Migrate towards something that can be validated like DataPlatform urn</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessKeyClass.origin">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">origin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><span class="pre">FabricTypeClass</span></a></em></dt>
|
||
<dd><p>Fabric type where dataset belongs to or where it was generated.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessRunStatusClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProcessRunStatusClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessRunStatusClass.COMPLETE">
|
||
<span class="sig-name descname"><span class="pre">COMPLETE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'COMPLETE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessRunStatusClass.STARTED">
|
||
<span class="sig-name descname"><span class="pre">STARTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STARTED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProcessSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific Data process entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessKeyClass" title="datahub.metadata.schema_classes.DataProcessKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessInfoClass" title="datahub.metadata.schema_classes.DataProcessInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessInfoClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessKeyClass" title="datahub.metadata.schema_classes.DataProcessKeyClass"><span class="pre">DataProcessKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessInfoClass" title="datahub.metadata.schema_classes.DataProcessInfoClass"><span class="pre">DataProcessInfoClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the data process. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProcessTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessTypeClass.BATCH_AD_HOC">
|
||
<span class="sig-name descname"><span class="pre">BATCH_AD_HOC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BATCH_AD_HOC'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessTypeClass.BATCH_SCHEDULED">
|
||
<span class="sig-name descname"><span class="pre">BATCH_SCHEDULED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BATCH_SCHEDULED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProcessTypeClass.STREAMING">
|
||
<span class="sig-name descname"><span class="pre">STREAMING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STREAMING'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductAssociationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProductAssociationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">destinationUrn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sourceUrn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">properties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outputPort</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Represents an association of assets to a Data Product.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>destinationUrn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>sourceUrn</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>properties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>outputPort</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductAssociationClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who created this relationship edge and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductAssociationClass.destinationUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">destinationUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the destination of this relationship edge.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductAssociationClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who last modified this relationship edge and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductAssociationClass.outputPort">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">outputPort</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>If set to true, this asset is an output port of the Data Product.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductAssociationClass.properties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">properties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A generic properties bag that allows us to store specific information on this graph edge.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductAssociationClass.sourceUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the source of this relationship edge.
|
||
If not specified, assumed to be the entity that this aspect belongs to.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProductKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Query</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the Data Product.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataProductPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">assets</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>The main properties of a Data Product</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>assets</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataProductAssociationClass" title="datahub.metadata.schema_classes.DataProductAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProductAssociationClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductPropertiesClass.assets">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">assets</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProductAssociationClass" title="datahub.metadata.schema_classes.DataProductAssociationClass"><span class="pre">DataProductAssociationClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A list of assets that are part of this Data Product</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductPropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the dataset</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductPropertiesClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataProductPropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the Data Product</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataQualityContractClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataQualityContractClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">assertion</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A data quality contract pertaining to a physical data asset
|
||
Data Quality contracts are used to make assertions about data quality metrics for a physical data asset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>assertion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataQualityContractClass.assertion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">assertion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The assertion representing the Data Quality contract.
|
||
E.g. a table or column-level assertion.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataTransformClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataTransformClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">queryStatement</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Information about a transformation. It may be a query,</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>queryStatement</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.QueryStatementClass" title="datahub.metadata.schema_classes.QueryStatementClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryStatementClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataTransformClass.queryStatement">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">queryStatement</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.QueryStatementClass" title="datahub.metadata.schema_classes.QueryStatementClass"><span class="pre">QueryStatementClass</span></a></em></dt>
|
||
<dd><p>The data transform may be defined by a query statement</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataTransformLogicClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataTransformLogicClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transforms</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a Query against one or more data assets (e.g. Tables or Views).</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>transforms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataTransformClass" title="datahub.metadata.schema_classes.DataTransformClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataTransformClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataTransformLogicClass.transforms">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transforms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DataTransformClass" title="datahub.metadata.schema_classes.DataTransformClass"><span class="pre">DataTransformClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of transformations applied</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataTypeInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataTypeInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">qualifiedName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">displayName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>qualifiedName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>displayName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataTypeInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>An optional description for the data type.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataTypeInfoClass.displayName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">displayName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>An optional display name for the data type.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataTypeInfoClass.qualifiedName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">qualifiedName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The qualified name for the data type. Usually a unique namespace + name, e.g. datahub.string</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataTypeKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DataTypeKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DataTypeKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for a data type. Usually this will be a unique namespace + data type name.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatahubIngestionCheckpointClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMillis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pipelineName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platformInstanceId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eventGranularity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partitionSpec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messageId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Checkpoint of a datahub ingestion run for a given job.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>timestampMillis</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>pipelineName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>platformInstanceId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>state</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.IngestionCheckpointStateClass" title="datahub.metadata.schema_classes.IngestionCheckpointStateClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IngestionCheckpointStateClass</span></code></a>)</p></li>
|
||
<li><p><strong>runId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>eventGranularity</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeWindowSizeClass</span></code></a>])</p></li>
|
||
<li><p><strong>partitionSpec</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionSpecClass</span></code></a>])</p></li>
|
||
<li><p><strong>messageId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass.ASPECT_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ASPECT_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timeseries'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass.config">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Json-encoded string representation of the non-secret members of the config .</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass.eventGranularity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">eventGranularity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><span class="pre">TimeWindowSizeClass</span></a></em></dt>
|
||
<dd><p>Granularity of the event if applicable</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass.messageId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">messageId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass.partitionSpec">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">partitionSpec</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><span class="pre">PartitionSpecClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The optional partition specification.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass.pipelineName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pipelineName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the pipeline that ran ingestion, a stable unique user provided identifier.
|
||
e.g. my_snowflake1-to-datahub.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass.platformInstanceId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platformInstanceId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The id of the instance against which the ingestion pipeline ran.
|
||
e.g.: Bigquery project ids, MySQL hostnames etc.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass.runId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">runId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The run identifier of this job.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass.state">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">state</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IngestionCheckpointStateClass" title="datahub.metadata.schema_classes.IngestionCheckpointStateClass"><span class="pre">IngestionCheckpointStateClass</span></a></em></dt>
|
||
<dd><p>Opaque blob of the state representation.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionCheckpointClass.timestampMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The event timestamp field as epoch at UTC in milli seconds.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatahubIngestionRunSummaryClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMillis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pipelineName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platformInstanceId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runStatus</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eventGranularity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partitionSpec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messageId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numWorkUnitsCommitted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numWorkUnitsCreated</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numEvents</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numEntities</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numAspects</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numSourceAPICalls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">totalLatencySourceAPICalls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numSinkAPICalls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">totalLatencySinkAPICalls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numWarnings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numErrors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numEntitiesSkipped</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_summary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">softwareVersion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">systemHostName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operatingSystemName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numProcessors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">totalMemory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">availableMemory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Summary of a datahub ingestion run for a given platform.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>timestampMillis</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>pipelineName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>platformInstanceId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>runId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>runStatus</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.JobStatusClass" title="datahub.metadata.schema_classes.JobStatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">JobStatusClass</span></code></a>])</p></li>
|
||
<li><p><strong>eventGranularity</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeWindowSizeClass</span></code></a>])</p></li>
|
||
<li><p><strong>partitionSpec</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionSpecClass</span></code></a>])</p></li>
|
||
<li><p><strong>messageId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>numWorkUnitsCommitted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>numWorkUnitsCreated</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>numEvents</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>numEntities</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>numAspects</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>numSourceAPICalls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>totalLatencySourceAPICalls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>numSinkAPICalls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>totalLatencySinkAPICalls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>numWarnings</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>numErrors</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>numEntitiesSkipped</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>config</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>custom_summary</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>softwareVersion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>systemHostName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>operatingSystemName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>numProcessors</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>totalMemory</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>availableMemory</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.ASPECT_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ASPECT_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timeseries'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.availableMemory">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">availableMemory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The available memory on the host the ingestion pipeline ran on.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.config">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The non-sensitive key-value pairs of the yaml config used as json string.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.custom_summary">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">custom_summary</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Custom value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.eventGranularity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">eventGranularity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><span class="pre">TimeWindowSizeClass</span></a></em></dt>
|
||
<dd><p>Granularity of the event if applicable</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.messageId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">messageId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.numAspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numAspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The total number of aspects produced across all entities.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.numEntities">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numEntities</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The total number of entities produced (unique entity urns).</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.numEntitiesSkipped">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numEntitiesSkipped</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Number of entities skipped.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.numErrors">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numErrors</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Number of errors generated.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.numEvents">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numEvents</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The number of events produced (MCE + MCP).</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.numProcessors">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numProcessors</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The number of processors on the host the ingestion pipeline ran on.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.numSinkAPICalls">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numSinkAPICalls</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Total number of sink API calls.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.numSourceAPICalls">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numSourceAPICalls</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Total number of source API calls.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.numWarnings">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numWarnings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Number of warnings generated.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.numWorkUnitsCommitted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numWorkUnitsCommitted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The number of workunits written to sink.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.numWorkUnitsCreated">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numWorkUnitsCreated</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The number of workunits that are produced.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.operatingSystemName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">operatingSystemName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The os the ingestion pipeline ran on.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.partitionSpec">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">partitionSpec</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><span class="pre">PartitionSpecClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The optional partition specification.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.pipelineName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pipelineName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the pipeline that ran ingestion, a stable unique user provided identifier.
|
||
e.g. my_snowflake1-to-datahub.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.platformInstanceId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platformInstanceId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The id of the instance against which the ingestion pipeline ran.
|
||
e.g.: Bigquery project ids, MySQL hostnames etc.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.runId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">runId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The runId for this pipeline instance.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.runStatus">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">runStatus</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.JobStatusClass" title="datahub.metadata.schema_classes.JobStatusClass"><span class="pre">JobStatusClass</span></a></em></dt>
|
||
<dd><p>Run Status - Succeeded/Skipped/Failed etc.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.softwareVersion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">softwareVersion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The software version of this ingestion.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.systemHostName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">systemHostName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The hostname the ingestion pipeline ran on.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.timestampMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The event timestamp field as epoch at UTC in milli seconds.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.totalLatencySinkAPICalls">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">totalLatencySinkAPICalls</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Total latency across all sink API calls.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.totalLatencySourceAPICalls">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">totalLatencySourceAPICalls</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Total latency across all source API calls.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatahubIngestionRunSummaryClass.totalMemory">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">totalMemory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The total amount of memory on the host the ingestion pipeline ran on.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetAssertionInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scope</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fields</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aggregation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nativeType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nativeParameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logic</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes that are applicable to single-Dataset Assertions</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dataset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>scope</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.DatasetAssertionScopeClass" title="datahub.metadata.schema_classes.DatasetAssertionScopeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetAssertionScopeClass</span></code></a>])</p></li>
|
||
<li><p><strong>operator</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdOperatorClass</span></code></a>])</p></li>
|
||
<li><p><strong>fields</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>aggregation</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdAggregationClass" title="datahub.metadata.schema_classes.AssertionStdAggregationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdAggregationClass</span></code></a>])</p></li>
|
||
<li><p><strong>parameters</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdParametersClass</span></code></a>])</p></li>
|
||
<li><p><strong>nativeType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>nativeParameters</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>logic</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionInfoClass.aggregation">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aggregation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdAggregationClass" title="datahub.metadata.schema_classes.AssertionStdAggregationClass"><span class="pre">AssertionStdAggregationClass</span></a></em></dt>
|
||
<dd><p>Standardized assertion operator
|
||
This field is left blank if there is no selected aggregation or metric for a particular column.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionInfoClass.dataset">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dataset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The dataset targeted by this assertion.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionInfoClass.fields">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>One or more dataset schema fields that are targeted by this assertion.</p>
|
||
<p>This field is expected to be provided if the assertion scope is DATASET_COLUMN.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionInfoClass.logic">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">logic</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionInfoClass.nativeParameters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nativeParameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Native parameters required for the assertion.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionInfoClass.nativeType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nativeType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Native assertion type</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionInfoClass.operator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">operator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><span class="pre">AssertionStdOperatorClass</span></a></em></dt>
|
||
<dd><p>Standardized assertion operator</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionInfoClass.parameters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><span class="pre">AssertionStdParametersClass</span></a></em></dt>
|
||
<dd><p>Standard parameters required for the assertion. e.g. min_value, max_value, value, columns</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionInfoClass.scope">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">scope</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetAssertionScopeClass" title="datahub.metadata.schema_classes.DatasetAssertionScopeClass"><span class="pre">DatasetAssertionScopeClass</span></a></em></dt>
|
||
<dd><p>Scope of the Assertion. What part of the dataset does this assertion apply to?</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionScopeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetAssertionScopeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionScopeClass.DATASET_COLUMN">
|
||
<span class="sig-name descname"><span class="pre">DATASET_COLUMN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATASET_COLUMN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionScopeClass.DATASET_ROWS">
|
||
<span class="sig-name descname"><span class="pre">DATASET_ROWS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATASET_ROWS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionScopeClass.DATASET_SCHEMA">
|
||
<span class="sig-name descname"><span class="pre">DATASET_SCHEMA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATASET_SCHEMA'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionScopeClass.DATASET_STORAGE_SIZE">
|
||
<span class="sig-name descname"><span class="pre">DATASET_STORAGE_SIZE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATASET_STORAGE_SIZE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetAssertionScopeClass.UNKNOWN">
|
||
<span class="sig-name descname"><span class="pre">UNKNOWN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNKNOWN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetDeprecationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetDeprecationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deprecated</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decommissionTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Dataset deprecation status
|
||
Deprecated! This aspect is deprecated in favor of the more-general-purpose ‘Deprecation’ aspect.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>deprecated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
<li><p><strong>note</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>decommissionTime</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>actor</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetDeprecationClass.actor">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The corpuser URN which will be credited for modifying this deprecation content.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetDeprecationClass.decommissionTime">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">decommissionTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The time user plan to decommission this dataset.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetDeprecationClass.deprecated">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deprecated</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the dataset is deprecated by owner.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetDeprecationClass.note">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">note</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Additional information about the dataset deprecation plan, such as the wiki, doc, RB.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldForeignKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetFieldForeignKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parentDataset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">currentFieldPaths</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parentField</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>For non-urn based foregin keys.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>parentDataset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>currentFieldPaths</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>parentField</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldForeignKeyClass.currentFieldPaths">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">currentFieldPaths</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of fields in hosting(current) SchemaMetadata that conform a foreign key. List can contain a single entry or multiple entries if several entries in hosting schema conform a foreign key in a single parent dataset.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldForeignKeyClass.parentDataset">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parentDataset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>dataset that stores the resource.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldForeignKeyClass.parentField">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parentField</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p><a class="reference external" href="mailto:SchemaField%40fieldPath">SchemaField<span>@</span>fieldPath</a> that uniquely identify field in parent dataset that this field references.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldMappingClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetFieldMappingClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">created</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transformation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sourceFields</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">destinationField</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Representation of mapping between fields in source dataset to the field in destination dataset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>created</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>transformation</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.TransformationTypeClass" title="datahub.metadata.schema_classes.TransformationTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransformationTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.UDFTransformerClass" title="datahub.metadata.schema_classes.UDFTransformerClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">UDFTransformerClass</span></code></a>])</p></li>
|
||
<li><p><strong>sourceFields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>destinationField</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldMappingClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who reported the field mapping and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldMappingClass.destinationField">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">destinationField</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Destination field which is derived from source fields</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldMappingClass.sourceFields">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceFields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Source fields from which the fine grained lineage is derived</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldMappingClass.transformation">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transformation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TransformationTypeClass" title="datahub.metadata.schema_classes.TransformationTypeClass"><span class="pre">TransformationTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.UDFTransformerClass" title="datahub.metadata.schema_classes.UDFTransformerClass"><span class="pre">UDFTransformerClass</span></a></em></dt>
|
||
<dd><p>Transfomration function between the fields involved</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetFieldProfileClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fieldPath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uniqueCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uniqueProportion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nullCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nullProportion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mean</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">median</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdev</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quantiles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">distinctValueFrequencies</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">histogram</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sampleValues</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Stats corresponding to fields in a dataset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>fieldPath</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>uniqueCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>uniqueProportion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>])</p></li>
|
||
<li><p><strong>nullCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>nullProportion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>])</p></li>
|
||
<li><p><strong>min</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>max</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>mean</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>median</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>stdev</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>quantiles</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.QuantileClass" title="datahub.metadata.schema_classes.QuantileClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QuantileClass</span></code></a>]])</p></li>
|
||
<li><p><strong>distinctValueFrequencies</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.ValueFrequencyClass" title="datahub.metadata.schema_classes.ValueFrequencyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueFrequencyClass</span></code></a>]])</p></li>
|
||
<li><p><strong>histogram</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.HistogramClass" title="datahub.metadata.schema_classes.HistogramClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">HistogramClass</span></code></a>])</p></li>
|
||
<li><p><strong>sampleValues</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.distinctValueFrequencies">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">distinctValueFrequencies</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.ValueFrequencyClass" title="datahub.metadata.schema_classes.ValueFrequencyClass"><span class="pre">ValueFrequencyClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.fieldPath">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldPath</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.histogram">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">histogram</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.HistogramClass" title="datahub.metadata.schema_classes.HistogramClass"><span class="pre">HistogramClass</span></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.max">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">max</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.mean">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mean</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.median">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">median</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.min">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">min</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.nullCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nullCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.nullProportion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nullProportion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.quantiles">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">quantiles</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.QuantileClass" title="datahub.metadata.schema_classes.QuantileClass"><span class="pre">QuantileClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.sampleValues">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sampleValues</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.stdev">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">stdev</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.uniqueCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uniqueCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldProfileClass.uniqueProportion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uniqueProportion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldUsageCountsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetFieldUsageCountsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fieldPath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Records field-level usage counts for a given dataset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>fieldPath</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldUsageCountsClass.count">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">count</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Number of times the field has been used.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFieldUsageCountsClass.fieldPath">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldPath</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the field.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFilterClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetFilterClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sql</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A definition of filters that should be used when
|
||
querying an external Dataset or Table.</p>
|
||
<p>Note that this models should NOT be used for working with
|
||
search / filter on DataHub Platform itself.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFilterTypeClass" title="datahub.metadata.schema_classes.DatasetFilterTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetFilterTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>sql</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFilterClass.sql">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sql</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The raw where clause string which will be used for monitoring.
|
||
Required if the type is SQL.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFilterClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFilterTypeClass" title="datahub.metadata.schema_classes.DatasetFilterTypeClass"><span class="pre">DatasetFilterTypeClass</span></a></em></dt>
|
||
<dd><p>How the partition will be represented in this model.</p>
|
||
<p>In the future, we’ll likely add support for more structured
|
||
predicates.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFilterTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetFilterTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetFilterTypeClass.SQL">
|
||
<span class="sig-name descname"><span class="pre">SQL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SQL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">origin</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Dataset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>origin</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FabricTypeClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique guid for dataset</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetKeyClass.origin">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">origin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><span class="pre">FabricTypeClass</span></a></em></dt>
|
||
<dd><p>Fabric type where dataset belongs to or where it was generated.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetKeyClass.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Data platform urn associated with the dataset</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetLineageTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetLineageTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The various types of supported dataset lineage</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetLineageTypeClass.COPY">
|
||
<span class="sig-name descname"><span class="pre">COPY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'COPY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetLineageTypeClass.TRANSFORMED">
|
||
<span class="sig-name descname"><span class="pre">TRANSFORMED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TRANSFORMED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetLineageTypeClass.VIEW">
|
||
<span class="sig-name descname"><span class="pre">VIEW</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'VIEW'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetProfileClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetProfileClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMillis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eventGranularity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partitionSpec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messageId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rowCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">columnCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldProfiles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sizeInBytes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Stats corresponding to datasets</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>timestampMillis</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>eventGranularity</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeWindowSizeClass</span></code></a>])</p></li>
|
||
<li><p><strong>partitionSpec</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionSpecClass</span></code></a>])</p></li>
|
||
<li><p><strong>messageId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>rowCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>columnCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>fieldProfiles</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFieldProfileClass" title="datahub.metadata.schema_classes.DatasetFieldProfileClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetFieldProfileClass</span></code></a>]])</p></li>
|
||
<li><p><strong>sizeInBytes</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetProfileClass.ASPECT_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ASPECT_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timeseries'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetProfileClass.columnCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">columnCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The total number of columns (or schema fields)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetProfileClass.eventGranularity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">eventGranularity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><span class="pre">TimeWindowSizeClass</span></a></em></dt>
|
||
<dd><p>Granularity of the event if applicable</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetProfileClass.fieldProfiles">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldProfiles</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFieldProfileClass" title="datahub.metadata.schema_classes.DatasetFieldProfileClass"><span class="pre">DatasetFieldProfileClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Profiles for each column (or schema field)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetProfileClass.messageId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">messageId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetProfileClass.partitionSpec">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">partitionSpec</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><span class="pre">PartitionSpecClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The optional partition specification.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetProfileClass.rowCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rowCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The total number of rows</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetProfileClass.sizeInBytes">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sizeInBytes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Storage size in bytes</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetProfileClass.timestampMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The event timestamp field as epoch at UTC in milli seconds.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualifiedName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uri</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a Dataset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>qualifiedName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>uri</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>tags</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><span class="pre">TimeStampClass</span></a></em></dt>
|
||
<dd><p>A timestamp documenting when the asset was created in the source Data Platform (not on DataHub)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetPropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the dataset</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetPropertiesClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><span class="pre">TimeStampClass</span></a></em></dt>
|
||
<dd><p>A timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetPropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the Dataset</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetPropertiesClass.qualifiedName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">qualifiedName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Fully-qualified name of the Dataset</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetPropertiesClass.tags">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>[Legacy] Unstructured tags for the dataset. Structured tags can be applied via the <cite>GlobalTags</cite> aspect.
|
||
This is now deprecated.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetPropertiesClass.uri">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>///dir/file_name. Uri should not include any environment specific properties. Some datasets might not have a standardized uri, which makes this field optional (i.e. kafka topic).</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The abstracted URI such as hdfs</p>
|
||
</dd>
|
||
<dt class="field-even">Type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>///data/tracking/PageViewEvent, file</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific dataset entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DatasetKeyClass" title="datahub.metadata.schema_classes.DatasetKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DatasetPropertiesClass" title="datahub.metadata.schema_classes.DatasetPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetPropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.EditableDatasetPropertiesClass" title="datahub.metadata.schema_classes.EditableDatasetPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableDatasetPropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DatasetDeprecationClass" title="datahub.metadata.schema_classes.DatasetDeprecationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetDeprecationClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DatasetUpstreamLineageClass" title="datahub.metadata.schema_classes.DatasetUpstreamLineageClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetUpstreamLineageClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.UpstreamLineageClass" title="datahub.metadata.schema_classes.UpstreamLineageClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpstreamLineageClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstitutionalMemoryClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.SchemaMetadataClass" title="datahub.metadata.schema_classes.SchemaMetadataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaMetadataClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.EditableSchemaMetadataClass" title="datahub.metadata.schema_classes.EditableSchemaMetadataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableSchemaMetadataClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.ViewPropertiesClass" title="datahub.metadata.schema_classes.ViewPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ViewPropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsV2Class</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetKeyClass" title="datahub.metadata.schema_classes.DatasetKeyClass"><span class="pre">DatasetKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetPropertiesClass" title="datahub.metadata.schema_classes.DatasetPropertiesClass"><span class="pre">DatasetPropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableDatasetPropertiesClass" title="datahub.metadata.schema_classes.EditableDatasetPropertiesClass"><span class="pre">EditableDatasetPropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetDeprecationClass" title="datahub.metadata.schema_classes.DatasetDeprecationClass"><span class="pre">DatasetDeprecationClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetUpstreamLineageClass" title="datahub.metadata.schema_classes.DatasetUpstreamLineageClass"><span class="pre">DatasetUpstreamLineageClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.UpstreamLineageClass" title="datahub.metadata.schema_classes.UpstreamLineageClass"><span class="pre">UpstreamLineageClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><span class="pre">InstitutionalMemoryClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaMetadataClass" title="datahub.metadata.schema_classes.SchemaMetadataClass"><span class="pre">SchemaMetadataClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableSchemaMetadataClass" title="datahub.metadata.schema_classes.EditableSchemaMetadataClass"><span class="pre">EditableSchemaMetadataClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><span class="pre">GlossaryTermsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><span class="pre">BrowsePathsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><span class="pre">DataPlatformInstanceClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ViewPropertiesClass" title="datahub.metadata.schema_classes.ViewPropertiesClass"><span class="pre">ViewPropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><span class="pre">BrowsePathsV2Class</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the dataset. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUpstreamLineageClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetUpstreamLineageClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fieldMappings</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Fine Grained upstream lineage for fields in a dataset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>fieldMappings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFieldMappingClass" title="datahub.metadata.schema_classes.DatasetFieldMappingClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetFieldMappingClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUpstreamLineageClass.fieldMappings">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldMappings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFieldMappingClass" title="datahub.metadata.schema_classes.DatasetFieldMappingClass"><span class="pre">DatasetFieldMappingClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Upstream to downstream field level lineage mappings</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUsageStatisticsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetUsageStatisticsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMillis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eventGranularity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partitionSpec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messageId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uniqueUserCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">totalSqlQueries</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">topSqlQueries</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">userCounts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldCounts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Stats corresponding to dataset’s usage.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>timestampMillis</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>eventGranularity</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeWindowSizeClass</span></code></a>])</p></li>
|
||
<li><p><strong>partitionSpec</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionSpecClass</span></code></a>])</p></li>
|
||
<li><p><strong>messageId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>uniqueUserCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>totalSqlQueries</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>topSqlQueries</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>userCounts</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DatasetUserUsageCountsClass" title="datahub.metadata.schema_classes.DatasetUserUsageCountsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetUserUsageCountsClass</span></code></a>]])</p></li>
|
||
<li><p><strong>fieldCounts</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFieldUsageCountsClass" title="datahub.metadata.schema_classes.DatasetFieldUsageCountsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetFieldUsageCountsClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUsageStatisticsClass.ASPECT_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ASPECT_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timeseries'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUsageStatisticsClass.eventGranularity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">eventGranularity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><span class="pre">TimeWindowSizeClass</span></a></em></dt>
|
||
<dd><p>Granularity of the event if applicable</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUsageStatisticsClass.fieldCounts">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldCounts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFieldUsageCountsClass" title="datahub.metadata.schema_classes.DatasetFieldUsageCountsClass"><span class="pre">DatasetFieldUsageCountsClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Field-level usage stats</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUsageStatisticsClass.messageId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">messageId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUsageStatisticsClass.partitionSpec">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">partitionSpec</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><span class="pre">PartitionSpecClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The optional partition specification.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUsageStatisticsClass.timestampMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The event timestamp field as epoch at UTC in milli seconds.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUsageStatisticsClass.topSqlQueries">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">topSqlQueries</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Frequent SQL queries; mostly makes sense for datasets in SQL databases</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUsageStatisticsClass.totalSqlQueries">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">totalSqlQueries</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Total SQL query count</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUsageStatisticsClass.uniqueUserCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uniqueUserCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Unique user count</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUsageStatisticsClass.userCounts">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">userCounts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetUserUsageCountsClass" title="datahub.metadata.schema_classes.DatasetUserUsageCountsClass"><span class="pre">DatasetUserUsageCountsClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Users within this bucket, with frequency counts</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUserUsageCountsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DatasetUserUsageCountsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">userEmail</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Records a single user’s usage counts for a given resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>userEmail</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUserUsageCountsClass.count">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">count</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Number of times the dataset has been used by the user.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUserUsageCountsClass.user">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The unique id of the user.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DatasetUserUsageCountsClass.userEmail">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">userEmail</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>If user_email is set, we attempt to resolve the user’s urn upon ingest</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DateTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DateTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Date field type.</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeploymentStatusClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DeploymentStatusClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Model endpoint statuses</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeploymentStatusClass.CREATING">
|
||
<span class="sig-name descname"><span class="pre">CREATING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CREATING'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeploymentStatusClass.DELETING">
|
||
<span class="sig-name descname"><span class="pre">DELETING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DELETING'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeploymentStatusClass.FAILED">
|
||
<span class="sig-name descname"><span class="pre">FAILED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FAILED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeploymentStatusClass.IN_SERVICE">
|
||
<span class="sig-name descname"><span class="pre">IN_SERVICE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IN_SERVICE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeploymentStatusClass.OUT_OF_SERVICE">
|
||
<span class="sig-name descname"><span class="pre">OUT_OF_SERVICE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'OUT_OF_SERVICE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeploymentStatusClass.ROLLING_BACK">
|
||
<span class="sig-name descname"><span class="pre">ROLLING_BACK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ROLLING_BACK'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeploymentStatusClass.UNKNOWN">
|
||
<span class="sig-name descname"><span class="pre">UNKNOWN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNKNOWN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeploymentStatusClass.UPDATING">
|
||
<span class="sig-name descname"><span class="pre">UPDATING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UPDATING'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeprecationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DeprecationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deprecated</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decommissionTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replacement</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Deprecation status of an entity</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>deprecated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
<li><p><strong>note</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>actor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>decommissionTime</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>replacement</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeprecationClass.actor">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The user URN which will be credited for modifying this deprecation content.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeprecationClass.decommissionTime">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">decommissionTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The time user plan to decommission this entity.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeprecationClass.deprecated">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deprecated</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the entity is deprecated.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeprecationClass.note">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">note</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Additional information about the entity deprecation plan, such as the wiki, doc, RB.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DeprecationClass.replacement">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">replacement</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DisplayPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DisplayPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">colorHex</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">icon</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties related to how the entity is displayed in the Datahub UI</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>colorHex</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>icon</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.IconPropertiesClass" title="datahub.metadata.schema_classes.IconPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IconPropertiesClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DisplayPropertiesClass.colorHex">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">colorHex</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The color associated with the entity in Hex. For example #FFFFFF.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DisplayPropertiesClass.icon">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">icon</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IconPropertiesClass" title="datahub.metadata.schema_classes.IconPropertiesClass"><span class="pre">IconPropertiesClass</span></a></em></dt>
|
||
<dd><p>The icon associated with the entity</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DocPropagationFeatureSettingsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">configVersion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">columnPropagationEnabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
<li><p><strong>config</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>configVersion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>columnPropagationEnabled</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass.columnPropagationEnabled">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">columnPropagationEnabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass.config">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The configuration for the feature, in JSON format.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass.configVersion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">configVersion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><dl class="simple">
|
||
<dt>The version of the configuration schema that has been used to serialize</dt><dd><p>the config.</p>
|
||
</dd>
|
||
</dl>
|
||
<p>If not provided, the version is assumed to be the latest version.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass.enabled">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">enabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DocumentationAssociationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DocumentationAssociationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">documentation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribution</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Properties of applied documentation including the attribution of the doc</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>documentation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>attribution</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MetadataAttributionClass" title="datahub.metadata.schema_classes.MetadataAttributionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataAttributionClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DocumentationAssociationClass.attribution">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">attribution</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MetadataAttributionClass" title="datahub.metadata.schema_classes.MetadataAttributionClass"><span class="pre">MetadataAttributionClass</span></a></em></dt>
|
||
<dd><p>Information about who, why, and how this metadata was applied</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DocumentationAssociationClass.documentation">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">documentation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of this asset</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DocumentationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DocumentationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">documentations</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Aspect used for storing all applicable documentations on assets.
|
||
This aspect supports multiple documentations from different sources.
|
||
There is an implicit assumption that there is only one documentation per</p>
|
||
<blockquote>
|
||
<div><p>source.</p>
|
||
</div></blockquote>
|
||
<dl class="simple">
|
||
<dt>For example, if there are two documentations from the same source, the</dt><dd><p>latest one will overwrite the previous one.</p>
|
||
</dd>
|
||
<dt>If there are two documentations from different sources, both will be</dt><dd><p>stored.</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Future evolution considerations:
|
||
The first entity that uses this aspect is Schema Field. We will expand this</p>
|
||
<blockquote>
|
||
<div><p>aspect to other entities eventually.</p>
|
||
</div></blockquote>
|
||
<dl class="simple">
|
||
<dt>The values of the documentation are not currently searchable. This will be</dt><dd><p>changed once this aspect develops opinion on which documentation entry is
|
||
the authoritative one.</p>
|
||
</dd>
|
||
<dt>Ensuring that there is only one documentation per source is a business</dt><dd><p>rule that is not enforced by the aspect yet. This will currently be enforced by the
|
||
application that uses this aspect. We will eventually enforce this rule in
|
||
the aspect using AspectMutators.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>documentations</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DocumentationAssociationClass" title="datahub.metadata.schema_classes.DocumentationAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DocumentationAssociationClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DocumentationClass.documentations">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">documentations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DocumentationAssociationClass" title="datahub.metadata.schema_classes.DocumentationAssociationClass"><span class="pre">DocumentationAssociationClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Documentations associated with this asset. We could be receiving docs from different sources</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DomainKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DomainKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for an Asset Domain</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DomainKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the domain. Should be separate from the name used for displaying a Domain.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DomainPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DomainPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parentDomain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a Domain</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>parentDomain</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DomainPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Created Audit stamp</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DomainPropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DomainPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the Domain</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DomainPropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the Domain</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DomainPropertiesClass.parentDomain">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parentDomain</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Parent of the domain</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Optional</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DomainsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DomainsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">domains</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Links from an Asset to its Domains</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>domains</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DomainsClass.domains">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">domains</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The Domains attached to an Asset</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DynamicFormAssignmentClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">DynamicFormAssignmentClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about how a form is assigned to entities dynamically. Provide a filter to
|
||
match a set of entities instead of explicitly applying a form to specific entities.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.FilterClass" title="datahub.metadata.schema_classes.FilterClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FilterClass</span></code></a>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.DynamicFormAssignmentClass.filter">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filter</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FilterClass" title="datahub.metadata.schema_classes.FilterClass"><span class="pre">FilterClass</span></a></em></dt>
|
||
<dd><p>The filter applied when assigning this form to entities. Entities that match this filter
|
||
will have this form applied to them. Right now this filter only supports filtering by
|
||
platform, entity type, container, and domain through the UI.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ERModelRelationshipCardinalityClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass.N_N">
|
||
<span class="sig-name descname"><span class="pre">N_N</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'N_N'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass.N_ONE">
|
||
<span class="sig-name descname"><span class="pre">N_ONE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'N_ONE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass.ONE_N">
|
||
<span class="sig-name descname"><span class="pre">ONE_N</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ONE_N'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass.ONE_ONE">
|
||
<span class="sig-name descname"><span class="pre">ONE_ONE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ONE_ONE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ERModelRelationshipKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a ERModelRelationship</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ERModelRelationshipPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">destination</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">relationshipFieldMappings</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cardinality</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a ERModelRelationship</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>destination</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>relationshipFieldMappings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.RelationshipFieldMappingClass" title="datahub.metadata.schema_classes.RelationshipFieldMappingClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RelationshipFieldMappingClass</span></code></a>])</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>cardinality</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass" title="datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ERModelRelationshipCardinalityClass</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass.cardinality">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cardinality</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass" title="datahub.metadata.schema_classes.ERModelRelationshipCardinalityClass"><span class="pre">ERModelRelationshipCardinalityClass</span></a></em></dt>
|
||
<dd><p>Cardinality of the relationship</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>A timestamp documenting when the asset was created in the source Data Platform (not on DataHub)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass.destination">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">destination</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Second dataset in the erModelRelationship (no directionality)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>A timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the ERModelRelation</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass.relationshipFieldMappings">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">relationshipFieldMappings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.RelationshipFieldMappingClass" title="datahub.metadata.schema_classes.RelationshipFieldMappingClass"><span class="pre">RelationshipFieldMappingClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>ERModelRelationFieldMapping (in future we can make it an array)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ERModelRelationshipPropertiesClass.source">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">source</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>First dataset in the erModelRelationship (no directionality)</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EdgeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EdgeClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">destinationUrn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sourceUrn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">properties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A common structure to represent all edges to entities when used inside aspects as collections
|
||
This ensures that all edges have common structure around audit-stamps and will support PATCH, time-travel automatically.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>destinationUrn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>sourceUrn</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>properties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EdgeClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who created this relationship edge and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EdgeClass.destinationUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">destinationUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the destination of this relationship edge.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EdgeClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who last modified this relationship edge and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EdgeClass.properties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">properties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A generic properties bag that allows us to store specific information on this graph edge.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EdgeClass.sourceUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the source of this relationship edge.
|
||
If not specified, assumed to be the entity that this aspect belongs to.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableChartPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableChartPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Stores editable changes made to properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>deleted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableChartPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableChartPropertiesClass.deleted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deleted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableChartPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Edited documentation of the chart</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableChartPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableContainerPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableContainerPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Editable information about an Asset Container as defined on the DataHub Platform</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableContainerPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the Asset Container as its received on the DataHub Platform</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDashboardPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableDashboardPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Stores editable changes made to properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>deleted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDashboardPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDashboardPropertiesClass.deleted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deleted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDashboardPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Edited documentation of the dashboard</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDashboardPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDataFlowPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableDataFlowPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Stores editable changes made to properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>deleted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDataFlowPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDataFlowPropertiesClass.deleted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deleted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDataFlowPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Edited documentation of the data flow</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDataFlowPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDataJobPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableDataJobPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Stores editable changes made to properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>deleted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDataJobPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDataJobPropertiesClass.deleted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deleted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDataJobPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Edited documentation of the data job</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDataJobPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDatasetPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableDatasetPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>EditableDatasetProperties stores editable changes made to dataset properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>deleted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDatasetPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDatasetPropertiesClass.deleted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deleted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDatasetPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the dataset</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDatasetPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableDatasetPropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Editable display name of the Dataset</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableERModelRelationshipPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>EditableERModelRelationProperties stores editable changes made to erModelRelationship properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>deleted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass.deleted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deleted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the erModelRelationship</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableERModelRelationshipPropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the ERModelRelation</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableMLFeaturePropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableMLFeaturePropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a MLFeature editable from the UI</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableMLFeaturePropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the MLFeature</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableMLFeatureTablePropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableMLFeatureTablePropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a MLFeatureTable editable from the ui</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableMLFeatureTablePropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the MLFeatureTable</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableMLModelGroupPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableMLModelGroupPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with an ML Model Group editable from the UI</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableMLModelGroupPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the ml model group</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableMLModelPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableMLModelPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a ML Model editable from the UI</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableMLModelPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the ml model</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableMLPrimaryKeyPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableMLPrimaryKeyPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a MLPrimaryKey editable from the UI</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableMLPrimaryKeyPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the MLPrimaryKey</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableNotebookPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableNotebookPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Stores editable changes made to properties. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines
|
||
Note: This is IN BETA version</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>deleted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableNotebookPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableNotebookPropertiesClass.deleted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deleted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableNotebookPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Edited documentation of the Notebook</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableNotebookPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableSchemaFieldInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableSchemaFieldInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fieldPath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">globalTags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">glossaryTerms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>SchemaField to describe metadata related to dataset schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>fieldPath</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>globalTags</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>])</p></li>
|
||
<li><p><strong>glossaryTerms</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermsClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableSchemaFieldInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableSchemaFieldInfoClass.fieldPath">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldPath</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>FieldPath uniquely identifying the SchemaField this metadata is associated with</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableSchemaFieldInfoClass.globalTags">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">globalTags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a></em></dt>
|
||
<dd><p>Tags associated with the field</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableSchemaFieldInfoClass.glossaryTerms">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">glossaryTerms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><span class="pre">GlossaryTermsClass</span></a></em></dt>
|
||
<dd><p>Glossary terms associated with the field</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableSchemaMetadataClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EditableSchemaMetadataClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">editableSchemaFieldInfo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>EditableSchemaMetadata stores editable changes made to schema metadata. This separates changes made from
|
||
ingestion pipelines and edits in the UI to avoid accidental overwrites of user-provided data by ingestion pipelines.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>editableSchemaFieldInfo</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.EditableSchemaFieldInfoClass" title="datahub.metadata.schema_classes.EditableSchemaFieldInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EditableSchemaFieldInfoClass</span></code></a>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>deleted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableSchemaMetadataClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableSchemaMetadataClass.deleted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deleted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableSchemaMetadataClass.editableSchemaFieldInfo">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">editableSchemaFieldInfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.EditableSchemaFieldInfoClass" title="datahub.metadata.schema_classes.EditableSchemaFieldInfoClass"><span class="pre">EditableSchemaFieldInfoClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Client provided a list of fields from document schema.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EditableSchemaMetadataClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EmailNotificationSettingsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EmailNotificationSettingsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Email Notification settings for an actor.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>email</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EmailNotificationSettingsClass.email">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">email</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional user or group email address</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EmbedClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EmbedClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">renderUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information regarding rendering an embed for an asset.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>renderUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EmbedClass.renderUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">renderUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>An embed URL to be rendered inside of an iframe.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityChangeEventClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EntityChangeEventClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entityType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entityUrn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auditStamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">modifier</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Shared fields for all entity change events.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>entityType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>entityUrn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>category</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>auditStamp</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>modifier</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>parameters</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.ParametersClass" title="datahub.metadata.schema_classes.ParametersClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParametersClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityChangeEventClass.auditStamp">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auditStamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp of the operation</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityChangeEventClass.category">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">category</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The category type (TAG, GLOSSARY_TERM, OWNERSHIP, TECHNICAL_SCHEMA, etc). This is used to determine what the rest of the schema will look like.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityChangeEventClass.entityType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entityType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The type of the entity affected. Corresponds to the entity registry, e.g. ‘dataset’, ‘chart’, ‘dashboard’, etc.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityChangeEventClass.entityUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entityUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The urn of the entity which was affected.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityChangeEventClass.modifier">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">modifier</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The urn of the entity which was affected.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityChangeEventClass.operation">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">operation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The operation type. This is used to determine what the rest of the schema will look like.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityChangeEventClass.parameters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ParametersClass" title="datahub.metadata.schema_classes.ParametersClass"><span class="pre">ParametersClass</span></a></em></dt>
|
||
<dd><p>Arbitrary key-value parameters corresponding to the event.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityChangeEventClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The version of the event type, incremented in integers.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityTypeInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EntityTypeInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">qualifiedName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">displayName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>qualifiedName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>displayName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityTypeInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>what is it for?</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>A description for the Entity Type</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityTypeInfoClass.displayName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">displayName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The display name for the Entity Type.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityTypeInfoClass.qualifiedName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">qualifiedName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The fully qualified name for the entity type, which usually consists of a namespace
|
||
plus an identifier or name, e.g. datahub.dataset</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityTypeKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EntityTypeKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EntityTypeKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for an entity type. Usually this will be a unique namespace + entity name.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EnumTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EnumTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Enum field type.</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EspressoSchemaClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EspressoSchemaClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">documentSchema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tableSchema</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Schema text of an espresso table schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>documentSchema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>tableSchema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EspressoSchemaClass.documentSchema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">documentSchema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native espresso document schema.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EspressoSchemaClass.tableSchema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tableSchema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The espresso table schema definition.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EthicalConsiderationsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EthicalConsiderationsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">humanLife</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mitigations</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">risksAndHarms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">useCases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>This section is intended to demonstrate the ethical considerations that went into MLModel development, surfacing ethical challenges and solutions to stakeholders.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>data</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>humanLife</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>mitigations</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>risksAndHarms</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>useCases</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EthicalConsiderationsClass.data">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Does the MLModel use any sensitive data (e.g., protected classes)?</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EthicalConsiderationsClass.humanLife">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">humanLife</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Is the MLModel intended to inform decisions about matters central to human life or flourishing - e.g., health or safety? Or could it be used in such a way?</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EthicalConsiderationsClass.mitigations">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mitigations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>What risk mitigation strategies were used during MLModel development?</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EthicalConsiderationsClass.risksAndHarms">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">risksAndHarms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>What risks may be present in MLModel usage? Try to identify the potential recipients, likelihood, and magnitude of harms. If these cannot be determined, note that they were considered but remain unknown.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EthicalConsiderationsClass.useCases">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">useCases</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Are there any known MLModel use cases that are especially fraught? This may connect directly to the intended use section</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EvaluationDataClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">EvaluationDataClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">evaluationData</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>All referenced datasets would ideally point to any set of documents that provide visibility into the source and composition of the dataset.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>evaluationData</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.BaseDataClass" title="datahub.metadata.schema_classes.BaseDataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseDataClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.EvaluationDataClass.evaluationData">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">evaluationData</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.BaseDataClass" title="datahub.metadata.schema_classes.BaseDataClass"><span class="pre">BaseDataClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Details on the dataset(s) used for the quantitative analyses in the MLModel</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestInputClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ExecutionRequestInputClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executorId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">requestedAt</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actorUrn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>An request to execution some remote logic or action.
|
||
TODO: Determine who is responsible for emitting execution request success or failure. Executor?</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>executorId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>source</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.ExecutionRequestSourceClass" title="datahub.metadata.schema_classes.ExecutionRequestSourceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutionRequestSourceClass</span></code></a>)</p></li>
|
||
<li><p><strong>requestedAt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>actorUrn</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestInputClass.actorUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actorUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the actor who created this execution request.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestInputClass.args">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">args</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Arguments provided to the task</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestInputClass.executorId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">executorId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>specify a specific executor to route the request to. If none is provided, a “default” executor is used.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Advanced</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestInputClass.requestedAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">requestedAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Time at which the execution request input was created</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestInputClass.source">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">source</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ExecutionRequestSourceClass" title="datahub.metadata.schema_classes.ExecutionRequestSourceClass"><span class="pre">ExecutionRequestSourceClass</span></a></em></dt>
|
||
<dd><p>Source which created the execution request</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestInputClass.task">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the task to execute, for example RUN_INGEST</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ExecutionRequestKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for an DataHub Execution Request</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the DataHub execution request.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestResultClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ExecutionRequestResultClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">report</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">structuredReport</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">startTimeMs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">durationMs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>The result of an execution request</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>report</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>structuredReport</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.StructuredExecutionReportClass" title="datahub.metadata.schema_classes.StructuredExecutionReportClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructuredExecutionReportClass</span></code></a>])</p></li>
|
||
<li><p><strong>startTimeMs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>durationMs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestResultClass.durationMs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">durationMs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Duration in milliseconds</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestResultClass.report">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">report</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The pretty-printed execution report.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestResultClass.startTimeMs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">startTimeMs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Time at which the request was created</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestResultClass.status">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The status of the execution request</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestResultClass.structuredReport">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">structuredReport</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StructuredExecutionReportClass" title="datahub.metadata.schema_classes.StructuredExecutionReportClass"><span class="pre">StructuredExecutionReportClass</span></a></em></dt>
|
||
<dd><p>A structured report if available.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestSignalClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ExecutionRequestSignalClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signal</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">createdAt</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executorId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>An signal sent to a running execution request</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>signal</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>createdAt</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>executorId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestSignalClass.createdAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">createdAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit Stamp</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestSignalClass.executorId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">executorId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>specify a specific executor to route the request to. If none is provided, a “default” executor is used.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Advanced</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestSignalClass.signal">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">signal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The signal to issue, e.g. KILL</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestSourceClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ExecutionRequestSourceClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingestionSource</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>ingestionSource</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestSourceClass.ingestionSource">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ingestionSource</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The urn of the ingestion source associated with the ingestion request. Present if type is INGESTION_SOURCE</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ExecutionRequestSourceClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The type of the execution request source, e.g. INGESTION_SOURCE</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FabricTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Fabric group type</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass.CORP">
|
||
<span class="sig-name descname"><span class="pre">CORP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CORP'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass.DEV">
|
||
<span class="sig-name descname"><span class="pre">DEV</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DEV'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass.EI">
|
||
<span class="sig-name descname"><span class="pre">EI</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EI'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass.NON_PROD">
|
||
<span class="sig-name descname"><span class="pre">NON_PROD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NON_PROD'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass.PRE">
|
||
<span class="sig-name descname"><span class="pre">PRE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PRE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass.PROD">
|
||
<span class="sig-name descname"><span class="pre">PROD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PROD'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass.QA">
|
||
<span class="sig-name descname"><span class="pre">QA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'QA'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass.RVW">
|
||
<span class="sig-name descname"><span class="pre">RVW</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'RVW'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass.SANDBOX">
|
||
<span class="sig-name descname"><span class="pre">SANDBOX</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SANDBOX'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass.STG">
|
||
<span class="sig-name descname"><span class="pre">STG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STG'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass.TEST">
|
||
<span class="sig-name descname"><span class="pre">TEST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TEST'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FabricTypeClass.UAT">
|
||
<span class="sig-name descname"><span class="pre">UAT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UAT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldAssertionInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FieldAssertionInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entity</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldValuesAssertion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldMetricAssertion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining a Field Assertion.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FieldAssertionTypeClass" title="datahub.metadata.schema_classes.FieldAssertionTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldAssertionTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>fieldValuesAssertion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FieldValuesAssertionClass" title="datahub.metadata.schema_classes.FieldValuesAssertionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldValuesAssertionClass</span></code></a>])</p></li>
|
||
<li><p><strong>fieldMetricAssertion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FieldMetricAssertionClass" title="datahub.metadata.schema_classes.FieldMetricAssertionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldMetricAssertionClass</span></code></a>])</p></li>
|
||
<li><p><strong>filter</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFilterClass" title="datahub.metadata.schema_classes.DatasetFilterClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetFilterClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldAssertionInfoClass.entity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The entity targeted by this Field check.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldAssertionInfoClass.fieldMetricAssertion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldMetricAssertion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FieldMetricAssertionClass" title="datahub.metadata.schema_classes.FieldMetricAssertionClass"><span class="pre">FieldMetricAssertionClass</span></a></em></dt>
|
||
<dd><p>The definition of an assertion that validates a common metric obtained about a field / column for a set of rows.
|
||
This type of assertion verifies that the value of a high-level metric obtained by aggregating over a column meets
|
||
expectations</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldAssertionInfoClass.fieldValuesAssertion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldValuesAssertion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FieldValuesAssertionClass" title="datahub.metadata.schema_classes.FieldValuesAssertionClass"><span class="pre">FieldValuesAssertionClass</span></a></em></dt>
|
||
<dd><p>The definition of an assertion that validates individual values of a field / column for a set of rows.
|
||
This type of assertion verifies that each column value meets a particular requirement.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldAssertionInfoClass.filter">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filter</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFilterClass" title="datahub.metadata.schema_classes.DatasetFilterClass"><span class="pre">DatasetFilterClass</span></a></em></dt>
|
||
<dd><p>A definition of the specific filters that should be applied, when performing monitoring.
|
||
If not provided, there is no filter, and the full table is under consideration.
|
||
If using DataHub Dataset Profiles as the assertion source type, the value of this field will be ignored.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldAssertionInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FieldAssertionTypeClass" title="datahub.metadata.schema_classes.FieldAssertionTypeClass"><span class="pre">FieldAssertionTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the field assertion being monitored.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldAssertionTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FieldAssertionTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldAssertionTypeClass.FIELD_METRIC">
|
||
<span class="sig-name descname"><span class="pre">FIELD_METRIC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FIELD_METRIC'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldAssertionTypeClass.FIELD_VALUES">
|
||
<span class="sig-name descname"><span class="pre">FIELD_VALUES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FIELD_VALUES'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldFormPromptAssociationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FieldFormPromptAssociationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fieldPath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Information about the status of a particular prompt for a specific schema field
|
||
on an entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>fieldPath</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>lastModified</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldFormPromptAssociationClass.fieldPath">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldPath</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The field path on a schema field.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldFormPromptAssociationClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>The last time this prompt was touched for the field on the entity (set, unset)</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricAssertionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FieldMetricAssertionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining a field metric assertion, which asserts an expectation against
|
||
a common metric derived from the set of field / column values, for example:
|
||
max, min, median, null count, null percentage, unique count, unique percentage, and more.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>field</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldSpecClass" title="datahub.metadata.schema_classes.SchemaFieldSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldSpecClass</span></code></a>)</p></li>
|
||
<li><p><strong>metric</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FieldMetricTypeClass" title="datahub.metadata.schema_classes.FieldMetricTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldMetricTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>operator</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdOperatorClass</span></code></a>])</p></li>
|
||
<li><p><strong>parameters</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdParametersClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricAssertionClass.field">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">field</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldSpecClass" title="datahub.metadata.schema_classes.SchemaFieldSpecClass"><span class="pre">SchemaFieldSpecClass</span></a></em></dt>
|
||
<dd><p>The field under evaluation</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricAssertionClass.metric">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">metric</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FieldMetricTypeClass" title="datahub.metadata.schema_classes.FieldMetricTypeClass"><span class="pre">FieldMetricTypeClass</span></a></em></dt>
|
||
<dd><p>The specific metric to assert against. This is the value that
|
||
will be obtained by applying a standard operation, such as an aggregation,
|
||
to the selected field.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricAssertionClass.operator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">operator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><span class="pre">AssertionStdOperatorClass</span></a></em></dt>
|
||
<dd><p>The predicate to evaluate against the metric for the field / column.
|
||
Depending on the operator, parameters may be required in order to successfully
|
||
evaluate the assertion against the metric value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricAssertionClass.parameters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><span class="pre">AssertionStdParametersClass</span></a></em></dt>
|
||
<dd><p>Standard parameters required for the assertion. e.g. min_value, max_value, value, columns</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FieldMetricTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>A standard metric that can be derived from the set of values
|
||
for a specific field / column of a dataset / table.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.EMPTY_COUNT">
|
||
<span class="sig-name descname"><span class="pre">EMPTY_COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EMPTY_COUNT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.EMPTY_PERCENTAGE">
|
||
<span class="sig-name descname"><span class="pre">EMPTY_PERCENTAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EMPTY_PERCENTAGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.MAX">
|
||
<span class="sig-name descname"><span class="pre">MAX</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MAX'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.MAX_LENGTH">
|
||
<span class="sig-name descname"><span class="pre">MAX_LENGTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MAX_LENGTH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.MEAN">
|
||
<span class="sig-name descname"><span class="pre">MEAN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MEAN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.MEDIAN">
|
||
<span class="sig-name descname"><span class="pre">MEDIAN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MEDIAN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.MIN">
|
||
<span class="sig-name descname"><span class="pre">MIN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MIN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.MIN_LENGTH">
|
||
<span class="sig-name descname"><span class="pre">MIN_LENGTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MIN_LENGTH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.NEGATIVE_COUNT">
|
||
<span class="sig-name descname"><span class="pre">NEGATIVE_COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NEGATIVE_COUNT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.NEGATIVE_PERCENTAGE">
|
||
<span class="sig-name descname"><span class="pre">NEGATIVE_PERCENTAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NEGATIVE_PERCENTAGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.NULL_COUNT">
|
||
<span class="sig-name descname"><span class="pre">NULL_COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NULL_COUNT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.NULL_PERCENTAGE">
|
||
<span class="sig-name descname"><span class="pre">NULL_PERCENTAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NULL_PERCENTAGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.STDDEV">
|
||
<span class="sig-name descname"><span class="pre">STDDEV</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STDDEV'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.UNIQUE_COUNT">
|
||
<span class="sig-name descname"><span class="pre">UNIQUE_COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNIQUE_COUNT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.UNIQUE_PERCENTAGE">
|
||
<span class="sig-name descname"><span class="pre">UNIQUE_PERCENTAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNIQUE_PERCENTAGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.ZERO_COUNT">
|
||
<span class="sig-name descname"><span class="pre">ZERO_COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ZERO_COUNT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldMetricTypeClass.ZERO_PERCENTAGE">
|
||
<span class="sig-name descname"><span class="pre">ZERO_PERCENTAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ZERO_PERCENTAGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldTransformClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FieldTransformClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Definition of a transform applied to the values of a column / field.
|
||
Note that the applicability of a field transform ultimately depends on the native type
|
||
of the field / column.</p>
|
||
<p>Model has single field to permit extension.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FieldTransformTypeClass" title="datahub.metadata.schema_classes.FieldTransformTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldTransformTypeClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldTransformClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FieldTransformTypeClass" title="datahub.metadata.schema_classes.FieldTransformTypeClass"><span class="pre">FieldTransformTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the field transform, e.g. the transformation
|
||
function / operator to apply.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldTransformTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FieldTransformTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldTransformTypeClass.LENGTH">
|
||
<span class="sig-name descname"><span class="pre">LENGTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LENGTH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldUsageCountsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FieldUsageCountsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fieldName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Records field-level usage counts for a given resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>fieldName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldUsageCountsClass.count">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">count</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldUsageCountsClass.fieldName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesAssertionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FieldValuesAssertionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failThreshold</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transform</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">excludeNulls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining a field values assertion, which asserts that the values for a field / column
|
||
of a dataset / table matches a set of expectations.</p>
|
||
<p>In other words, this type of assertion acts as a semantic constraint applied to fields for a specific column.</p>
|
||
<p>TODO: We should display the “failed row count” to the user if the column fails the verification rules.
|
||
TODO: Determine whether we need an “operator” that can be applied to the field.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>field</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldSpecClass" title="datahub.metadata.schema_classes.SchemaFieldSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldSpecClass</span></code></a>)</p></li>
|
||
<li><p><strong>operator</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdOperatorClass</span></code></a>])</p></li>
|
||
<li><p><strong>failThreshold</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.FieldValuesFailThresholdClass" title="datahub.metadata.schema_classes.FieldValuesFailThresholdClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldValuesFailThresholdClass</span></code></a>)</p></li>
|
||
<li><p><strong>transform</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FieldTransformClass" title="datahub.metadata.schema_classes.FieldTransformClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldTransformClass</span></code></a>])</p></li>
|
||
<li><p><strong>parameters</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdParametersClass</span></code></a>])</p></li>
|
||
<li><p><strong>excludeNulls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesAssertionClass.excludeNulls">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">excludeNulls</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether to ignore or allow nulls when running the values assertion. (i.e.
|
||
consider only non-null values) using operators OTHER than the IS_NULL operator.</p>
|
||
<p>Defaults to true, allowing null values.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesAssertionClass.failThreshold">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">failThreshold</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FieldValuesFailThresholdClass" title="datahub.metadata.schema_classes.FieldValuesFailThresholdClass"><span class="pre">FieldValuesFailThresholdClass</span></a></em></dt>
|
||
<dd><p>Additional customization about when the assertion
|
||
should be officially considered failing.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesAssertionClass.field">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">field</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldSpecClass" title="datahub.metadata.schema_classes.SchemaFieldSpecClass"><span class="pre">SchemaFieldSpecClass</span></a></em></dt>
|
||
<dd><p>The field under evaluation</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesAssertionClass.operator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">operator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><span class="pre">AssertionStdOperatorClass</span></a></em></dt>
|
||
<dd><p>The predicate to evaluate against a single value of the field.
|
||
Depending on the operator, parameters may be required in order to successfully
|
||
evaluate the assertion against the field value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesAssertionClass.parameters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><span class="pre">AssertionStdParametersClass</span></a></em></dt>
|
||
<dd><p>Standard parameters required for the assertion. e.g. min_value, max_value, value, columns</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesAssertionClass.transform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FieldTransformClass" title="datahub.metadata.schema_classes.FieldTransformClass"><span class="pre">FieldTransformClass</span></a></em></dt>
|
||
<dd><p>An optional transform to apply to field values
|
||
before evaluating the operator.</p>
|
||
<p>If none is applied, the field value will be compared as is.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesFailThresholdClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FieldValuesFailThresholdClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass" title="datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldValuesFailThresholdTypeClass</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>])</p></li>
|
||
<li><p><strong>value</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesFailThresholdClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass" title="datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass"><span class="pre">FieldValuesFailThresholdTypeClass</span></a></em></dt>
|
||
<dd><p>The type of failure threshold. Either based on the number
|
||
of column values (rows) that fail the expectations, or the percentage
|
||
of the total rows under consideration.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesFailThresholdClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>By default this is 0, meaning that ALL column values (i.e. rows) must
|
||
meet the defined expectations.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FieldValuesFailThresholdTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass.COUNT">
|
||
<span class="sig-name descname"><span class="pre">COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'COUNT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FieldValuesFailThresholdTypeClass.PERCENTAGE">
|
||
<span class="sig-name descname"><span class="pre">PERCENTAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PERCENTAGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FilterClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FilterClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">or_</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">criteria</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>The filter for finding a record or a collection of records</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>or_</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.ConjunctiveCriterionClass" title="datahub.metadata.schema_classes.ConjunctiveCriterionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConjunctiveCriterionClass</span></code></a>]])</p></li>
|
||
<li><p><strong>criteria</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.CriterionClass" title="datahub.metadata.schema_classes.CriterionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CriterionClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FilterClass.criteria">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">criteria</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.CriterionClass" title="datahub.metadata.schema_classes.CriterionClass"><span class="pre">CriterionClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Deprecated! A list of conjunctive criterion for the filter. If “or” field is provided, then this field is ignored.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FilterClass.or_">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">or_</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.ConjunctiveCriterionClass" title="datahub.metadata.schema_classes.ConjunctiveCriterionClass"><span class="pre">ConjunctiveCriterionClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A list of disjunctive criterion for the filter. (or operation to combine filters)</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FineGrainedLineageClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">upstreamType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">downstreamType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstreams</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">downstreams</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transformOperation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">confidenceScore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A fine-grained lineage from upstream fields/datasets to downstream field(s)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>upstreamType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass" title="datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FineGrainedLineageUpstreamTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>downstreamType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass" title="datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FineGrainedLineageDownstreamTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>upstreams</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>downstreams</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>transformOperation</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>confidenceScore</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>])</p></li>
|
||
<li><p><strong>query</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageClass.confidenceScore">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">confidenceScore</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em></dt>
|
||
<dd><p>The confidence in this lineage between 0 (low confidence) and 1 (high confidence)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageClass.downstreamType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">downstreamType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass" title="datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass"><span class="pre">FineGrainedLineageDownstreamTypeClass</span></a></em></dt>
|
||
<dd><p>The type of downstream field(s)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageClass.downstreams">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">downstreams</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Downstream fields in the lineage</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageClass.query">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">query</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The query that was used to generate this lineage.
|
||
Present only if the lineage was generated from a detected query.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageClass.transformOperation">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transformOperation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The transform operation applied to the upstream entities to produce the downstream field(s)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageClass.upstreamType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upstreamType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass" title="datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass"><span class="pre">FineGrainedLineageUpstreamTypeClass</span></a></em></dt>
|
||
<dd><p>The type of upstream entity</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageClass.upstreams">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upstreams</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Upstream entities in the lineage</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FineGrainedLineageDownstreamTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The type of downstream field(s) in a fine-grained lineage</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass.FIELD">
|
||
<span class="sig-name descname"><span class="pre">FIELD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FIELD'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageDownstreamTypeClass.FIELD_SET">
|
||
<span class="sig-name descname"><span class="pre">FIELD_SET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FIELD_SET'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FineGrainedLineageUpstreamTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The type of upstream entity in a fine-grained lineage</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass.DATASET">
|
||
<span class="sig-name descname"><span class="pre">DATASET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATASET'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass.FIELD_SET">
|
||
<span class="sig-name descname"><span class="pre">FIELD_SET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FIELD_SET'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FineGrainedLineageUpstreamTypeClass.NONE">
|
||
<span class="sig-name descname"><span class="pre">NONE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NONE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FixedIntervalScheduleClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FixedIntervalScheduleClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unit</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">multiple</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining a relative fixed interval SLA schedule.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>unit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.CalendarIntervalClass" title="datahub.metadata.schema_classes.CalendarIntervalClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CalendarIntervalClass</span></code></a>])</p></li>
|
||
<li><p><strong>multiple</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FixedIntervalScheduleClass.multiple">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">multiple</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>How many units. Defaults to 1.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FixedIntervalScheduleClass.unit">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unit</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CalendarIntervalClass" title="datahub.metadata.schema_classes.CalendarIntervalClass"><span class="pre">CalendarIntervalClass</span></a></em></dt>
|
||
<dd><p>Interval unit such as minute/hour/day etc.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FixedTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FixedTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Fixed field type.</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ForeignKeyConstraintClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ForeignKeyConstraintClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">foreignFields</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sourceFields</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">foreignDataset</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Description of a foreign key constraint in a schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>foreignFields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>sourceFields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>foreignDataset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ForeignKeyConstraintClass.foreignDataset">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">foreignDataset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Reference to the foreign dataset for ease of lookup</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ForeignKeyConstraintClass.foreignFields">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">foreignFields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Fields the constraint maps to on the foreign dataset</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ForeignKeyConstraintClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the constraint, likely provided from the source</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ForeignKeyConstraintClass.sourceFields">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceFields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Fields the constraint maps to on the source dataset</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ForeignKeySpecClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ForeignKeySpecClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">foreignKey</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Description of a foreign key in a schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>foreignKey</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFieldForeignKeyClass" title="datahub.metadata.schema_classes.DatasetFieldForeignKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetFieldForeignKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.UrnForeignKeyClass" title="datahub.metadata.schema_classes.UrnForeignKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">UrnForeignKeyClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ForeignKeySpecClass.foreignKey">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">foreignKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFieldForeignKeyClass" title="datahub.metadata.schema_classes.DatasetFieldForeignKeyClass"><span class="pre">DatasetFieldForeignKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.UrnForeignKeyClass" title="datahub.metadata.schema_classes.UrnForeignKeyClass"><span class="pre">UrnForeignKeyClass</span></a></em></dt>
|
||
<dd><p>Foreign key definition in metadata schema.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormActorAssignmentClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FormActorAssignmentClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">owners</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">users</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>owners</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>groups</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>users</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormActorAssignmentClass.groups">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">groups</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Specific set of groups that are targeted by this form assignment.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Optional</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormActorAssignmentClass.owners">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">owners</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the form should be assigned to the owners of assets that it is applied to.
|
||
This is the default.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormActorAssignmentClass.users">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">users</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Specific set of users that are targeted by this form assignment.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Optional</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormAssociationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FormAssociationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incompletePrompts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">completedPrompts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Properties of an applied form.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>incompletePrompts</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FormPromptAssociationClass" title="datahub.metadata.schema_classes.FormPromptAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormPromptAssociationClass</span></code></a>]])</p></li>
|
||
<li><p><strong>completedPrompts</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FormPromptAssociationClass" title="datahub.metadata.schema_classes.FormPromptAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormPromptAssociationClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormAssociationClass.completedPrompts">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">completedPrompts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.FormPromptAssociationClass" title="datahub.metadata.schema_classes.FormPromptAssociationClass"><span class="pre">FormPromptAssociationClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A list of prompts that have been completed for this form.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormAssociationClass.incompletePrompts">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">incompletePrompts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.FormPromptAssociationClass" title="datahub.metadata.schema_classes.FormPromptAssociationClass"><span class="pre">FormPromptAssociationClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A list of prompts that are not yet complete for this form.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormAssociationClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the applied form</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FormInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prompts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a form to help with filling out metadata on entities.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FormTypeClass" title="datahub.metadata.schema_classes.FormTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormTypeClass</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>])</p></li>
|
||
<li><p><strong>prompts</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FormPromptClass" title="datahub.metadata.schema_classes.FormPromptClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormPromptClass</span></code></a>]])</p></li>
|
||
<li><p><strong>actors</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FormActorAssignmentClass" title="datahub.metadata.schema_classes.FormActorAssignmentClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormActorAssignmentClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormInfoClass.actors">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actors</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FormActorAssignmentClass" title="datahub.metadata.schema_classes.FormActorAssignmentClass"><span class="pre">FormActorAssignmentClass</span></a></em></dt>
|
||
<dd><p>Who the form is assigned to, e.g. who should see the form when visiting the entity page or governance center</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the form</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the form</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormInfoClass.prompts">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">prompts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.FormPromptClass" title="datahub.metadata.schema_classes.FormPromptClass"><span class="pre">FormPromptClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of prompts to present to the user to encourage filling out metadata</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FormTypeClass" title="datahub.metadata.schema_classes.FormTypeClass"><span class="pre">FormTypeClass</span></a></em></dt>
|
||
<dd><p>The type of this form</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FormKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Form</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique id for the form.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptAssociationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FormPromptAssociationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldAssociations</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Information about the status of a particular prompt.
|
||
Note that this is where we can add additional information about individual responses:
|
||
actor, timestamp, and the response itself.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>lastModified</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>fieldAssociations</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FormPromptFieldAssociationsClass" title="datahub.metadata.schema_classes.FormPromptFieldAssociationsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormPromptFieldAssociationsClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptAssociationClass.fieldAssociations">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldAssociations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FormPromptFieldAssociationsClass" title="datahub.metadata.schema_classes.FormPromptFieldAssociationsClass"><span class="pre">FormPromptFieldAssociationsClass</span></a></em></dt>
|
||
<dd><p>Optional information about the field-level prompt associations.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptAssociationClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The id for the prompt. This must be GLOBALLY UNIQUE.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptAssociationClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>The last time this prompt was touched for the entity (set, unset)</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FormPromptClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">structuredPropertyParams</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">required</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A prompt to present to the user to encourage filling out metadata</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>title</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FormPromptTypeClass" title="datahub.metadata.schema_classes.FormPromptTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormPromptTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>structuredPropertyParams</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.StructuredPropertyParamsClass" title="datahub.metadata.schema_classes.StructuredPropertyParamsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructuredPropertyParamsClass</span></code></a>])</p></li>
|
||
<li><p><strong>required</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The description of this prompt</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The unique id for this prompt. This must be GLOBALLY unique.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptClass.required">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">required</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the prompt is required to be completed, in order for the form to be marked as complete.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptClass.structuredPropertyParams">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">structuredPropertyParams</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StructuredPropertyParamsClass" title="datahub.metadata.schema_classes.StructuredPropertyParamsClass"><span class="pre">StructuredPropertyParamsClass</span></a></em></dt>
|
||
<dd><p>An optional set of information specific to structured properties prompts.
|
||
This should be filled out if the prompt is type STRUCTURED_PROPERTY or FIELDS_STRUCTURED_PROPERTY.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptClass.title">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The title of this prompt</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FormPromptTypeClass" title="datahub.metadata.schema_classes.FormPromptTypeClass"><span class="pre">FormPromptTypeClass</span></a></em></dt>
|
||
<dd><p>The type of prompt</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptFieldAssociationsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FormPromptFieldAssociationsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">completedFieldPrompts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incompleteFieldPrompts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Information about the field-level prompt associations on a top-level prompt association.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>completedFieldPrompts</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FieldFormPromptAssociationClass" title="datahub.metadata.schema_classes.FieldFormPromptAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldFormPromptAssociationClass</span></code></a>]])</p></li>
|
||
<li><p><strong>incompleteFieldPrompts</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FieldFormPromptAssociationClass" title="datahub.metadata.schema_classes.FieldFormPromptAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldFormPromptAssociationClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptFieldAssociationsClass.completedFieldPrompts">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">completedFieldPrompts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.FieldFormPromptAssociationClass" title="datahub.metadata.schema_classes.FieldFormPromptAssociationClass"><span class="pre">FieldFormPromptAssociationClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A list of field-level prompt associations that are not yet complete for this form.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptFieldAssociationsClass.incompleteFieldPrompts">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">incompleteFieldPrompts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.FieldFormPromptAssociationClass" title="datahub.metadata.schema_classes.FieldFormPromptAssociationClass"><span class="pre">FieldFormPromptAssociationClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A list of field-level prompt associations that are complete for this form.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FormPromptTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptTypeClass.FIELDS_STRUCTURED_PROPERTY">
|
||
<span class="sig-name descname"><span class="pre">FIELDS_STRUCTURED_PROPERTY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FIELDS_STRUCTURED_PROPERTY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormPromptTypeClass.STRUCTURED_PROPERTY">
|
||
<span class="sig-name descname"><span class="pre">STRUCTURED_PROPERTY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STRUCTURED_PROPERTY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FormTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormTypeClass.COMPLETION">
|
||
<span class="sig-name descname"><span class="pre">COMPLETION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'COMPLETION'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormTypeClass.VERIFICATION">
|
||
<span class="sig-name descname"><span class="pre">VERIFICATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'VERIFICATION'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormVerificationAssociationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FormVerificationAssociationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>An association between a verification and an entity that has been granted
|
||
via completion of one or more forms of type ‘VERIFICATION’.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>form</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormVerificationAssociationClass.form">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">form</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The urn of the form that granted this verification.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormVerificationAssociationClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An audit stamp capturing who and when verification was applied for this form.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FormsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">incompleteForms</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">completedForms</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Forms that are assigned to this entity to be filled out</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>incompleteForms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FormAssociationClass" title="datahub.metadata.schema_classes.FormAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormAssociationClass</span></code></a>])</p></li>
|
||
<li><p><strong>completedForms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FormAssociationClass" title="datahub.metadata.schema_classes.FormAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormAssociationClass</span></code></a>])</p></li>
|
||
<li><p><strong>verifications</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FormVerificationAssociationClass" title="datahub.metadata.schema_classes.FormVerificationAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormVerificationAssociationClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormsClass.completedForms">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">completedForms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.FormAssociationClass" title="datahub.metadata.schema_classes.FormAssociationClass"><span class="pre">FormAssociationClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>All complete forms assigned to the entity.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormsClass.incompleteForms">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">incompleteForms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.FormAssociationClass" title="datahub.metadata.schema_classes.FormAssociationClass"><span class="pre">FormAssociationClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>All incomplete forms assigned to the entity.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FormsClass.verifications">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">verifications</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.FormVerificationAssociationClass" title="datahub.metadata.schema_classes.FormVerificationAssociationClass"><span class="pre">FormVerificationAssociationClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Verifications that have been applied to the entity via completed forms.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FreshnessAssertionInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entity</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schedule</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining a Freshness Assertion.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FreshnessAssertionTypeClass" title="datahub.metadata.schema_classes.FreshnessAssertionTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FreshnessAssertionTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>schedule</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleClass" title="datahub.metadata.schema_classes.FreshnessAssertionScheduleClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FreshnessAssertionScheduleClass</span></code></a>)</p></li>
|
||
<li><p><strong>filter</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFilterClass" title="datahub.metadata.schema_classes.DatasetFilterClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetFilterClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionInfoClass.entity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The entity targeted by this Freshness check.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionInfoClass.filter">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filter</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFilterClass" title="datahub.metadata.schema_classes.DatasetFilterClass"><span class="pre">DatasetFilterClass</span></a></em></dt>
|
||
<dd><p>A definition of the specific filters that should be applied, when performing monitoring.
|
||
If not provided, there is no filter, and the full table is under consideration.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionInfoClass.schedule">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schedule</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleClass" title="datahub.metadata.schema_classes.FreshnessAssertionScheduleClass"><span class="pre">FreshnessAssertionScheduleClass</span></a></em></dt>
|
||
<dd><p>Produce FAILURE Assertion Result if the asset is not updated on the cadence and within the time range described by the schedule.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FreshnessAssertionTypeClass" title="datahub.metadata.schema_classes.FreshnessAssertionTypeClass"><span class="pre">FreshnessAssertionTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the freshness assertion being monitored.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionScheduleClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FreshnessAssertionScheduleClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cron</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fixedInterval</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining a single Freshness schedule.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass" title="datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FreshnessAssertionScheduleTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>cron</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FreshnessCronScheduleClass" title="datahub.metadata.schema_classes.FreshnessCronScheduleClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FreshnessCronScheduleClass</span></code></a>])</p></li>
|
||
<li><p><strong>fixedInterval</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FixedIntervalScheduleClass" title="datahub.metadata.schema_classes.FixedIntervalScheduleClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FixedIntervalScheduleClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionScheduleClass.cron">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cron</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FreshnessCronScheduleClass" title="datahub.metadata.schema_classes.FreshnessCronScheduleClass"><span class="pre">FreshnessCronScheduleClass</span></a></em></dt>
|
||
<dd><p>A cron schedule. This field is required when type is CRON.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionScheduleClass.fixedInterval">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fixedInterval</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FixedIntervalScheduleClass" title="datahub.metadata.schema_classes.FixedIntervalScheduleClass"><span class="pre">FixedIntervalScheduleClass</span></a></em></dt>
|
||
<dd><p>A fixed interval schedule. This field is required when type is FIXED_INTERVAL.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionScheduleClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass" title="datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass"><span class="pre">FreshnessAssertionScheduleTypeClass</span></a></em></dt>
|
||
<dd><p>The type of a Freshness Assertion Schedule.</p>
|
||
<p>Once we support data-time-relative schedules (e.g. schedules relative to time partitions),
|
||
we will add those schedule types here.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FreshnessAssertionScheduleTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass.CRON">
|
||
<span class="sig-name descname"><span class="pre">CRON</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CRON'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass.FIXED_INTERVAL">
|
||
<span class="sig-name descname"><span class="pre">FIXED_INTERVAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FIXED_INTERVAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionScheduleTypeClass.SINCE_THE_LAST_CHECK">
|
||
<span class="sig-name descname"><span class="pre">SINCE_THE_LAST_CHECK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SINCE_THE_LAST_CHECK'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FreshnessAssertionTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionTypeClass.DATASET_CHANGE">
|
||
<span class="sig-name descname"><span class="pre">DATASET_CHANGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATASET_CHANGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessAssertionTypeClass.DATA_JOB_RUN">
|
||
<span class="sig-name descname"><span class="pre">DATA_JOB_RUN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATA_JOB_RUN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessContractClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FreshnessContractClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">assertion</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A contract pertaining to the operational SLAs of a physical data asset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>assertion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessContractClass.assertion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">assertion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The assertion representing the SLA contract.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessCronScheduleClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">FreshnessCronScheduleClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cron</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timezone</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">windowStartOffsetMs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining a CRON-formatted schedule used for defining a freshness assertion.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cron</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>timezone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>windowStartOffsetMs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessCronScheduleClass.cron">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cron</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A cron-formatted execution interval, as a cron string, e.g. 1 * * * *</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessCronScheduleClass.timezone">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timezone</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Timezone in which the cron interval applies, e.g. America/Los Angeles</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.FreshnessCronScheduleClass.windowStartOffsetMs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">windowStartOffsetMs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>An optional offset in milliseconds to SUBTRACT from the timestamp generated by the cron schedule
|
||
to generate the lower bounds of the “freshness window”, or the window of time in which an event must have occurred in order for the Freshness check
|
||
to be considering passing.</p>
|
||
<p>If left empty, the start of the SLA window will be the _end_ of the previously evaluated Freshness window.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GenericAspectClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GenericAspectClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contentType</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Generic record structure for serializing an Aspect</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code>)</p></li>
|
||
<li><p><strong>contentType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GenericAspectClass.contentType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">contentType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The content type, which represents the fashion in which the aspect was serialized.
|
||
The only type currently supported is application/json.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GenericAspectClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bytes</span></em></dt>
|
||
<dd><p>The value of the aspect, serialized as bytes.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GenericPayloadClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GenericPayloadClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contentType</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Generic payload record structure for serializing a Platform Event.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code>)</p></li>
|
||
<li><p><strong>contentType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GenericPayloadClass.contentType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">contentType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The content type, which represents the fashion in which the event was serialized.
|
||
The only type currently supported is application/json.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GenericPayloadClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bytes</span></em></dt>
|
||
<dd><p>The value of the event, serialized as bytes.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlobalSettingsInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlobalSettingsInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sso</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">views</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">docPropagation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>DataHub Global platform settings. Careful - these should not be modified by the outside world!</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>sso</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SsoSettingsClass" title="datahub.metadata.schema_classes.SsoSettingsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SsoSettingsClass</span></code></a>])</p></li>
|
||
<li><p><strong>views</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GlobalViewsSettingsClass" title="datahub.metadata.schema_classes.GlobalViewsSettingsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalViewsSettingsClass</span></code></a>])</p></li>
|
||
<li><p><strong>docPropagation</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass" title="datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DocPropagationFeatureSettingsClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlobalSettingsInfoClass.docPropagation">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">docPropagation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass" title="datahub.metadata.schema_classes.DocPropagationFeatureSettingsClass"><span class="pre">DocPropagationFeatureSettingsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>Settings related to the documentation propagation feature</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlobalSettingsInfoClass.sso">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sso</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SsoSettingsClass" title="datahub.metadata.schema_classes.SsoSettingsClass"><span class="pre">SsoSettingsClass</span></a></em></dt>
|
||
<dd><p>SSO integrations between DataHub and identity providers</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlobalSettingsInfoClass.views">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">views</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalViewsSettingsClass" title="datahub.metadata.schema_classes.GlobalViewsSettingsClass"><span class="pre">GlobalViewsSettingsClass</span></a></em></dt>
|
||
<dd><p>Settings related to the Views Feature</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlobalSettingsKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlobalSettingsKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Global Settings</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlobalSettingsKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>li:globalSettings:0</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Id for the settings. There should be only 1 global settings urn</p>
|
||
</dd>
|
||
<dt class="field-even">Type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>urn</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlobalTagsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlobalTagsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tags</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Tag aspect used for applying tags to an entity</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TagAssociationClass" title="datahub.metadata.schema_classes.TagAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagAssociationClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlobalTagsClass.tags">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.TagAssociationClass" title="datahub.metadata.schema_classes.TagAssociationClass"><span class="pre">TagAssociationClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Tags associated with a given entity</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlobalViewsSettingsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlobalViewsSettingsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">defaultView</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Settings for DataHub Views feature.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>defaultView</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlobalViewsSettingsClass.defaultView">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">defaultView</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The default View for the instance, or organization.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryNodeInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlossaryNodeInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">definition</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parentNode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a GlossaryNode</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>definition</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>parentNode</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryNodeInfoClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryNodeInfoClass.definition">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Definition of business node</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryNodeInfoClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional id for the GlossaryNode</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryNodeInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the node</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryNodeInfoClass.parentNode">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parentNode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Parent node of the glossary term</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryNodeKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlossaryNodeKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a GlossaryNode</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryNodeKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryNodeSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlossaryNodeSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific GlossaryNode entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryNodeKeyClass" title="datahub.metadata.schema_classes.GlossaryNodeKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryNodeKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryNodeInfoClass" title="datahub.metadata.schema_classes.GlossaryNodeInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryNodeInfoClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryNodeSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryNodeKeyClass" title="datahub.metadata.schema_classes.GlossaryNodeKeyClass"><span class="pre">GlossaryNodeKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryNodeInfoClass" title="datahub.metadata.schema_classes.GlossaryNodeInfoClass"><span class="pre">GlossaryNodeInfoClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the GlossaryNode. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryNodeSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryRelatedTermsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlossaryRelatedTermsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">isRelatedTerms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hasRelatedTerms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">relatedTerms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Has A / Is A lineage information about a glossary Term reporting the lineage</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>isRelatedTerms</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>hasRelatedTerms</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>values</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>relatedTerms</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryRelatedTermsClass.hasRelatedTerms">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hasRelatedTerms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The relationship Has A with glossary term</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryRelatedTermsClass.isRelatedTerms">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isRelatedTerms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The relationship Is A with glossary term</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryRelatedTermsClass.relatedTerms">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">relatedTerms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The relationship isRelatedTo with glossary term</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryRelatedTermsClass.values">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">values</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The relationship Has Value with glossary term.
|
||
These are fixed value a term has. For example a ColorEnum where RED, GREEN and YELLOW are fixed values.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermAssociationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlossaryTermAssociationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribution</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Properties of an applied glossary term.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>actor</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>context</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>attribution</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MetadataAttributionClass" title="datahub.metadata.schema_classes.MetadataAttributionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataAttributionClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermAssociationClass.actor">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The user URN which will be credited for adding associating this term to the entity</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermAssociationClass.attribution">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">attribution</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MetadataAttributionClass" title="datahub.metadata.schema_classes.MetadataAttributionClass"><span class="pre">MetadataAttributionClass</span></a></em></dt>
|
||
<dd><p>Information about who, why, and how this metadata was applied</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermAssociationClass.context">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">context</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Additional context about the association</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermAssociationClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the applied glossary term</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlossaryTermInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">definition</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">termSource</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parentNode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sourceRef</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sourceUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rawSchema</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a GlossaryTerm</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>definition</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>termSource</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>parentNode</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>sourceRef</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>sourceUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>rawSchema</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermInfoClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermInfoClass.definition">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Definition of business term.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermInfoClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional id for the term</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the term</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermInfoClass.parentNode">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parentNode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Parent node of the glossary term</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermInfoClass.rawSchema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rawSchema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Schema definition of the glossary term</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermInfoClass.sourceRef">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceRef</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>External Reference to the business-term</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermInfoClass.sourceUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>//spec.edmcouncil.org/fibo/ontology/FBC/FinancialInstruments/FinancialInstruments/CashInstrument.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The abstracted URL such as https</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermInfoClass.termSource">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">termSource</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Source of the Business Term (INTERNAL or EXTERNAL) with default value as INTERNAL</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlossaryTermKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a GlossaryTerm</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The term name, which serves as a unique id</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlossaryTermSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific GlossaryTerm entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermKeyClass" title="datahub.metadata.schema_classes.GlossaryTermKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermInfoClass" title="datahub.metadata.schema_classes.GlossaryTermInfoClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermInfoClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryRelatedTermsClass" title="datahub.metadata.schema_classes.GlossaryRelatedTermsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryRelatedTermsClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermKeyClass" title="datahub.metadata.schema_classes.GlossaryTermKeyClass"><span class="pre">GlossaryTermKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermInfoClass" title="datahub.metadata.schema_classes.GlossaryTermInfoClass"><span class="pre">GlossaryTermInfoClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><span class="pre">BrowsePathsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryRelatedTermsClass" title="datahub.metadata.schema_classes.GlossaryRelatedTermsClass"><span class="pre">GlossaryRelatedTermsClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the GlossaryTerm. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GlossaryTermsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">terms</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auditStamp</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Related business terms information</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>terms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermAssociationClass" title="datahub.metadata.schema_classes.GlossaryTermAssociationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermAssociationClass</span></code></a>])</p></li>
|
||
<li><p><strong>auditStamp</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermsClass.auditStamp">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auditStamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who reported the related business term</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GlossaryTermsClass.terms">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">terms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermAssociationClass" title="datahub.metadata.schema_classes.GlossaryTermAssociationClass"><span class="pre">GlossaryTermAssociationClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The related business terms</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GroupMembershipClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">GroupMembershipClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">groups</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Carries information about the CorpGroups a user is in.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.GroupMembershipClass.groups">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">groups</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.HistogramClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">HistogramClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">boundaries</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">heights</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>boundaries</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>heights</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.HistogramClass.boundaries">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">boundaries</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.HistogramClass.heights">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">heights</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IcebergCatalogInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IcebergCatalogInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metadataPointer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">view</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Iceberg Catalog metadata associated with an Iceberg table/view</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>metadataPointer</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>view</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IcebergCatalogInfoClass.metadataPointer">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">metadataPointer</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>When Datahub is the REST Catalog for an Iceberg Table, stores the current metadata pointer.
|
||
If the Iceberg table is managed by an external catalog, the metadata pointer is not set.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IcebergCatalogInfoClass.view">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">view</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IcebergWarehouseInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IcebergWarehouseInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataRoot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clientId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clientSecret</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tempCredentialExpirationSeconds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>An Iceberg warehouse location and credentails whose read/writes are governed by datahub catalog.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dataRoot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>clientId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>clientSecret</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>env</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FabricTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>role</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>tempCredentialExpirationSeconds</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IcebergWarehouseInfoClass.clientId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clientId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>clientId to be used to authenticate with storage hosting this warehouse</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IcebergWarehouseInfoClass.clientSecret">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clientSecret</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>client secret to authenticate with storage hosting this warehouse</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IcebergWarehouseInfoClass.dataRoot">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dataRoot</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Path of the root for the backing store of the tables in the warehouse.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IcebergWarehouseInfoClass.env">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">env</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><span class="pre">FabricTypeClass</span></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IcebergWarehouseInfoClass.region">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">region</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>region where the warehouse is located.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IcebergWarehouseInfoClass.role">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">role</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IcebergWarehouseInfoClass.tempCredentialExpirationSeconds">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tempCredentialExpirationSeconds</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IconLibraryClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IconLibraryClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Enum of possible icon sources</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IconLibraryClass.MATERIAL">
|
||
<span class="sig-name descname"><span class="pre">MATERIAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MATERIAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IconPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IconPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iconLibrary</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Properties describing an icon associated with an entity</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>iconLibrary</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.IconLibraryClass" title="datahub.metadata.schema_classes.IconLibraryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IconLibraryClass</span></code></a>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>style</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IconPropertiesClass.iconLibrary">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">iconLibrary</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IconLibraryClass" title="datahub.metadata.schema_classes.IconLibraryClass"><span class="pre">IconLibraryClass</span></a></em></dt>
|
||
<dd><p>e.g. Antd, Material, etc</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The source of the icon</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IconPropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the icon</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IconPropertiesClass.style">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">style</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Any modifier for the icon, this will be library-specific, e.g. filled/outlined, etc</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentAssigneeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncidentAssigneeClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">actor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">assignedAt</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>The incident assignee type.
|
||
This is in a record so that we can add additional fields if we need to later (e.g.
|
||
the type of the assignee.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>actor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>assignedAt</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentAssigneeClass.actor">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The user or group assigned to the incident.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentAssigneeClass.assignedAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">assignedAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>The time & actor responsible for assiging the assignee.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncidentInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entities</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">assignees</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">startedAt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about an incident raised on an asset.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.IncidentTypeClass" title="datahub.metadata.schema_classes.IncidentTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>entities</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.IncidentStatusClass" title="datahub.metadata.schema_classes.IncidentStatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentStatusClass</span></code></a>)</p></li>
|
||
<li><p><strong>created</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>customType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>title</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>priority</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>assignees</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.IncidentAssigneeClass" title="datahub.metadata.schema_classes.IncidentAssigneeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentAssigneeClass</span></code></a>]])</p></li>
|
||
<li><p><strong>source</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.IncidentSourceClass" title="datahub.metadata.schema_classes.IncidentSourceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentSourceClass</span></code></a>])</p></li>
|
||
<li><p><strong>startedAt</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentInfoClass.assignees">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">assignees</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentAssigneeClass" title="datahub.metadata.schema_classes.IncidentAssigneeClass"><span class="pre">IncidentAssigneeClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The parties assigned with resolving the incident</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentInfoClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>The time at which the request was initially created</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentInfoClass.customType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>An optional custom incident type. Present only if type is ‘CUSTOM’.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional description associated with the incident</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentInfoClass.entities">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entities</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A reference to the entity associated with the incident.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentInfoClass.priority">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">priority</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>A numeric severity or priority for the incident. On the UI we will translate this into something easy to understand.
|
||
Currently supported: 0 - CRITICAL, 1 - HIGH, 2 - MED, 3 - LOW
|
||
(We probably should have modeled as an enum)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentInfoClass.source">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">source</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentSourceClass" title="datahub.metadata.schema_classes.IncidentSourceClass"><span class="pre">IncidentSourceClass</span></a></em></dt>
|
||
<dd><p>The source of an incident, i.e. how it was generated.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentInfoClass.startedAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">startedAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The time at which the incident actually started (may be before the date it was raised).</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentInfoClass.status">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentStatusClass" title="datahub.metadata.schema_classes.IncidentStatusClass"><span class="pre">IncidentStatusClass</span></a></em></dt>
|
||
<dd><p>The current status of an incident, i.e. active or inactive.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentInfoClass.title">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional title associated with the incident</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentTypeClass" title="datahub.metadata.schema_classes.IncidentTypeClass"><span class="pre">IncidentTypeClass</span></a></em></dt>
|
||
<dd><p>The type of incident</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncidentKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for an asset Incident</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the incident. Generated on the server side at incident creation time.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentSourceClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncidentSourceClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sourceUrn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about the source of an incident raised on an asset.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.IncidentSourceTypeClass" title="datahub.metadata.schema_classes.IncidentSourceTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentSourceTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>sourceUrn</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentSourceClass.sourceUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Reference to an URN related to the source of an incident.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentSourceClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentSourceTypeClass" title="datahub.metadata.schema_classes.IncidentSourceTypeClass"><span class="pre">IncidentSourceTypeClass</span></a></em></dt>
|
||
<dd><p>Message associated with the incident</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentSourceTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncidentSourceTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentSourceTypeClass.ASSERTION_FAILURE">
|
||
<span class="sig-name descname"><span class="pre">ASSERTION_FAILURE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ASSERTION_FAILURE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentSourceTypeClass.MANUAL">
|
||
<span class="sig-name descname"><span class="pre">MANUAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MANUAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStageClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncidentStageClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStageClass.FIXED">
|
||
<span class="sig-name descname"><span class="pre">FIXED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FIXED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStageClass.INVESTIGATION">
|
||
<span class="sig-name descname"><span class="pre">INVESTIGATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'INVESTIGATION'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStageClass.NO_ACTION_REQUIRED">
|
||
<span class="sig-name descname"><span class="pre">NO_ACTION_REQUIRED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NO_ACTION_REQUIRED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStageClass.TRIAGE">
|
||
<span class="sig-name descname"><span class="pre">TRIAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TRIAGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStageClass.WORK_IN_PROGRESS">
|
||
<span class="sig-name descname"><span class="pre">WORK_IN_PROGRESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'WORK_IN_PROGRESS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStateClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncidentStateClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStateClass.ACTIVE">
|
||
<span class="sig-name descname"><span class="pre">ACTIVE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ACTIVE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStateClass.RESOLVED">
|
||
<span class="sig-name descname"><span class="pre">RESOLVED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'RESOLVED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStatusClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncidentStatusClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastUpdated</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Information about an incident raised on an asset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>state</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.IncidentStateClass" title="datahub.metadata.schema_classes.IncidentStateClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentStateClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastUpdated</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>stage</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.IncidentStageClass" title="datahub.metadata.schema_classes.IncidentStageClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentStageClass</span></code></a>])</p></li>
|
||
<li><p><strong>message</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStatusClass.lastUpdated">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastUpdated</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>The time at which the request was initially created</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStatusClass.message">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">message</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional message associated with the incident</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStatusClass.stage">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">stage</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentStageClass" title="datahub.metadata.schema_classes.IncidentStageClass"><span class="pre">IncidentStageClass</span></a></em></dt>
|
||
<dd><p>The lifecycle stage for the incident - Null means no stage was assigned yet.
|
||
In the future, we may add CUSTOM here with a customStage string field for user-defined stages.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentStatusClass.state">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">state</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentStateClass" title="datahub.metadata.schema_classes.IncidentStateClass"><span class="pre">IncidentStateClass</span></a></em></dt>
|
||
<dd><p>The top-level state of the incident, whether it’s active or resolved.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentSummaryDetailsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncidentSummaryDetailsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">createdAt</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolvedAt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Summary statistics about incidents on an entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>createdAt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>resolvedAt</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>priority</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentSummaryDetailsClass.createdAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">createdAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The time at which the incident was raised in milliseconds since epoch.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentSummaryDetailsClass.priority">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">priority</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The priority of the incident</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentSummaryDetailsClass.resolvedAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">resolvedAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The time at which the incident was marked as resolved in milliseconds since epoch. Null if the incident is still active.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentSummaryDetailsClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The type of an incident</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentSummaryDetailsClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The urn of the incident</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncidentTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>A type of asset incident</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentTypeClass.CUSTOM">
|
||
<span class="sig-name descname"><span class="pre">CUSTOM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CUSTOM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentTypeClass.DATA_SCHEMA">
|
||
<span class="sig-name descname"><span class="pre">DATA_SCHEMA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATA_SCHEMA'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentTypeClass.FIELD">
|
||
<span class="sig-name descname"><span class="pre">FIELD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FIELD'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentTypeClass.FRESHNESS">
|
||
<span class="sig-name descname"><span class="pre">FRESHNESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FRESHNESS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentTypeClass.OPERATIONAL">
|
||
<span class="sig-name descname"><span class="pre">OPERATIONAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'OPERATIONAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentTypeClass.SQL">
|
||
<span class="sig-name descname"><span class="pre">SQL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SQL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentTypeClass.VOLUME">
|
||
<span class="sig-name descname"><span class="pre">VOLUME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'VOLUME'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentsSummaryClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncidentsSummaryClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resolvedIncidents</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">activeIncidents</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolvedIncidentDetails</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">activeIncidentDetails</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Summary related incidents on an entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>resolvedIncidents</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>activeIncidents</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>resolvedIncidentDetails</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.IncidentSummaryDetailsClass" title="datahub.metadata.schema_classes.IncidentSummaryDetailsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentSummaryDetailsClass</span></code></a>]])</p></li>
|
||
<li><p><strong>activeIncidentDetails</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.IncidentSummaryDetailsClass" title="datahub.metadata.schema_classes.IncidentSummaryDetailsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncidentSummaryDetailsClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentsSummaryClass.activeIncidentDetails">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">activeIncidentDetails</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentSummaryDetailsClass" title="datahub.metadata.schema_classes.IncidentSummaryDetailsClass"><span class="pre">IncidentSummaryDetailsClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Summary details about the set of active incidents</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentsSummaryClass.activeIncidents">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">activeIncidents</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Active incidents for an asset
|
||
Deprecated! Use the richer activeIncidentsDetails instead.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentsSummaryClass.resolvedIncidentDetails">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">resolvedIncidentDetails</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.IncidentSummaryDetailsClass" title="datahub.metadata.schema_classes.IncidentSummaryDetailsClass"><span class="pre">IncidentSummaryDetailsClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Summary details about the set of resolved incidents</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncidentsSummaryClass.resolvedIncidents">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">resolvedIncidents</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Resolved incidents for an asset
|
||
Deprecated! Use the richer resolvedIncidentsDetails instead.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncrementingSegmentFieldTransformerClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nativeType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>The definition of the transformer function that should be applied to a given field / column value in a dataset
|
||
in order to determine the segment or bucket that it belongs to, which in turn is used to evaluate
|
||
volume assertions.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass" title="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncrementingSegmentFieldTransformerTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>nativeType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass.nativeType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nativeType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The ‘native’ transformer type, useful as a back door if a custom operator is required.
|
||
This field is required if the type is NATIVE.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass" title="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass"><span class="pre">IncrementingSegmentFieldTransformerTypeClass</span></a></em></dt>
|
||
<dd><p>A ‘standard’ transformer type. Note that not all source systems will support all operators.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncrementingSegmentFieldTransformerTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass.CEILING">
|
||
<span class="sig-name descname"><span class="pre">CEILING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CEILING'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass.FLOOR">
|
||
<span class="sig-name descname"><span class="pre">FLOOR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FLOOR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass.NATIVE">
|
||
<span class="sig-name descname"><span class="pre">NATIVE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NATIVE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass.TIMESTAMP_MS_TO_DATE">
|
||
<span class="sig-name descname"><span class="pre">TIMESTAMP_MS_TO_DATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TIMESTAMP_MS_TO_DATE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass.TIMESTAMP_MS_TO_HOUR">
|
||
<span class="sig-name descname"><span class="pre">TIMESTAMP_MS_TO_HOUR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TIMESTAMP_MS_TO_HOUR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass.TIMESTAMP_MS_TO_MINUTE">
|
||
<span class="sig-name descname"><span class="pre">TIMESTAMP_MS_TO_MINUTE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TIMESTAMP_MS_TO_MINUTE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass.TIMESTAMP_MS_TO_MONTH">
|
||
<span class="sig-name descname"><span class="pre">TIMESTAMP_MS_TO_MONTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TIMESTAMP_MS_TO_MONTH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerTypeClass.TIMESTAMP_MS_TO_YEAR">
|
||
<span class="sig-name descname"><span class="pre">TIMESTAMP_MS_TO_YEAR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TIMESTAMP_MS_TO_YEAR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncrementingSegmentRowCountChangeClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">segment</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining an INCREMENTING_SEGMENT_ROW_COUNT_CHANGE volume assertion.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>segment</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.IncrementingSegmentSpecClass" title="datahub.metadata.schema_classes.IncrementingSegmentSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncrementingSegmentSpecClass</span></code></a>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass" title="datahub.metadata.schema_classes.AssertionValueChangeTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionValueChangeTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>operator</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdOperatorClass</span></code></a>])</p></li>
|
||
<li><p><strong>parameters</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdParametersClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass.operator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">operator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><span class="pre">AssertionStdOperatorClass</span></a></em></dt>
|
||
<dd><p>The operator you’d like to apply to the row count value</p>
|
||
<p>Note that only numeric operators are valid inputs:
|
||
GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO,
|
||
BETWEEN.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass.parameters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><span class="pre">AssertionStdParametersClass</span></a></em></dt>
|
||
<dd><p>The parameters you’d like to provide as input to the operator.</p>
|
||
<p>Note that only numeric parameter types are valid inputs: NUMBER.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass.segment">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">segment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncrementingSegmentSpecClass" title="datahub.metadata.schema_classes.IncrementingSegmentSpecClass"><span class="pre">IncrementingSegmentSpecClass</span></a></em></dt>
|
||
<dd><p>A specification of how the ‘segment’ can be derived using a column and an optional transformer function.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass" title="datahub.metadata.schema_classes.AssertionValueChangeTypeClass"><span class="pre">AssertionValueChangeTypeClass</span></a></em></dt>
|
||
<dd><p>a fixed absolute value or a relative percentage.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The type of the value used to evaluate the assertion</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncrementingSegmentRowCountTotalClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">segment</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining an INCREMENTING_SEGMENT_ROW_COUNT_TOTAL volume assertion.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>segment</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.IncrementingSegmentSpecClass" title="datahub.metadata.schema_classes.IncrementingSegmentSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncrementingSegmentSpecClass</span></code></a>)</p></li>
|
||
<li><p><strong>operator</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdOperatorClass</span></code></a>])</p></li>
|
||
<li><p><strong>parameters</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdParametersClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass.operator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">operator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><span class="pre">AssertionStdOperatorClass</span></a></em></dt>
|
||
<dd><p>The operator you’d like to apply.</p>
|
||
<p>Note that only numeric operators are valid inputs:
|
||
GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO,
|
||
BETWEEN.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass.parameters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><span class="pre">AssertionStdParametersClass</span></a></em></dt>
|
||
<dd><p>The parameters you’d like to provide as input to the operator.</p>
|
||
<p>Note that only numeric parameter types are valid inputs: NUMBER.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass.segment">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">segment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncrementingSegmentSpecClass" title="datahub.metadata.schema_classes.IncrementingSegmentSpecClass"><span class="pre">IncrementingSegmentSpecClass</span></a></em></dt>
|
||
<dd><p>A specification of how the ‘segment’ can be derived using a column and an optional transformer function.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentSpecClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IncrementingSegmentSpecClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transformer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Core attributes required to identify an incrementing segment in a table. This type is mainly useful
|
||
for tables that constantly increase with new rows being added on a particular cadence (e.g. fact or event tables)</p>
|
||
<p>An incrementing segment represents a logical chunk of data which is INSERTED
|
||
into a dataset on a regular interval, along with the presence of a constantly-incrementing column
|
||
value such as an event time, date partition, or last modified column.</p>
|
||
<p>An incrementing segment is principally identified by 2 key attributes combined:</p>
|
||
<blockquote>
|
||
<div><ol class="arabic simple">
|
||
<li><p>A field or column that represents the incrementing value. New rows that are inserted will be identified using this column.
|
||
Note that the value of this column may not by itself represent the “bucket” or the “segment” in which the row falls.</p></li>
|
||
<li><p>[Optional] An transformer function that may be applied to the selected column value in order
|
||
to obtain the final “segment identifier” or “bucket identifier”. Rows that have the same value after applying the transformation
|
||
will be grouped into the same segment, using which the final value (e.g. row count) will be determined.</p></li>
|
||
</ol>
|
||
</div></blockquote>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>field</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldSpecClass" title="datahub.metadata.schema_classes.SchemaFieldSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldSpecClass</span></code></a>)</p></li>
|
||
<li><p><strong>transformer</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass" title="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncrementingSegmentFieldTransformerClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentSpecClass.field">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">field</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldSpecClass" title="datahub.metadata.schema_classes.SchemaFieldSpecClass"><span class="pre">SchemaFieldSpecClass</span></a></em></dt>
|
||
<dd><p>The field to use to generate segments. It must be constantly incrementing as new rows are inserted.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IncrementingSegmentSpecClass.transformer">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transformer</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass" title="datahub.metadata.schema_classes.IncrementingSegmentFieldTransformerClass"><span class="pre">IncrementingSegmentFieldTransformerClass</span></a></em></dt>
|
||
<dd><p>Optional transformer function to apply to the field in order to obtain the final segment or bucket identifier.
|
||
If not provided, then no operator will be applied to the field. (identity function)</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IngestionCheckpointStateClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IngestionCheckpointStateClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">formatVersion</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serde</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>The checkpoint state object of a datahub ingestion run for a given job.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>formatVersion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>serde</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>payload</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IngestionCheckpointStateClass.formatVersion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">formatVersion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The version of the state format.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IngestionCheckpointStateClass.payload">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">payload</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bytes</span></em></dt>
|
||
<dd><p>Opaque blob of the state representation.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IngestionCheckpointStateClass.serde">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">serde</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The serialization/deserialization protocol.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InputFieldClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">InputFieldClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">schemaFieldUrn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schemaField</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Information about a field a chart or dashboard references</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>schemaFieldUrn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>schemaField</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldClass" title="datahub.metadata.schema_classes.SchemaFieldClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InputFieldClass.schemaField">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schemaField</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldClass" title="datahub.metadata.schema_classes.SchemaFieldClass"><span class="pre">SchemaFieldClass</span></a></em></dt>
|
||
<dd><p>Copied version of the referenced schema field object for indexing purposes</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InputFieldClass.schemaFieldUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schemaFieldUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the schema being referenced for lineage purposes</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InputFieldsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">InputFieldsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fields</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about the fields a chart or dashboard references</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.InputFieldClass" title="datahub.metadata.schema_classes.InputFieldClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InputFieldClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InputFieldsClass.fields">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.InputFieldClass" title="datahub.metadata.schema_classes.InputFieldClass"><span class="pre">InputFieldClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of fields being referenced</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InstitutionalMemoryClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">InstitutionalMemoryClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">elements</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Institutional memory of an entity. This is a way to link to relevant documentation and provide description of the documentation. Institutional or tribal knowledge is very important for users to leverage the entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>elements</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass" title="datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstitutionalMemoryMetadataClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InstitutionalMemoryClass.elements">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">elements</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass" title="datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass"><span class="pre">InstitutionalMemoryMetadataClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of records that represent institutional memory of an entity. Each record consists of a link, description, creator and timestamps associated with that record.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">InstitutionalMemoryMetadataClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">createStamp</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Metadata corresponding to a record of institutional memory.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>createStamp</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass.createStamp">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">createStamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp associated with creation of this record</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the link.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InstitutionalMemoryMetadataClass.url">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Link to an engineering design document or a wiki page.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IntendedUseClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IntendedUseClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">primaryUses</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">primaryUsers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outOfScopeUses</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Intended Use for the ML Model</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>primaryUses</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>primaryUsers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.IntendedUserTypeClass" title="datahub.metadata.schema_classes.IntendedUserTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntendedUserTypeClass</span></code></a>]]])</p></li>
|
||
<li><p><strong>outOfScopeUses</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IntendedUseClass.outOfScopeUses">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">outOfScopeUses</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Highlight technology that the MLModel might easily be confused with, or related contexts that users could try to apply the MLModel to.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IntendedUseClass.primaryUsers">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">primaryUsers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IntendedUserTypeClass" title="datahub.metadata.schema_classes.IntendedUserTypeClass"><span class="pre">IntendedUserTypeClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Primary Intended Users - For example, was the MLModel developed for entertainment purposes, for hobbyists, or enterprise solutions?</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IntendedUseClass.primaryUses">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">primaryUses</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Primary Use cases for the MLModel.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IntendedUserTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">IntendedUserTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IntendedUserTypeClass.ENTERPRISE">
|
||
<span class="sig-name descname"><span class="pre">ENTERPRISE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ENTERPRISE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IntendedUserTypeClass.ENTERTAINMENT">
|
||
<span class="sig-name descname"><span class="pre">ENTERTAINMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ENTERTAINMENT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.IntendedUserTypeClass.HOBBY">
|
||
<span class="sig-name descname"><span class="pre">HOBBY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'HOBBY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InviteTokenClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">InviteTokenClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Aspect used to store invite tokens.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>role</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InviteTokenClass.role">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">role</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The role that this invite token may be associated with</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InviteTokenClass.token">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The encrypted invite token.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InviteTokenKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">InviteTokenKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for an InviteToken.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.InviteTokenKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the invite token.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.JobStatusClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">JobStatusClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Job statuses</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.JobStatusClass.COMPLETED">
|
||
<span class="sig-name descname"><span class="pre">COMPLETED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'COMPLETED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.JobStatusClass.FAILED">
|
||
<span class="sig-name descname"><span class="pre">FAILED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FAILED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.JobStatusClass.IN_PROGRESS">
|
||
<span class="sig-name descname"><span class="pre">IN_PROGRESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IN_PROGRESS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.JobStatusClass.SKIPPED">
|
||
<span class="sig-name descname"><span class="pre">SKIPPED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SKIPPED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.JobStatusClass.STARTING">
|
||
<span class="sig-name descname"><span class="pre">STARTING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STARTING'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.JobStatusClass.STOPPED">
|
||
<span class="sig-name descname"><span class="pre">STOPPED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STOPPED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.JobStatusClass.STOPPING">
|
||
<span class="sig-name descname"><span class="pre">STOPPING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STOPPING'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.JobStatusClass.UNKNOWN">
|
||
<span class="sig-name descname"><span class="pre">UNKNOWN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNKNOWN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaAuditHeaderClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">KafkaAuditHeaderClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">appName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messageId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auditVersion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fabricUrn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clusterConnectionString</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>This header records information about the context of an event as it is emitted into kafka and is intended to be used by the kafka audit application. For more information see go/kafkaauditheader</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>server</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>appName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>messageId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code>)</p></li>
|
||
<li><p><strong>instance</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>auditVersion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>fabricUrn</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>clusterConnectionString</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaAuditHeaderClass.appName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">appName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the application from which the event is being emitted. see go/appname</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaAuditHeaderClass.auditVersion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auditVersion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>if the schema has an outer KafkaAuditHeader, use the outer audit header timestamp for bucketing; else if the EventHeader has an inner KafkaAuditHeader use that inner audit header’s timestamp for bucketing</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The version that is being used for auditing. In version 0, the audit trail buckets events into 10 minute audit windows based on the EventHeader timestamp. In version 1, the audit trail buckets events as follows</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaAuditHeaderClass.clusterConnectionString">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clusterConnectionString</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>This is a String that the client uses to establish some kind of connection with the Kafka cluster. The exact format of it depends on specific versions of clients and brokers. This information could potentially identify the fabric and cluster with which the client is producing to or consuming from.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaAuditHeaderClass.fabricUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fabricUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>fabric:{fabric_name}. See go/fabric.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The fabricUrn of the host from which the event is being emitted. Fabric Urn in the format of urn</p>
|
||
</dd>
|
||
<dt class="field-even">Type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>li</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaAuditHeaderClass.instance">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">instance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The instance on the server from which the event is being emitted. e.g. i001</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaAuditHeaderClass.messageId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">messageId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bytes</span></em></dt>
|
||
<dd><p>A unique identifier for the message</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaAuditHeaderClass.server">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">server</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The fully qualified name of the host from which the event is being emitted.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaAuditHeaderClass.time">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The time at which the event was emitted into kafka.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaSchemaClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">KafkaSchemaClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">documentSchema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">documentSchemaType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keySchema</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keySchemaType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Schema holder for kafka schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>documentSchema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>documentSchemaType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>keySchema</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>keySchemaType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaSchemaClass.documentSchema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">documentSchema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native kafka document schema. This is a human readable avro document schema.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaSchemaClass.documentSchemaType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">documentSchemaType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native kafka document schema type. This can be AVRO/PROTOBUF/JSON.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaSchemaClass.keySchema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keySchema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native kafka key schema as retrieved from Schema Registry</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KafkaSchemaClass.keySchemaType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keySchemaType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native kafka key schema type. This can be AVRO/PROTOBUF/JSON.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KeyValueSchemaClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">KeyValueSchemaClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keySchema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valueSchema</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Schema text of a key-value store schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>keySchema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>valueSchema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KeyValueSchemaClass.keySchema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keySchema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The raw schema for the key in the key-value store.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.KeyValueSchemaClass.valueSchema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">valueSchema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The raw schema for the value in the key-value store.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLFeatureDataTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>MLFeature Data Type</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.AUDIO">
|
||
<span class="sig-name descname"><span class="pre">AUDIO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'AUDIO'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.BINARY">
|
||
<span class="sig-name descname"><span class="pre">BINARY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BINARY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.BYTE">
|
||
<span class="sig-name descname"><span class="pre">BYTE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BYTE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.CONTINUOUS">
|
||
<span class="sig-name descname"><span class="pre">CONTINUOUS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CONTINUOUS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.COUNT">
|
||
<span class="sig-name descname"><span class="pre">COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'COUNT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.IMAGE">
|
||
<span class="sig-name descname"><span class="pre">IMAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IMAGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.INTERVAL">
|
||
<span class="sig-name descname"><span class="pre">INTERVAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'INTERVAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.MAP">
|
||
<span class="sig-name descname"><span class="pre">MAP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MAP'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.NOMINAL">
|
||
<span class="sig-name descname"><span class="pre">NOMINAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NOMINAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.ORDINAL">
|
||
<span class="sig-name descname"><span class="pre">ORDINAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ORDINAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.SEQUENCE">
|
||
<span class="sig-name descname"><span class="pre">SEQUENCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SEQUENCE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.SET">
|
||
<span class="sig-name descname"><span class="pre">SET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SET'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.TEXT">
|
||
<span class="sig-name descname"><span class="pre">TEXT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TEXT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.TIME">
|
||
<span class="sig-name descname"><span class="pre">TIME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TIME'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.UNKNOWN">
|
||
<span class="sig-name descname"><span class="pre">UNKNOWN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNKNOWN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.USELESS">
|
||
<span class="sig-name descname"><span class="pre">USELESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'USELESS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureDataTypeClass.VIDEO">
|
||
<span class="sig-name descname"><span class="pre">VIDEO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'VIDEO'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLFeatureKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">featureNamespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for an MLFeature</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>featureNamespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureKeyClass.featureNamespace">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">featureNamespace</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Namespace for the feature</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the feature</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeaturePropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLFeaturePropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sources</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a MLFeature</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>dataType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureDataTypeClass" title="datahub.metadata.schema_classes.MLFeatureDataTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureDataTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionTagClass</span></code></a>])</p></li>
|
||
<li><p><strong>sources</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeaturePropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeaturePropertiesClass.dataType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dataType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureDataTypeClass" title="datahub.metadata.schema_classes.MLFeatureDataTypeClass"><span class="pre">MLFeatureDataTypeClass</span></a></em></dt>
|
||
<dd><p>Data Type of the MLFeature</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeaturePropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the MLFeature</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeaturePropertiesClass.sources">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sources</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Source of the MLFeature</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeaturePropertiesClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><span class="pre">VersionTagClass</span></a></em></dt>
|
||
<dd><p>Version of the MLFeature</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLFeatureSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureKeyClass" title="datahub.metadata.schema_classes.MLFeatureKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLFeaturePropertiesClass" title="datahub.metadata.schema_classes.MLFeaturePropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeaturePropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstitutionalMemoryClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeprecationClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsV2Class</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureKeyClass" title="datahub.metadata.schema_classes.MLFeatureKeyClass"><span class="pre">MLFeatureKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLFeaturePropertiesClass" title="datahub.metadata.schema_classes.MLFeaturePropertiesClass"><span class="pre">MLFeaturePropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><span class="pre">InstitutionalMemoryClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><span class="pre">DeprecationClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><span class="pre">BrowsePathsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><span class="pre">DataPlatformInstanceClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><span class="pre">BrowsePathsV2Class</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the MLFeature. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureTableKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLFeatureTableKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for an MLFeatureTable</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureTableKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the feature table</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureTableKeyClass.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Data platform urn associated with the feature table</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureTablePropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLFeatureTablePropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mlFeatures</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mlPrimaryKeys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a MLFeatureTable</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>mlFeatures</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>mlPrimaryKeys</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureTablePropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureTablePropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the MLFeatureTable</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureTablePropertiesClass.mlFeatures">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mlFeatures</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of features contained in the feature table</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureTablePropertiesClass.mlPrimaryKeys">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mlPrimaryKeys</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of primary keys in the feature table (if multiple, assumed to act as a composite key)</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureTableSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLFeatureTableSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureTableKeyClass" title="datahub.metadata.schema_classes.MLFeatureTableKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureTableKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureTablePropertiesClass" title="datahub.metadata.schema_classes.MLFeatureTablePropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureTablePropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstitutionalMemoryClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeprecationClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsV2Class</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureTableSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureTableKeyClass" title="datahub.metadata.schema_classes.MLFeatureTableKeyClass"><span class="pre">MLFeatureTableKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureTablePropertiesClass" title="datahub.metadata.schema_classes.MLFeatureTablePropertiesClass"><span class="pre">MLFeatureTablePropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><span class="pre">InstitutionalMemoryClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><span class="pre">DeprecationClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><span class="pre">BrowsePathsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><span class="pre">DataPlatformInstanceClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><span class="pre">BrowsePathsV2Class</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the MLFeatureTable. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLFeatureTableSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLHyperParamClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLHyperParamClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">createdAt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with an ML Hyper Param</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>value</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>createdAt</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLHyperParamClass.createdAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">createdAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Date when the MLHyperParam was developed</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLHyperParamClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the MLHyperParam</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLHyperParamClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the MLHyperParam</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLHyperParamClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The value of the MLHyperParam</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLMetricClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLMetricClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">createdAt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with an ML Metric</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>value</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>createdAt</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLMetricClass.createdAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">createdAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Date when the mlMetric was developed</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLMetricClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the mlMetric</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLMetricClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the mlMetric</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLMetricClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The value of the mlMetric</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLModelDeploymentKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">origin</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for an ML model deployment</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>origin</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FabricTypeClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the MLModelDeployment</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentKeyClass.origin">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">origin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><span class="pre">FabricTypeClass</span></a></em></dt>
|
||
<dd><p>Fabric type where model Deployment belongs to or where it was generated</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentKeyClass.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Standardized platform urn for the model Deployment</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLModelDeploymentPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">createdAt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with an ML Model Deployment</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>createdAt</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionTagClass</span></code></a>])</p></li>
|
||
<li><p><strong>status</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.DeploymentStatusClass" title="datahub.metadata.schema_classes.DeploymentStatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentStatusClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass.createdAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">createdAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Date when the MLModelDeployment was developed</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the MLModelDeployment</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass.status">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DeploymentStatusClass" title="datahub.metadata.schema_classes.DeploymentStatusClass"><span class="pre">DeploymentStatusClass</span></a></em></dt>
|
||
<dd><p>Status of the deployment</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><span class="pre">VersionTagClass</span></a></em></dt>
|
||
<dd><p>Version of the MLModelDeployment</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLModelDeploymentSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLModelDeploymentKeyClass" title="datahub.metadata.schema_classes.MLModelDeploymentKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelDeploymentKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass" title="datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelDeploymentPropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeprecationClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelDeploymentKeyClass" title="datahub.metadata.schema_classes.MLModelDeploymentKeyClass"><span class="pre">MLModelDeploymentKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass" title="datahub.metadata.schema_classes.MLModelDeploymentPropertiesClass"><span class="pre">MLModelDeploymentPropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><span class="pre">DeprecationClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><span class="pre">DataPlatformInstanceClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the MLModelDeployment. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelFactorPromptsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLModelFactorPromptsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">relevantFactors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">evaluationFactors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Prompts which affect the performance of the MLModel</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>relevantFactors</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLModelFactorsClass" title="datahub.metadata.schema_classes.MLModelFactorsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelFactorsClass</span></code></a>]])</p></li>
|
||
<li><p><strong>evaluationFactors</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLModelFactorsClass" title="datahub.metadata.schema_classes.MLModelFactorsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelFactorsClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelFactorPromptsClass.evaluationFactors">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">evaluationFactors</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelFactorsClass" title="datahub.metadata.schema_classes.MLModelFactorsClass"><span class="pre">MLModelFactorsClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Which factors are being reported, and why were these chosen?</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelFactorPromptsClass.relevantFactors">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">relevantFactors</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelFactorsClass" title="datahub.metadata.schema_classes.MLModelFactorsClass"><span class="pre">MLModelFactorsClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>What are foreseeable salient factors for which MLModel performance may vary, and how were these determined?</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelFactorsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLModelFactorsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instrumentation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">environment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Factors affecting the performance of the MLModel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>groups</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>instrumentation</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>environment</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelFactorsClass.environment">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">environment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A further factor affecting MLModel performance is the environment in which it is deployed.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelFactorsClass.groups">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">groups</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Groups refers to distinct categories with similar characteristics that are present in the evaluation data instances.
|
||
For human-centric machine learning MLModels, groups are people who share one or multiple characteristics.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelFactorsClass.instrumentation">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">instrumentation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The performance of a MLModel can vary depending on what instruments were used to capture the input to the MLModel.
|
||
For example, a face detection model may perform differently depending on the camera’s hardware and software,
|
||
including lens, image stabilization, high dynamic range techniques, and background blurring for portrait mode.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLModelGroupKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">origin</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for an ML model group</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>origin</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FabricTypeClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the MLModelGroup</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupKeyClass.origin">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">origin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><span class="pre">FabricTypeClass</span></a></em></dt>
|
||
<dd><p>Fabric type where model group belongs to or where it was generated</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupKeyClass.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Standardized platform urn for the model group</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLModelGroupPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trainingJobs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">downstreamJobs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">createdAt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with an ML Model Group</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>trainingJobs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>downstreamJobs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>createdAt</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionTagClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><span class="pre">TimeStampClass</span></a></em></dt>
|
||
<dd><p>Time and Actor who created the MLModelGroup</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupPropertiesClass.createdAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">createdAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Date when the MLModelGroup was developed</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupPropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the MLModelGroup</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupPropertiesClass.downstreamJobs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">downstreamJobs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of jobs or process instances (if any) that use the model or group.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupPropertiesClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><span class="pre">TimeStampClass</span></a></em></dt>
|
||
<dd><p>Date when the MLModelGroup was last modified</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupPropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the MLModelGroup</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupPropertiesClass.trainingJobs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">trainingJobs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of jobs or process instances (if any) used to train the model or group. Visible in Lineage. Note that ML Models can also be specified as the output of a specific Data Process Instances (runs) via the DataProcessInstanceOutputs aspect.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupPropertiesClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><span class="pre">VersionTagClass</span></a></em></dt>
|
||
<dd><p>Version of the MLModelGroup</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLModelGroupSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLModelGroupKeyClass" title="datahub.metadata.schema_classes.MLModelGroupKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelGroupKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLModelGroupPropertiesClass" title="datahub.metadata.schema_classes.MLModelGroupPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelGroupPropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeprecationClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsV2Class</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelGroupKeyClass" title="datahub.metadata.schema_classes.MLModelGroupKeyClass"><span class="pre">MLModelGroupKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelGroupPropertiesClass" title="datahub.metadata.schema_classes.MLModelGroupPropertiesClass"><span class="pre">MLModelGroupPropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><span class="pre">DeprecationClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><span class="pre">BrowsePathsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><span class="pre">DataPlatformInstanceClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><span class="pre">BrowsePathsV2Class</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the MLModelGroup. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelGroupSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLModelKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">origin</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for an ML model</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>platform</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>origin</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FabricTypeClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the MLModel</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelKeyClass.origin">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">origin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FabricTypeClass" title="datahub.metadata.schema_classes.FabricTypeClass"><span class="pre">FabricTypeClass</span></a></em></dt>
|
||
<dd><p>Fabric type where model belongs to or where it was generated</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelKeyClass.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Standardized platform urn for the model</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLModelPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trainingJobs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">downstreamJobs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hyperParameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hyperParams</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trainingMetrics</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">onlineMetrics</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mlFeatures</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deployments</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a ML Model</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>trainingJobs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>downstreamJobs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>date</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionTagClass</span></code></a>])</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>hyperParameters</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>]]])</p></li>
|
||
<li><p><strong>hyperParams</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLHyperParamClass" title="datahub.metadata.schema_classes.MLHyperParamClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLHyperParamClass</span></code></a>]])</p></li>
|
||
<li><p><strong>trainingMetrics</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLMetricClass" title="datahub.metadata.schema_classes.MLMetricClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLMetricClass</span></code></a>]])</p></li>
|
||
<li><p><strong>onlineMetrics</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLMetricClass" title="datahub.metadata.schema_classes.MLMetricClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLMetricClass</span></code></a>]])</p></li>
|
||
<li><p><strong>mlFeatures</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>tags</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>deployments</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>groups</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><span class="pre">TimeStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who created this and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.date">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Date when the MLModel was developed</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.deployments">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deployments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Deployments for the MLModel</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the MLModel</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.downstreamJobs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">downstreamJobs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of jobs or process instances (if any) that use the model or group.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.groups">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">groups</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Groups the model belongs to</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.hyperParameters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hyperParameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Hyper Parameters of the MLModel</p>
|
||
<p>NOTE: these are deprecated in favor of hyperParams</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.hyperParams">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hyperParams</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLHyperParamClass" title="datahub.metadata.schema_classes.MLHyperParamClass"><span class="pre">MLHyperParamClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Hyperparameters of the MLModel</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeStampClass" title="datahub.metadata.schema_classes.TimeStampClass"><span class="pre">TimeStampClass</span></a></em></dt>
|
||
<dd><p>Date when the MLModel was last modified</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.mlFeatures">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mlFeatures</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of features used for MLModel training</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the MLModel</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.onlineMetrics">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">onlineMetrics</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLMetricClass" title="datahub.metadata.schema_classes.MLMetricClass"><span class="pre">MLMetricClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Metrics of the MLModel used in production</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.tags">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Tags for the MLModel</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.trainingJobs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">trainingJobs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of jobs or process instances (if any) used to train the model or group. Visible in Lineage. Note that ML Models can also be specified as the output of a specific Data Process Instances (runs) via the DataProcessInstanceOutputs aspect.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.trainingMetrics">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">trainingMetrics</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLMetricClass" title="datahub.metadata.schema_classes.MLMetricClass"><span class="pre">MLMetricClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Metrics of the MLModel used in training</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Type of Algorithm or MLModel such as whether it is a Naive Bayes classifier, Convolutional Neural Network, etc</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelPropertiesClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><span class="pre">VersionTagClass</span></a></em></dt>
|
||
<dd><p>Version of the MLModel</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLModelSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>MLModel Snapshot entity details.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLModelKeyClass" title="datahub.metadata.schema_classes.MLModelKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLModelPropertiesClass" title="datahub.metadata.schema_classes.MLModelPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelPropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.IntendedUseClass" title="datahub.metadata.schema_classes.IntendedUseClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntendedUseClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLModelFactorPromptsClass" title="datahub.metadata.schema_classes.MLModelFactorPromptsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelFactorPromptsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MetricsClass" title="datahub.metadata.schema_classes.MetricsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetricsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.EvaluationDataClass" title="datahub.metadata.schema_classes.EvaluationDataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvaluationDataClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.TrainingDataClass" title="datahub.metadata.schema_classes.TrainingDataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrainingDataClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.QuantitativeAnalysesClass" title="datahub.metadata.schema_classes.QuantitativeAnalysesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QuantitativeAnalysesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.EthicalConsiderationsClass" title="datahub.metadata.schema_classes.EthicalConsiderationsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EthicalConsiderationsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.CaveatsAndRecommendationsClass" title="datahub.metadata.schema_classes.CaveatsAndRecommendationsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CaveatsAndRecommendationsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstitutionalMemoryClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.SourceCodeClass" title="datahub.metadata.schema_classes.SourceCodeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceCodeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.CostClass" title="datahub.metadata.schema_classes.CostClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CostClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeprecationClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowsePathsV2Class</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelKeyClass" title="datahub.metadata.schema_classes.MLModelKeyClass"><span class="pre">MLModelKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelPropertiesClass" title="datahub.metadata.schema_classes.MLModelPropertiesClass"><span class="pre">MLModelPropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IntendedUseClass" title="datahub.metadata.schema_classes.IntendedUseClass"><span class="pre">IntendedUseClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelFactorPromptsClass" title="datahub.metadata.schema_classes.MLModelFactorPromptsClass"><span class="pre">MLModelFactorPromptsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MetricsClass" title="datahub.metadata.schema_classes.MetricsClass"><span class="pre">MetricsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EvaluationDataClass" title="datahub.metadata.schema_classes.EvaluationDataClass"><span class="pre">EvaluationDataClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TrainingDataClass" title="datahub.metadata.schema_classes.TrainingDataClass"><span class="pre">TrainingDataClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.QuantitativeAnalysesClass" title="datahub.metadata.schema_classes.QuantitativeAnalysesClass"><span class="pre">QuantitativeAnalysesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EthicalConsiderationsClass" title="datahub.metadata.schema_classes.EthicalConsiderationsClass"><span class="pre">EthicalConsiderationsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CaveatsAndRecommendationsClass" title="datahub.metadata.schema_classes.CaveatsAndRecommendationsClass"><span class="pre">CaveatsAndRecommendationsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><span class="pre">InstitutionalMemoryClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SourceCodeClass" title="datahub.metadata.schema_classes.SourceCodeClass"><span class="pre">SourceCodeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CostClass" title="datahub.metadata.schema_classes.CostClass"><span class="pre">CostClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><span class="pre">DeprecationClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsClass" title="datahub.metadata.schema_classes.BrowsePathsClass"><span class="pre">BrowsePathsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><span class="pre">DataPlatformInstanceClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BrowsePathsV2Class" title="datahub.metadata.schema_classes.BrowsePathsV2Class"><span class="pre">BrowsePathsV2Class</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the MLModel. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLModelSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLPrimaryKeyKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLPrimaryKeyKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">featureNamespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for an MLPrimaryKey</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>featureNamespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLPrimaryKeyKeyClass.featureNamespace">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">featureNamespace</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Namespace for the primary key</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLPrimaryKeyKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Name of the primary key</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLPrimaryKeyPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sources</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a MLPrimaryKey</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>sources</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>dataType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureDataTypeClass" title="datahub.metadata.schema_classes.MLFeatureDataTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureDataTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionTagClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass.dataType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dataType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureDataTypeClass" title="datahub.metadata.schema_classes.MLFeatureDataTypeClass"><span class="pre">MLFeatureDataTypeClass</span></a></em></dt>
|
||
<dd><p>Data Type of the MLPrimaryKey</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the MLPrimaryKey</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass.sources">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sources</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Source of the MLPrimaryKey</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><span class="pre">VersionTagClass</span></a></em></dt>
|
||
<dd><p>Version of the MLPrimaryKey</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLPrimaryKeySnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLPrimaryKeyKeyClass" title="datahub.metadata.schema_classes.MLPrimaryKeyKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLPrimaryKeyKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass" title="datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLPrimaryKeyPropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstitutionalMemoryClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeprecationClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformInstanceClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLPrimaryKeyKeyClass" title="datahub.metadata.schema_classes.MLPrimaryKeyKeyClass"><span class="pre">MLPrimaryKeyKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass" title="datahub.metadata.schema_classes.MLPrimaryKeyPropertiesClass"><span class="pre">MLPrimaryKeyPropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.InstitutionalMemoryClass" title="datahub.metadata.schema_classes.InstitutionalMemoryClass"><span class="pre">InstitutionalMemoryClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DeprecationClass" title="datahub.metadata.schema_classes.DeprecationClass"><span class="pre">DeprecationClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformInstanceClass" title="datahub.metadata.schema_classes.DataPlatformInstanceClass"><span class="pre">DataPlatformInstanceClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the MLPrimaryKey. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLTrainingRunPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MLTrainingRunPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outputUrls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hyperParams</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trainingMetrics</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>The inputs and outputs of this training run</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>outputUrls</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>hyperParams</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLHyperParamClass" title="datahub.metadata.schema_classes.MLHyperParamClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLHyperParamClass</span></code></a>]])</p></li>
|
||
<li><p><strong>trainingMetrics</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MLMetricClass" title="datahub.metadata.schema_classes.MLMetricClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLMetricClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLTrainingRunPropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLTrainingRunPropertiesClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLTrainingRunPropertiesClass.hyperParams">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hyperParams</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLHyperParamClass" title="datahub.metadata.schema_classes.MLHyperParamClass"><span class="pre">MLHyperParamClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Hyperparameters of the ML Training Run</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLTrainingRunPropertiesClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Run Id of the ML Training Run</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLTrainingRunPropertiesClass.outputUrls">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">outputUrls</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of URLs for the Outputs of the ML Training Run</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MLTrainingRunPropertiesClass.trainingMetrics">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">trainingMetrics</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.MLMetricClass" title="datahub.metadata.schema_classes.MLMetricClass"><span class="pre">MLMetricClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Metrics of the ML Training Run</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MapTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MapTypeClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keyType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valueType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Map field type.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>keyType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>valueType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MapTypeClass.keyType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keyType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Key type in a map</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MapTypeClass.valueType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">valueType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Type of the value in a map</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MediaClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MediaClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Carries information about which roles a user is assigned to.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.MediaTypeClass" title="datahub.metadata.schema_classes.MediaTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MediaTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MediaClass.location">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">location</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Where the media content is stored.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MediaClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MediaTypeClass" title="datahub.metadata.schema_classes.MediaTypeClass"><span class="pre">MediaTypeClass</span></a></em></dt>
|
||
<dd><p>Type of content the Media is storing, e.g. image, video, etc.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MediaTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MediaTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Enum defining the type of content a Media object holds.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MediaTypeClass.IMAGE">
|
||
<span class="sig-name descname"><span class="pre">IMAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IMAGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataAttributionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MetadataAttributionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sourceDetail</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Information about who, why, and how this metadata was applied</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>actor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>source</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>sourceDetail</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataAttributionClass.actor">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The entity (e.g. a member URN) responsible for applying the assocated metadata. This can
|
||
either be a user (in case of UI edits) or the datahub system for automation.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataAttributionClass.source">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">source</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The DataHub source responsible for applying the associated metadata. This will only be filled out
|
||
when a DataHub source is responsible. This includes the specific metadata test urn, the automation urn.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataAttributionClass.sourceDetail">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceDetail</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The details associated with why this metadata was applied. For example, this could include
|
||
the actual regex rule, sql statement, ingestion pipeline ID, etc.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataAttributionClass.time">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>When this metadata was updated.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeEventClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MetadataChangeEventClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proposedSnapshot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auditHeader</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proposedDelta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">systemMetadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Kafka event for proposing a metadata change for an entity. A corresponding MetadataAuditEvent is emitted when the change is accepted and committed, otherwise a FailedMetadataChangeEvent will be emitted instead.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>proposedSnapshot</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.ChartSnapshotClass" title="datahub.metadata.schema_classes.ChartSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.CorpGroupSnapshotClass" title="datahub.metadata.schema_classes.CorpGroupSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpGroupSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserSnapshotClass" title="datahub.metadata.schema_classes.CorpUserSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CorpUserSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DashboardSnapshotClass" title="datahub.metadata.schema_classes.DashboardSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataFlowSnapshotClass" title="datahub.metadata.schema_classes.DataFlowSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataJobSnapshotClass" title="datahub.metadata.schema_classes.DataJobSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataJobSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DatasetSnapshotClass" title="datahub.metadata.schema_classes.DatasetSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessSnapshotClass" title="datahub.metadata.schema_classes.DataProcessSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcessSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformSnapshotClass" title="datahub.metadata.schema_classes.DataPlatformSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPlatformSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLModelSnapshotClass" title="datahub.metadata.schema_classes.MLModelSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass" title="datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLPrimaryKeySnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureSnapshotClass" title="datahub.metadata.schema_classes.MLFeatureSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureTableSnapshotClass" title="datahub.metadata.schema_classes.MLFeatureTableSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLFeatureTableSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass" title="datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelDeploymentSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MLModelGroupSnapshotClass" title="datahub.metadata.schema_classes.MLModelGroupSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLModelGroupSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.TagSnapshotClass" title="datahub.metadata.schema_classes.TagSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermSnapshotClass" title="datahub.metadata.schema_classes.GlossaryTermSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryNodeSnapshotClass" title="datahub.metadata.schema_classes.GlossaryNodeSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryNodeSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataHubPolicySnapshotClass" title="datahub.metadata.schema_classes.DataHubPolicySnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubPolicySnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldSnapshotClass" title="datahub.metadata.schema_classes.SchemaFieldSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldSnapshotClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DataHubRetentionSnapshotClass" title="datahub.metadata.schema_classes.DataHubRetentionSnapshotClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubRetentionSnapshotClass</span></code></a>])</p></li>
|
||
<li><p><strong>auditHeader</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass" title="datahub.metadata.schema_classes.KafkaAuditHeaderClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">KafkaAuditHeaderClass</span></code></a>])</p></li>
|
||
<li><p><strong>proposedDelta</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>)</p></li>
|
||
<li><p><strong>systemMetadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SystemMetadataClass" title="datahub.metadata.schema_classes.SystemMetadataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SystemMetadataClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeEventClass.auditHeader">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auditHeader</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass" title="datahub.metadata.schema_classes.KafkaAuditHeaderClass"><span class="pre">KafkaAuditHeaderClass</span></a></em></dt>
|
||
<dd><p>Kafka audit header. See go/kafkaauditheader for more info.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeEventClass.proposedDelta">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">proposedDelta</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>Delta of the proposed metadata partial update.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeEventClass.proposedSnapshot">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">proposedSnapshot</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChartSnapshotClass" title="datahub.metadata.schema_classes.ChartSnapshotClass"><span class="pre">ChartSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpGroupSnapshotClass" title="datahub.metadata.schema_classes.CorpGroupSnapshotClass"><span class="pre">CorpGroupSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CorpUserSnapshotClass" title="datahub.metadata.schema_classes.CorpUserSnapshotClass"><span class="pre">CorpUserSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DashboardSnapshotClass" title="datahub.metadata.schema_classes.DashboardSnapshotClass"><span class="pre">DashboardSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataFlowSnapshotClass" title="datahub.metadata.schema_classes.DataFlowSnapshotClass"><span class="pre">DataFlowSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataJobSnapshotClass" title="datahub.metadata.schema_classes.DataJobSnapshotClass"><span class="pre">DataJobSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetSnapshotClass" title="datahub.metadata.schema_classes.DatasetSnapshotClass"><span class="pre">DatasetSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataProcessSnapshotClass" title="datahub.metadata.schema_classes.DataProcessSnapshotClass"><span class="pre">DataProcessSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataPlatformSnapshotClass" title="datahub.metadata.schema_classes.DataPlatformSnapshotClass"><span class="pre">DataPlatformSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelSnapshotClass" title="datahub.metadata.schema_classes.MLModelSnapshotClass"><span class="pre">MLModelSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass" title="datahub.metadata.schema_classes.MLPrimaryKeySnapshotClass"><span class="pre">MLPrimaryKeySnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureSnapshotClass" title="datahub.metadata.schema_classes.MLFeatureSnapshotClass"><span class="pre">MLFeatureSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLFeatureTableSnapshotClass" title="datahub.metadata.schema_classes.MLFeatureTableSnapshotClass"><span class="pre">MLFeatureTableSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass" title="datahub.metadata.schema_classes.MLModelDeploymentSnapshotClass"><span class="pre">MLModelDeploymentSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MLModelGroupSnapshotClass" title="datahub.metadata.schema_classes.MLModelGroupSnapshotClass"><span class="pre">MLModelGroupSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TagSnapshotClass" title="datahub.metadata.schema_classes.TagSnapshotClass"><span class="pre">TagSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermSnapshotClass" title="datahub.metadata.schema_classes.GlossaryTermSnapshotClass"><span class="pre">GlossaryTermSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryNodeSnapshotClass" title="datahub.metadata.schema_classes.GlossaryNodeSnapshotClass"><span class="pre">GlossaryNodeSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubPolicySnapshotClass" title="datahub.metadata.schema_classes.DataHubPolicySnapshotClass"><span class="pre">DataHubPolicySnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldSnapshotClass" title="datahub.metadata.schema_classes.SchemaFieldSnapshotClass"><span class="pre">SchemaFieldSnapshotClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubRetentionSnapshotClass" title="datahub.metadata.schema_classes.DataHubRetentionSnapshotClass"><span class="pre">DataHubRetentionSnapshotClass</span></a></em></dt>
|
||
<dd><p>Snapshot of the proposed metadata change. Include only the aspects affected by the change in the snapshot.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeEventClass.systemMetadata">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">systemMetadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SystemMetadataClass" title="datahub.metadata.schema_classes.SystemMetadataClass"><span class="pre">SystemMetadataClass</span></a></em></dt>
|
||
<dd><p>Metadata around how the snapshot was ingested</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MetadataChangeLogClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entityType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">changeType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auditHeader</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entityUrn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entityKeyAspect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspectName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">systemMetadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">previousAspectValue</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">previousSystemMetadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Kafka event for capturing update made to an entity’s metadata.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>entityType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>changeType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.ChangeTypeClass" title="datahub.metadata.schema_classes.ChangeTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChangeTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>auditHeader</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass" title="datahub.metadata.schema_classes.KafkaAuditHeaderClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">KafkaAuditHeaderClass</span></code></a>])</p></li>
|
||
<li><p><strong>entityUrn</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>entityKeyAspect</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GenericAspectClass" title="datahub.metadata.schema_classes.GenericAspectClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GenericAspectClass</span></code></a>])</p></li>
|
||
<li><p><strong>aspectName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>aspect</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GenericAspectClass" title="datahub.metadata.schema_classes.GenericAspectClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GenericAspectClass</span></code></a>])</p></li>
|
||
<li><p><strong>systemMetadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SystemMetadataClass" title="datahub.metadata.schema_classes.SystemMetadataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SystemMetadataClass</span></code></a>])</p></li>
|
||
<li><p><strong>headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>previousAspectValue</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GenericAspectClass" title="datahub.metadata.schema_classes.GenericAspectClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GenericAspectClass</span></code></a>])</p></li>
|
||
<li><p><strong>previousSystemMetadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SystemMetadataClass" title="datahub.metadata.schema_classes.SystemMetadataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SystemMetadataClass</span></code></a>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass.aspect">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspect</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GenericAspectClass" title="datahub.metadata.schema_classes.GenericAspectClass"><span class="pre">GenericAspectClass</span></a></em></dt>
|
||
<dd><p>The value of the new aspect.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass.aspectName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspectName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Aspect of the entity being written to
|
||
Not filling this out implies that the writer wants to affect the entire entity
|
||
Note: This is only valid for CREATE, UPSERT, and DELETE operations.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass.auditHeader">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auditHeader</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass" title="datahub.metadata.schema_classes.KafkaAuditHeaderClass"><span class="pre">KafkaAuditHeaderClass</span></a></em></dt>
|
||
<dd><p>Kafka audit header. Currently remains unused in the open source.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass.changeType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">changeType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChangeTypeClass" title="datahub.metadata.schema_classes.ChangeTypeClass"><span class="pre">ChangeTypeClass</span></a></em></dt>
|
||
<dd><p>Type of change being proposed</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An audit stamp detailing who and when the aspect was changed by. Required for all intents and purposes.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass.entityKeyAspect">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entityKeyAspect</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GenericAspectClass" title="datahub.metadata.schema_classes.GenericAspectClass"><span class="pre">GenericAspectClass</span></a></em></dt>
|
||
<dd><p>Key aspect of the entity being written</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass.entityType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entityType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Type of the entity being written to</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass.entityUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entityUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the entity being written</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass.headers">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">headers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Headers - intended to mimic http headers</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass.previousAspectValue">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">previousAspectValue</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GenericAspectClass" title="datahub.metadata.schema_classes.GenericAspectClass"><span class="pre">GenericAspectClass</span></a></em></dt>
|
||
<dd><p>The previous value of the aspect that has changed.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass.previousSystemMetadata">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">previousSystemMetadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SystemMetadataClass" title="datahub.metadata.schema_classes.SystemMetadataClass"><span class="pre">SystemMetadataClass</span></a></em></dt>
|
||
<dd><p>The previous value of the system metadata field that has changed.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeLogClass.systemMetadata">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">systemMetadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SystemMetadataClass" title="datahub.metadata.schema_classes.SystemMetadataClass"><span class="pre">SystemMetadataClass</span></a></em></dt>
|
||
<dd><p>System properties that one might want to attach to an event</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeProposalClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MetadataChangeProposalClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entityType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">changeType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auditHeader</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entityUrn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entityKeyAspect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspectName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">systemMetadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Kafka event for proposing a metadata change for an entity. A corresponding MetadataChangeLog is emitted when the change is accepted and committed, otherwise a FailedMetadataChangeProposal will be emitted instead.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>entityType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>changeType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.ChangeTypeClass" title="datahub.metadata.schema_classes.ChangeTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChangeTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>auditHeader</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass" title="datahub.metadata.schema_classes.KafkaAuditHeaderClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">KafkaAuditHeaderClass</span></code></a>])</p></li>
|
||
<li><p><strong>entityUrn</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>entityKeyAspect</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GenericAspectClass" title="datahub.metadata.schema_classes.GenericAspectClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GenericAspectClass</span></code></a>])</p></li>
|
||
<li><p><strong>aspectName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>aspect</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GenericAspectClass" title="datahub.metadata.schema_classes.GenericAspectClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GenericAspectClass</span></code></a>])</p></li>
|
||
<li><p><strong>systemMetadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SystemMetadataClass" title="datahub.metadata.schema_classes.SystemMetadataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SystemMetadataClass</span></code></a>])</p></li>
|
||
<li><p><strong>headers</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeProposalClass.aspect">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspect</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GenericAspectClass" title="datahub.metadata.schema_classes.GenericAspectClass"><span class="pre">GenericAspectClass</span></a></em></dt>
|
||
<dd><p>The value of the new aspect.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeProposalClass.aspectName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspectName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Aspect of the entity being written to
|
||
Not filling this out implies that the writer wants to affect the entire entity
|
||
Note: This is only valid for CREATE, UPSERT, and DELETE operations.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeProposalClass.auditHeader">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auditHeader</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.KafkaAuditHeaderClass" title="datahub.metadata.schema_classes.KafkaAuditHeaderClass"><span class="pre">KafkaAuditHeaderClass</span></a></em></dt>
|
||
<dd><p>Kafka audit header. Currently remains unused in the open source.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeProposalClass.changeType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">changeType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChangeTypeClass" title="datahub.metadata.schema_classes.ChangeTypeClass"><span class="pre">ChangeTypeClass</span></a></em></dt>
|
||
<dd><p>Type of change being proposed</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeProposalClass.entityKeyAspect">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entityKeyAspect</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GenericAspectClass" title="datahub.metadata.schema_classes.GenericAspectClass"><span class="pre">GenericAspectClass</span></a></em></dt>
|
||
<dd><p>Key aspect of the entity being written</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeProposalClass.entityType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entityType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Type of the entity being written to</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeProposalClass.entityUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entityUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the entity being written</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeProposalClass.headers">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">headers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Headers - intended to mimic http headers</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetadataChangeProposalClass.systemMetadata">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">systemMetadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SystemMetadataClass" title="datahub.metadata.schema_classes.SystemMetadataClass"><span class="pre">SystemMetadataClass</span></a></em></dt>
|
||
<dd><p>System properties that one might want to attach to an event</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetricsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MetricsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">performanceMeasures</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decisionThreshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Metrics to be featured for the MLModel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>performanceMeasures</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>decisionThreshold</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetricsClass.decisionThreshold">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">decisionThreshold</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Decision Thresholds used (if any)?</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MetricsClass.performanceMeasures">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">performanceMeasures</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Measures of MLModel performance</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MySqlDDLClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">MySqlDDLClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tableSchema</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Schema holder for MySql data definition language that describes an MySql table.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>tableSchema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.MySqlDDLClass.tableSchema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tableSchema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native schema in the dataset’s platform. This is a human readable (json blob) table schema.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NativeGroupMembershipClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">NativeGroupMembershipClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nativeGroups</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Carries information about the native CorpGroups a user is in.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>nativeGroups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NativeGroupMembershipClass.nativeGroups">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nativeGroups</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookCellClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">NotebookCellClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">textCell</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">queryCell</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chartCell</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A record of all supported cells for a Notebook. Only one type of cell will be non-null.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.NotebookCellTypeClass" title="datahub.metadata.schema_classes.NotebookCellTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotebookCellTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>textCell</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TextCellClass" title="datahub.metadata.schema_classes.TextCellClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextCellClass</span></code></a>])</p></li>
|
||
<li><p><strong>queryCell</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.QueryCellClass" title="datahub.metadata.schema_classes.QueryCellClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryCellClass</span></code></a>])</p></li>
|
||
<li><p><strong>chartCell</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.ChartCellClass" title="datahub.metadata.schema_classes.ChartCellClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChartCellClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookCellClass.chartCell">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">chartCell</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChartCellClass" title="datahub.metadata.schema_classes.ChartCellClass"><span class="pre">ChartCellClass</span></a></em></dt>
|
||
<dd><p>The chart cell content. The will be non-null only when all other cell field is null.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookCellClass.queryCell">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">queryCell</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.QueryCellClass" title="datahub.metadata.schema_classes.QueryCellClass"><span class="pre">QueryCellClass</span></a></em></dt>
|
||
<dd><p>The query cell content. The will be non-null only when all other cell field is null.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookCellClass.textCell">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">textCell</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TextCellClass" title="datahub.metadata.schema_classes.TextCellClass"><span class="pre">TextCellClass</span></a></em></dt>
|
||
<dd><p>The text cell content. The will be non-null only when all other cell field is null.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookCellClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.NotebookCellTypeClass" title="datahub.metadata.schema_classes.NotebookCellTypeClass"><span class="pre">NotebookCellTypeClass</span></a></em></dt>
|
||
<dd><p>The type of this Notebook cell</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookCellTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">NotebookCellTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Type of Notebook Cell</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookCellTypeClass.CHART_CELL">
|
||
<span class="sig-name descname"><span class="pre">CHART_CELL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CHART_CELL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookCellTypeClass.QUERY_CELL">
|
||
<span class="sig-name descname"><span class="pre">QUERY_CELL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'QUERY_CELL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookCellTypeClass.TEXT_CELL">
|
||
<span class="sig-name descname"><span class="pre">TEXT_CELL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TEXT_CELL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookContentClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">NotebookContentClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cells</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Content in a Notebook
|
||
Note: This is IN BETA version</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>cells</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.NotebookCellClass" title="datahub.metadata.schema_classes.NotebookCellClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotebookCellClass</span></code></a>]])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookContentClass.cells">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cells</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.NotebookCellClass" title="datahub.metadata.schema_classes.NotebookCellClass"><span class="pre">NotebookCellClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The content of a Notebook which is composed by a list of NotebookCell</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">NotebookInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">changeAuditStamps</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a Notebook
|
||
Note: This is IN BETA version</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>title</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>changeAuditStamps</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" title="datahub.metadata.schema_classes.ChangeAuditStampsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChangeAuditStampsClass</span></code></a>)</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookInfoClass.changeAuditStamps">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">changeAuditStamps</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" title="datahub.metadata.schema_classes.ChangeAuditStampsClass"><span class="pre">ChangeAuditStampsClass</span></a></em></dt>
|
||
<dd><p>Captures information about who created/last modified/deleted this Notebook and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookInfoClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Detailed description about the Notebook</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookInfoClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookInfoClass.title">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Title of the Notebook</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">NotebookKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">notebookTool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notebookId</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Notebook</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>notebookTool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>notebookId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookKeyClass.notebookId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">notebookId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique id for the Notebook. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as ‘querybook.com/notebook/773’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotebookKeyClass.notebookTool">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">notebookTool</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the Notebook tool such as QueryBook, etc.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotificationSettingsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">NotificationSettingsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sinkTypes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slackSettings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">emailSettings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Notification settings for an actor or subscription.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>sinkTypes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.NotificationSinkTypeClass" title="datahub.metadata.schema_classes.NotificationSinkTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotificationSinkTypeClass</span></code></a>]])</p></li>
|
||
<li><p><strong>slackSettings</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SlackNotificationSettingsClass" title="datahub.metadata.schema_classes.SlackNotificationSettingsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SlackNotificationSettingsClass</span></code></a>])</p></li>
|
||
<li><p><strong>emailSettings</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.EmailNotificationSettingsClass" title="datahub.metadata.schema_classes.EmailNotificationSettingsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EmailNotificationSettingsClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotificationSettingsClass.emailSettings">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">emailSettings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EmailNotificationSettingsClass" title="datahub.metadata.schema_classes.EmailNotificationSettingsClass"><span class="pre">EmailNotificationSettingsClass</span></a></em></dt>
|
||
<dd><p>Email Notification Settings</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotificationSettingsClass.sinkTypes">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sinkTypes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.NotificationSinkTypeClass" title="datahub.metadata.schema_classes.NotificationSinkTypeClass"><span class="pre">NotificationSinkTypeClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Sink types that notifications are sent to.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotificationSettingsClass.slackSettings">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">slackSettings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SlackNotificationSettingsClass" title="datahub.metadata.schema_classes.SlackNotificationSettingsClass"><span class="pre">SlackNotificationSettingsClass</span></a></em></dt>
|
||
<dd><p>Slack Notification Settings</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotificationSinkTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">NotificationSinkTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>A type of sink / platform to send a notification to.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotificationSinkTypeClass.EMAIL">
|
||
<span class="sig-name descname"><span class="pre">EMAIL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EMAIL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NotificationSinkTypeClass.SLACK">
|
||
<span class="sig-name descname"><span class="pre">SLACK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SLACK'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NullTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">NullTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Null field type.</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.NumberTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">NumberTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Number data type: long, integer, short, etc..</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OidcSettingsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clientId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clientSecret</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">discoveryUri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">userNameClaim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">userNameClaimRegex</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clientAuthenticationMethod</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jitProvisioningEnabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preProvisioningRequired</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extractGroupsEnabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groupsClaim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">responseType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">responseMode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">useNonce</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readTimeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extractJwtAccessTokenClaims</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preferredJwsAlgorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preferredJwsAlgorithm2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Settings for OIDC SSO integration.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
<li><p><strong>clientId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>clientSecret</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>discoveryUri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>userNameClaim</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>userNameClaimRegex</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>scope</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>clientAuthenticationMethod</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>jitProvisioningEnabled</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>preProvisioningRequired</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>extractGroupsEnabled</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>groupsClaim</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>responseType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>responseMode</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>useNonce</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>readTimeout</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>extractJwtAccessTokenClaims</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>preferredJwsAlgorithm</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>preferredJwsAlgorithm2</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.clientAuthenticationMethod">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clientAuthenticationMethod</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Defaults to “client_secret_basic”.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>ADVANCED. Which authentication method to use to pass credentials (clientId and clientSecret) to the token endpoint</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.clientId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clientId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique client id issued by the identity provider.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.clientSecret">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clientSecret</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique client secret issued by the identity provider.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.discoveryUri">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">discoveryUri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The IdP OIDC discovery url.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.enabled">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">enabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether OIDC SSO is enabled.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.extractGroupsEnabled">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">extractGroupsEnabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>ADVANCED. Whether groups should be extracted from a claim in the OIDC profile. Only applies if JIT provisioning is enabled. Groups will be created if they do not exist. Defaults to true.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.extractJwtAccessTokenClaims">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">extractJwtAccessTokenClaims</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>ADVANCED. Whether to extract claims from JWT access token. Defaults to false.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.groupsClaim">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">groupsClaim</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>ADVANCED. The OIDC claim to extract groups information from. Defaults to ‘groups’.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.jitProvisioningEnabled">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">jitProvisioningEnabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>ADVANCED. Whether DataHub users should be provisioned on login if they do not exist. Defaults to true.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.preProvisioningRequired">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">preProvisioningRequired</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>ADVANCED. Whether the user should already exist in DataHub on login, failing login if they are not. Defaults to false.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.preferredJwsAlgorithm">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">preferredJwsAlgorithm</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>ADVANCED. Which jws algorithm to use. Unused.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.preferredJwsAlgorithm2">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">preferredJwsAlgorithm2</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>ADVANCED. Which jws algorithm to use.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.readTimeout">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">readTimeout</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>ADVANCED. Read timeout.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.responseMode">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">responseMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>ADVANCED. Response mode.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.responseType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">responseType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>ADVANCED. Response type.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.scope">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">scope</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>ADVANCED. String representing the requested scope from the IdP. Defaults to “oidc email profile”.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.useNonce">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">useNonce</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>ADVANCED. Use Nonce.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.userNameClaim">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">userNameClaim</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>ADVANCED. The attribute / claim used to derive the DataHub username. Defaults to “preferred_username”.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OidcSettingsClass.userNameClaimRegex">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">userNameClaimRegex</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>ADVANCED. TThe regex used to parse the DataHub username from the user name claim. Defaults to (.*) (all).</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OperationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMillis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operationType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastUpdatedTimestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eventGranularity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partitionSpec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messageId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customOperationType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numAffectedRows</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">affectedDatasets</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sourceType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Operational info for an entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>timestampMillis</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>operationType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.OperationTypeClass" title="datahub.metadata.schema_classes.OperationTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastUpdatedTimestamp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>eventGranularity</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeWindowSizeClass</span></code></a>])</p></li>
|
||
<li><p><strong>partitionSpec</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionSpecClass</span></code></a>])</p></li>
|
||
<li><p><strong>messageId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>actor</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>customOperationType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>numAffectedRows</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>affectedDatasets</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>sourceType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.OperationSourceTypeClass" title="datahub.metadata.schema_classes.OperationSourceTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationSourceTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.ASPECT_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ASPECT_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timeseries'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.actor">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Actor who issued this operation.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.affectedDatasets">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">affectedDatasets</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Which other datasets were affected by this operation.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.customOperationType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customOperationType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A custom type of operation. Required if operationType is CUSTOM.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom properties</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.eventGranularity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">eventGranularity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><span class="pre">TimeWindowSizeClass</span></a></em></dt>
|
||
<dd><p>Granularity of the event if applicable</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.lastUpdatedTimestamp">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastUpdatedTimestamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The time at which the operation occurred. Would be better named ‘operationTime’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.messageId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">messageId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.numAffectedRows">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">numAffectedRows</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>How many rows were affected by this operation.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.operationType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">operationType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OperationTypeClass" title="datahub.metadata.schema_classes.OperationTypeClass"><span class="pre">OperationTypeClass</span></a></em></dt>
|
||
<dd><p>Operation type of change.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.partitionSpec">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">partitionSpec</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><span class="pre">PartitionSpecClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The optional partition specification.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.sourceType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OperationSourceTypeClass" title="datahub.metadata.schema_classes.OperationSourceTypeClass"><span class="pre">OperationSourceTypeClass</span></a></em></dt>
|
||
<dd><p>Source Type</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationClass.timestampMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The event timestamp field as epoch at UTC in milli seconds.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationSourceTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OperationSourceTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The source of an operation</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationSourceTypeClass.DATA_PLATFORM">
|
||
<span class="sig-name descname"><span class="pre">DATA_PLATFORM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATA_PLATFORM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationSourceTypeClass.DATA_PROCESS">
|
||
<span class="sig-name descname"><span class="pre">DATA_PROCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATA_PROCESS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OperationTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Enum to define the operation type when an entity changes.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationTypeClass.ALTER">
|
||
<span class="sig-name descname"><span class="pre">ALTER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ALTER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationTypeClass.CREATE">
|
||
<span class="sig-name descname"><span class="pre">CREATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CREATE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationTypeClass.CUSTOM">
|
||
<span class="sig-name descname"><span class="pre">CUSTOM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CUSTOM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationTypeClass.DELETE">
|
||
<span class="sig-name descname"><span class="pre">DELETE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DELETE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationTypeClass.DROP">
|
||
<span class="sig-name descname"><span class="pre">DROP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DROP'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationTypeClass.INSERT">
|
||
<span class="sig-name descname"><span class="pre">INSERT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'INSERT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationTypeClass.UNKNOWN">
|
||
<span class="sig-name descname"><span class="pre">UNKNOWN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNKNOWN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OperationTypeClass.UPDATE">
|
||
<span class="sig-name descname"><span class="pre">UPDATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UPDATE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OracleDDLClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OracleDDLClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tableSchema</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Schema holder for oracle data definition language that describes an oracle table.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>tableSchema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OracleDDLClass.tableSchema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tableSchema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native schema in the dataset’s platform. This is a human readable (json blob) table schema.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OrcSchemaClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OrcSchemaClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">schema</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Schema text of an ORC schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OrcSchemaClass.schema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native schema for ORC file format.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OriginClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OriginClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Carries information about where an entity originated from.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.OriginTypeClass" title="datahub.metadata.schema_classes.OriginTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OriginTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>externalType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OriginClass.externalType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Only populated if type is EXTERNAL. The externalType of the entity, such as the name of the identity provider.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OriginClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OriginTypeClass" title="datahub.metadata.schema_classes.OriginTypeClass"><span class="pre">OriginTypeClass</span></a></em></dt>
|
||
<dd><p>Where an entity originated from. Either NATIVE or EXTERNAL.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OriginTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OriginTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Enum to define where an entity originated from.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OriginTypeClass.EXTERNAL">
|
||
<span class="sig-name descname"><span class="pre">EXTERNAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EXTERNAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OriginTypeClass.NATIVE">
|
||
<span class="sig-name descname"><span class="pre">NATIVE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NATIVE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OtherSchemaClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OtherSchemaClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rawSchema</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Schema holder for undefined schema types.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>rawSchema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OtherSchemaClass.rawSchema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rawSchema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native schema in the dataset’s platform.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnerClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OwnerClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">owner</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typeUrn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Ownership information</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>owner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipTypeClass" title="datahub.metadata.schema_classes.OwnershipTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>typeUrn</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>source</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipSourceClass" title="datahub.metadata.schema_classes.OwnershipSourceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipSourceClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnerClass.owner">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">owner</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>corpuser:ldap, urn:li:corpGroup:group_name, and urn:li:multiProduct:mp_name
|
||
(Caveat: only corpuser is currently supported in the frontend.)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Owner URN, e.g. urn</p>
|
||
</dd>
|
||
<dt class="field-even">Type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>li</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnerClass.source">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">source</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipSourceClass" title="datahub.metadata.schema_classes.OwnershipSourceClass"><span class="pre">OwnershipSourceClass</span></a></em></dt>
|
||
<dd><p>Source information for the ownership</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnerClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipTypeClass" title="datahub.metadata.schema_classes.OwnershipTypeClass"><span class="pre">OwnershipTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the ownership</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnerClass.typeUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">typeUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The type of the ownership
|
||
Urn of type O</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OwnershipClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">owners</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ownerTypes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Ownership information of an entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>owners</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.OwnerClass" title="datahub.metadata.schema_classes.OwnerClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnerClass</span></code></a>])</p></li>
|
||
<li><p><strong>ownerTypes</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who last modified the record and when. A value of 0 in the time field indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipClass.ownerTypes">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ownerTypes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>Ownership type to Owners map, populated via mutation hook.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipClass.owners">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">owners</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnerClass" title="datahub.metadata.schema_classes.OwnerClass"><span class="pre">OwnerClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of owners of the entity.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipSourceClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OwnershipSourceClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Source/provider of the ownership information</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipSourceTypeClass" title="datahub.metadata.schema_classes.OwnershipSourceTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipSourceTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>url</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipSourceClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipSourceTypeClass" title="datahub.metadata.schema_classes.OwnershipSourceTypeClass"><span class="pre">OwnershipSourceTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the source</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipSourceClass.url">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A reference URL for the source</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipSourceTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OwnershipSourceTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipSourceTypeClass.AUDIT">
|
||
<span class="sig-name descname"><span class="pre">AUDIT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'AUDIT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipSourceTypeClass.DATABASE">
|
||
<span class="sig-name descname"><span class="pre">DATABASE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATABASE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipSourceTypeClass.FILE_SYSTEM">
|
||
<span class="sig-name descname"><span class="pre">FILE_SYSTEM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FILE_SYSTEM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipSourceTypeClass.ISSUE_TRACKING_SYSTEM">
|
||
<span class="sig-name descname"><span class="pre">ISSUE_TRACKING_SYSTEM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ISSUE_TRACKING_SYSTEM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipSourceTypeClass.MANUAL">
|
||
<span class="sig-name descname"><span class="pre">MANUAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MANUAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipSourceTypeClass.OTHER">
|
||
<span class="sig-name descname"><span class="pre">OTHER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'OTHER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipSourceTypeClass.SERVICE">
|
||
<span class="sig-name descname"><span class="pre">SERVICE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SERVICE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipSourceTypeClass.SOURCE_CONTROL">
|
||
<span class="sig-name descname"><span class="pre">SOURCE_CONTROL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SOURCE_CONTROL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OwnershipTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Asset owner types</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeClass.BUSINESS_OWNER">
|
||
<span class="sig-name descname"><span class="pre">BUSINESS_OWNER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BUSINESS_OWNER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeClass.CONSUMER">
|
||
<span class="sig-name descname"><span class="pre">CONSUMER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CONSUMER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeClass.CUSTOM">
|
||
<span class="sig-name descname"><span class="pre">CUSTOM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CUSTOM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeClass.DATAOWNER">
|
||
<span class="sig-name descname"><span class="pre">DATAOWNER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATAOWNER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeClass.DATA_STEWARD">
|
||
<span class="sig-name descname"><span class="pre">DATA_STEWARD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATA_STEWARD'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeClass.DELEGATE">
|
||
<span class="sig-name descname"><span class="pre">DELEGATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DELEGATE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeClass.DEVELOPER">
|
||
<span class="sig-name descname"><span class="pre">DEVELOPER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DEVELOPER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeClass.NONE">
|
||
<span class="sig-name descname"><span class="pre">NONE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NONE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeClass.PRODUCER">
|
||
<span class="sig-name descname"><span class="pre">PRODUCER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PRODUCER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeClass.STAKEHOLDER">
|
||
<span class="sig-name descname"><span class="pre">STAKEHOLDER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STAKEHOLDER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeClass.TECHNICAL_OWNER">
|
||
<span class="sig-name descname"><span class="pre">TECHNICAL_OWNER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TECHNICAL_OWNER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OwnershipTypeInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about an ownership type</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>created</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>lastModified</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeInfoClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp capturing the time and actor who created the Ownership Type.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the Ownership Type</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeInfoClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp capturing the time and actor who last modified the Ownership Type.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the Ownership Type</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">OwnershipTypeKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Ownership Type</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.OwnershipTypeKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique ID for the data ownership type name i.e. Business Owner, Data Steward, Technical Owner, etc..
|
||
Should be separate from the name used for displaying an Ownership Type.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ParametersClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ParametersClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Arbitrary key-value parameters for an Entity Change Event. (any record).</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionSpecClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PartitionSpecClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">partition</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timePartition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A reference to a specific partition in a dataset.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>partition</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>timePartition</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowClass" title="datahub.metadata.schema_classes.TimeWindowClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeWindowClass</span></code></a>])</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.PartitionTypeClass" title="datahub.metadata.schema_classes.PartitionTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionTypeClass</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionSpecClass.partition">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">partition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id / value for the partition for which statistics were collected,
|
||
generated by applying the key definition to a given row.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionSpecClass.timePartition">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timePartition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowClass" title="datahub.metadata.schema_classes.TimeWindowClass"><span class="pre">TimeWindowClass</span></a></em></dt>
|
||
<dd><p>Time window of the partition, if we are able to extract it from the partition key.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionSpecClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionTypeClass" title="datahub.metadata.schema_classes.PartitionTypeClass"><span class="pre">PartitionTypeClass</span></a></em></dt>
|
||
<dd><p>Unused!</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionSummaryClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PartitionSummaryClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">partition</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">createdTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModifiedTime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Defines how the data is partitioned</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>partition</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>createdTime</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>lastModifiedTime</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionSummaryClass.createdTime">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">createdTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The created time for a given partition.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionSummaryClass.lastModifiedTime">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModifiedTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The last modified / touched time for a given partition.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionSummaryClass.partition">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">partition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id / value for the partition for which statistics were collected,
|
||
generated by applying the key definition to a given row.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PartitionTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionTypeClass.FULL_TABLE">
|
||
<span class="sig-name descname"><span class="pre">FULL_TABLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FULL_TABLE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionTypeClass.PARTITION">
|
||
<span class="sig-name descname"><span class="pre">PARTITION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PARTITION'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionTypeClass.QUERY">
|
||
<span class="sig-name descname"><span class="pre">QUERY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'QUERY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionsSummaryClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PartitionsSummaryClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">minPartition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxPartition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Defines how the data is partitioned for Data Lake tables (e.g. Hive, S3, Iceberg, Delta, Hudi, etc).</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>minPartition</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSummaryClass" title="datahub.metadata.schema_classes.PartitionSummaryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionSummaryClass</span></code></a>])</p></li>
|
||
<li><p><strong>maxPartition</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSummaryClass" title="datahub.metadata.schema_classes.PartitionSummaryClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionSummaryClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionsSummaryClass.maxPartition">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maxPartition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSummaryClass" title="datahub.metadata.schema_classes.PartitionSummaryClass"><span class="pre">PartitionSummaryClass</span></a></em></dt>
|
||
<dd><p>The maximum partition as ordered</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PartitionsSummaryClass.minPartition">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">minPartition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSummaryClass" title="datahub.metadata.schema_classes.PartitionSummaryClass"><span class="pre">PartitionSummaryClass</span></a></em></dt>
|
||
<dd><p>The minimum partition as ordered</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformEventClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PlatformEventClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A DataHub Platform Event.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>header</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.PlatformEventHeaderClass" title="datahub.metadata.schema_classes.PlatformEventHeaderClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlatformEventHeaderClass</span></code></a>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>payload</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.GenericPayloadClass" title="datahub.metadata.schema_classes.GenericPayloadClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GenericPayloadClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformEventClass.header">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PlatformEventHeaderClass" title="datahub.metadata.schema_classes.PlatformEventHeaderClass"><span class="pre">PlatformEventHeaderClass</span></a></em></dt>
|
||
<dd><p>Header information stored with the event.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformEventClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the event, e.g. the type of event. For example, ‘notificationRequestEvent’, ‘entityChangeEvent’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformEventClass.payload">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">payload</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GenericPayloadClass" title="datahub.metadata.schema_classes.GenericPayloadClass"><span class="pre">GenericPayloadClass</span></a></em></dt>
|
||
<dd><p>The event payload.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformEventHeaderClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PlatformEventHeaderClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMillis</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A header included with each DataHub platform event.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>timestampMillis</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformEventHeaderClass.timestampMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The event timestamp field as epoch at UTC in milli seconds.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformResourceInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PlatformResourceInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resourceType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">primaryKey</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">secondaryKeys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Platform Resource Info.
|
||
These entities are for miscelaneous data that is used in non-core parts of the system.
|
||
For instance, if we want to persist & retrieve data from auxiliary integrations such as Slack or Microsoft Teams.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>resourceType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>primaryKey</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>secondaryKeys</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>value</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SerializedValueClass" title="datahub.metadata.schema_classes.SerializedValueClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SerializedValueClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformResourceInfoClass.primaryKey">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">primaryKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The primary key for this platform resource.
|
||
e.g. for a slack member this would be the memberID.
|
||
primary keys specified here don’t need to include any additional specificity for the</p>
|
||
<blockquote>
|
||
<div><p>dataPlatform</p>
|
||
</div></blockquote>
|
||
<p>The @PlatformResourceKey is supposed to represent that</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformResourceInfoClass.resourceType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">resourceType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The type of the resource.
|
||
Intended as a loose specifier of the generic type of the resource.
|
||
Producer is not forced to conform to a specific set of symbols for
|
||
resource types.
|
||
The @PlatformResourceType enumeration offers a paved path for agreed upon
|
||
common terms, but is not required to be followed.
|
||
Example values could be: conversation, user, grant, etc.
|
||
Resource types are indexed for ease of access.
|
||
e.g. Get me all platform resources of type user for the platform looker</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformResourceInfoClass.secondaryKeys">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">secondaryKeys</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The secondary keys this platform resource can be located by.
|
||
I.e., for a slack member this would be email or phone.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformResourceInfoClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SerializedValueClass" title="datahub.metadata.schema_classes.SerializedValueClass"><span class="pre">SerializedValueClass</span></a></em></dt>
|
||
<dd><p>The serialized value of this platform resource item.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformResourceKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PlatformResourceKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Platform Resource.
|
||
Platform Resources are assets that are not part of the core data model.
|
||
They are stored in DataHub primarily to help with application-specific
|
||
use-cases that are not sufficiently generalized to move into the core data model.
|
||
For instance, if we want to persist & retrieve additional user profile data
|
||
from auxiliary integrations such as Slack or Microsoft Teams for resolving details later.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformResourceKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for this entity.
|
||
There are no constraints on the format of this id, but most implementations
|
||
will choose to use a UUID.
|
||
This id should be globally unique for the entire DataHub instance and</p>
|
||
<blockquote>
|
||
<div><p>uniquely identify the resource that is being stored, so most
|
||
implementations</p>
|
||
</div></blockquote>
|
||
<p>will combine logical attributes like platform name, platform instance,
|
||
platform-specific-id and the resource type to create the unique id.
|
||
e.g. slack:slack-instance:slack-user-id:user-info
|
||
or guid(slack, slack-instance, slack-user-id, user-info) etc.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PlatformTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Platform types available at LinkedIn</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformTypeClass.FILE_SYSTEM">
|
||
<span class="sig-name descname"><span class="pre">FILE_SYSTEM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FILE_SYSTEM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformTypeClass.KEY_VALUE_STORE">
|
||
<span class="sig-name descname"><span class="pre">KEY_VALUE_STORE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'KEY_VALUE_STORE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformTypeClass.MESSAGE_BROKER">
|
||
<span class="sig-name descname"><span class="pre">MESSAGE_BROKER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MESSAGE_BROKER'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformTypeClass.OBJECT_STORE">
|
||
<span class="sig-name descname"><span class="pre">OBJECT_STORE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'OBJECT_STORE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformTypeClass.OLAP_DATASTORE">
|
||
<span class="sig-name descname"><span class="pre">OLAP_DATASTORE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'OLAP_DATASTORE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformTypeClass.OTHERS">
|
||
<span class="sig-name descname"><span class="pre">OTHERS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'OTHERS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformTypeClass.QUERY_ENGINE">
|
||
<span class="sig-name descname"><span class="pre">QUERY_ENGINE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'QUERY_ENGINE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformTypeClass.RELATIONAL_DB">
|
||
<span class="sig-name descname"><span class="pre">RELATIONAL_DB</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'RELATIONAL_DB'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PlatformTypeClass.SEARCH_ENGINE">
|
||
<span class="sig-name descname"><span class="pre">SEARCH_ENGINE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SEARCH_ENGINE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PolicyMatchConditionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PolicyMatchConditionClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The matching condition in a filter criterion</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PolicyMatchConditionClass.EQUALS">
|
||
<span class="sig-name descname"><span class="pre">EQUALS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EQUALS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PolicyMatchConditionClass.STARTS_WITH">
|
||
<span class="sig-name descname"><span class="pre">STARTS_WITH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'STARTS_WITH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PolicyMatchCriterionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PolicyMatchCriterionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">condition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A criterion for matching a field with given value</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>field</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>values</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>condition</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.PolicyMatchConditionClass" title="datahub.metadata.schema_classes.PolicyMatchConditionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PolicyMatchConditionClass</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PolicyMatchCriterionClass.condition">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PolicyMatchConditionClass" title="datahub.metadata.schema_classes.PolicyMatchConditionClass"><span class="pre">PolicyMatchConditionClass</span></a></em></dt>
|
||
<dd><p>The condition for the criterion</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PolicyMatchCriterionClass.field">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">field</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the field that the criterion refers to</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PolicyMatchCriterionClass.values">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">values</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Values. Matches criterion if any one of the values matches condition (OR-relationship)</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PolicyMatchFilterClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PolicyMatchFilterClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">criteria</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>The filter for specifying the resource or actor to apply privileges to</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>criteria</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PolicyMatchCriterionClass" title="datahub.metadata.schema_classes.PolicyMatchCriterionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PolicyMatchCriterionClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PolicyMatchFilterClass.criteria">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">criteria</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.PolicyMatchCriterionClass" title="datahub.metadata.schema_classes.PolicyMatchCriterionClass"><span class="pre">PolicyMatchCriterionClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A list of criteria to apply conjunctively (so all criteria must pass)</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostContentClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PostContentClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">link</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">media</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Content stored inside a Post.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>title</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.PostContentTypeClass" title="datahub.metadata.schema_classes.PostContentTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PostContentTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>link</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>media</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MediaClass" title="datahub.metadata.schema_classes.MediaClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MediaClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostContentClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional description of the post.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostContentClass.link">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">link</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional link that the post is associated with.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostContentClass.media">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MediaClass" title="datahub.metadata.schema_classes.MediaClass"><span class="pre">MediaClass</span></a></em></dt>
|
||
<dd><p>Optional media that the post is storing</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostContentClass.title">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Title of the post.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostContentClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PostContentTypeClass" title="datahub.metadata.schema_classes.PostContentTypeClass"><span class="pre">PostContentTypeClass</span></a></em></dt>
|
||
<dd><p>Type of content held in the post.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostContentTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PostContentTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Enum defining the type of content held in a Post.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostContentTypeClass.LINK">
|
||
<span class="sig-name descname"><span class="pre">LINK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LINK'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostContentTypeClass.TEXT">
|
||
<span class="sig-name descname"><span class="pre">TEXT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TEXT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PostInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auditStamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a DataHub Post.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.PostTypeClass" title="datahub.metadata.schema_classes.PostTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PostTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>content</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.PostContentClass" title="datahub.metadata.schema_classes.PostContentClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PostContentClass</span></code></a>)</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>auditStamp</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>target</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostInfoClass.auditStamp">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auditStamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>The audit stamp at which the request was last updated</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostInfoClass.content">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">content</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PostContentClass" title="datahub.metadata.schema_classes.PostContentClass"><span class="pre">PostContentClass</span></a></em></dt>
|
||
<dd><p>Content stored in the post.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostInfoClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The time at which the post was initially created</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostInfoClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The time at which the post was last modified</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostInfoClass.target">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">target</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional Entity URN that the post is associated with.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PostTypeClass" title="datahub.metadata.schema_classes.PostTypeClass"><span class="pre">PostTypeClass</span></a></em></dt>
|
||
<dd><p>Type of the Post.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PostKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Post.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the DataHub Post record. Generated on the server side at Post creation time.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PostTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Enum defining types of Posts.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostTypeClass.ENTITY_ANNOUNCEMENT">
|
||
<span class="sig-name descname"><span class="pre">ENTITY_ANNOUNCEMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ENTITY_ANNOUNCEMENT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PostTypeClass.HOME_PAGE_ANNOUNCEMENT">
|
||
<span class="sig-name descname"><span class="pre">HOME_PAGE_ANNOUNCEMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'HOME_PAGE_ANNOUNCEMENT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PrestoDDLClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PrestoDDLClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rawSchema</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Schema holder for presto data definition language that describes a presto view.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>rawSchema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PrestoDDLClass.rawSchema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rawSchema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The raw schema in the dataset’s platform. This includes the DDL and the columns extracted from DDL.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PropertyCardinalityClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PropertyCardinalityClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PropertyCardinalityClass.MULTIPLE">
|
||
<span class="sig-name descname"><span class="pre">MULTIPLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MULTIPLE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PropertyCardinalityClass.SINGLE">
|
||
<span class="sig-name descname"><span class="pre">SINGLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SINGLE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PropertyValueClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">PropertyValueClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>value</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PropertyValueClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional description of the property value</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.PropertyValueClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuantileClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">QuantileClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">quantile</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>quantile</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuantileClass.quantile">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">quantile</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuantileClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuantitativeAnalysesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">QuantitativeAnalysesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unitaryResults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intersectionalResults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Quantitative analyses should be disaggregated, that is, broken down by the chosen factors. Quantitative analyses should provide the results of evaluating the MLModel according to the chosen metrics, providing confidence interval values when possible.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>unitaryResults</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>intersectionalResults</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuantitativeAnalysesClass.intersectionalResults">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">intersectionalResults</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Link to a dashboard with results showing how the MLModel performed with respect to the intersection of evaluated factors?</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuantitativeAnalysesClass.unitaryResults">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unitaryResults</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Link to a dashboard with results showing how the MLModel performed with respect to each factor</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryCellClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">QueryCellClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cellId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">changeAuditStamps</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rawQuery</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cellTitle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastExecuted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Query cell in a Notebook, which will present content in query format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cellId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>changeAuditStamps</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" title="datahub.metadata.schema_classes.ChangeAuditStampsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChangeAuditStampsClass</span></code></a>)</p></li>
|
||
<li><p><strong>rawQuery</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>cellTitle</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>lastExecuted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryCellClass.cellId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cellId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique id for the cell. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as ‘querybook.com/notebook/773/?cellId=1234’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryCellClass.cellTitle">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cellTitle</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Title of the cell</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryCellClass.changeAuditStamps">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">changeAuditStamps</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" title="datahub.metadata.schema_classes.ChangeAuditStampsClass"><span class="pre">ChangeAuditStampsClass</span></a></em></dt>
|
||
<dd><p>Captures information about who created/last modified/deleted this Notebook cell and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryCellClass.lastExecuted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastExecuted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Captures information about who last executed this query cell and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryCellClass.rawQuery">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rawQuery</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Raw query to explain some specific logic in a Notebook</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">QueryKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Query</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the Query.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryLanguageClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">QueryLanguageClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryLanguageClass.SQL">
|
||
<span class="sig-name descname"><span class="pre">SQL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SQL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryLanguageClass.UNKNOWN">
|
||
<span class="sig-name descname"><span class="pre">UNKNOWN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNKNOWN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">QueryPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statement</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">origin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a Query against one or more data assets (e.g. Tables or Views).</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>statement</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.QueryStatementClass" title="datahub.metadata.schema_classes.QueryStatementClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryStatementClass</span></code></a>)</p></li>
|
||
<li><p><strong>source</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.QuerySourceClass" title="datahub.metadata.schema_classes.QuerySourceClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QuerySourceClass</span></code></a>])</p></li>
|
||
<li><p><strong>created</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>lastModified</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>)</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>origin</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryPropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp capturing the time and actor who created the Query.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryPropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The Query description.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryPropertiesClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp capturing the time and actor who last modified the Query.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryPropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional display name to identify the query.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryPropertiesClass.origin">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">origin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The origin of the Query.
|
||
This is the source of the Query (e.g. a View, Stored Procedure, dbt Model, etc.) that the Query was created from.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryPropertiesClass.source">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">source</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.QuerySourceClass" title="datahub.metadata.schema_classes.QuerySourceClass"><span class="pre">QuerySourceClass</span></a></em></dt>
|
||
<dd><p>The source of the Query</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryPropertiesClass.statement">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">statement</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.QueryStatementClass" title="datahub.metadata.schema_classes.QueryStatementClass"><span class="pre">QueryStatementClass</span></a></em></dt>
|
||
<dd><p>The Query Statement.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuerySourceClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">QuerySourceClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuerySourceClass.MANUAL">
|
||
<span class="sig-name descname"><span class="pre">MANUAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MANUAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuerySourceClass.SYSTEM">
|
||
<span class="sig-name descname"><span class="pre">SYSTEM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SYSTEM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryStatementClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">QueryStatementClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">language</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A query statement against one or more data assets.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>language</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.QueryLanguageClass" title="datahub.metadata.schema_classes.QueryLanguageClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryLanguageClass</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryStatementClass.language">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">language</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.QueryLanguageClass" title="datahub.metadata.schema_classes.QueryLanguageClass"><span class="pre">QueryLanguageClass</span></a></em></dt>
|
||
<dd><p>The language of the Query, e.g. SQL.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryStatementClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The query text</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuerySubjectClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">QuerySubjectClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A single subject of a particular query.
|
||
In the future, we may evolve this model to include richer details
|
||
about the Query Subject in relation to the query.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuerySubjectClass.entity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>An entity which is the subject of a query.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuerySubjectsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">QuerySubjectsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subjects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about the subjects of a particular Query, i.e. the assets
|
||
being queried.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>subjects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.QuerySubjectClass" title="datahub.metadata.schema_classes.QuerySubjectClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">QuerySubjectClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QuerySubjectsClass.subjects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">subjects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.QuerySubjectClass" title="datahub.metadata.schema_classes.QuerySubjectClass"><span class="pre">QuerySubjectClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>One or more subjects of the query.</p>
|
||
<p>In single-asset queries (e.g. table select), this will contain the Table reference
|
||
and optionally schema field references.</p>
|
||
<p>In multi-asset queries (e.g. table joins), this may contain multiple Table references
|
||
and optionally schema field references.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryUsageStatisticsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">QueryUsageStatisticsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestampMillis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eventGranularity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partitionSpec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messageId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">queryCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">queryCost</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastExecutedAt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uniqueUserCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">userCounts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Stats corresponding to dataset’s usage.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>timestampMillis</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>eventGranularity</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeWindowSizeClass</span></code></a>])</p></li>
|
||
<li><p><strong>partitionSpec</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PartitionSpecClass</span></code></a>])</p></li>
|
||
<li><p><strong>messageId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>queryCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>queryCost</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>])</p></li>
|
||
<li><p><strong>lastExecutedAt</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>uniqueUserCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>userCounts</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DatasetUserUsageCountsClass" title="datahub.metadata.schema_classes.DatasetUserUsageCountsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetUserUsageCountsClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryUsageStatisticsClass.ASPECT_TYPE">
|
||
<span class="sig-name descname"><span class="pre">ASPECT_TYPE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">ClassVar</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timeseries'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryUsageStatisticsClass.eventGranularity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">eventGranularity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><span class="pre">TimeWindowSizeClass</span></a></em></dt>
|
||
<dd><p>Granularity of the event if applicable</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryUsageStatisticsClass.lastExecutedAt">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastExecutedAt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Last executed timestamp</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryUsageStatisticsClass.messageId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">messageId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryUsageStatisticsClass.partitionSpec">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">partitionSpec</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PartitionSpecClass" title="datahub.metadata.schema_classes.PartitionSpecClass"><span class="pre">PartitionSpecClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The optional partition specification.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryUsageStatisticsClass.queryCost">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">queryCost</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span></em></dt>
|
||
<dd><p>Query cost for this query and bucket</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryUsageStatisticsClass.queryCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">queryCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Total query count in this bucket</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryUsageStatisticsClass.timestampMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timestampMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The event timestamp field as epoch at UTC in milli seconds.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryUsageStatisticsClass.uniqueUserCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uniqueUserCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Unique user count</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.QueryUsageStatisticsClass.userCounts">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">userCounts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetUserUsageCountsClass" title="datahub.metadata.schema_classes.DatasetUserUsageCountsClass"><span class="pre">DatasetUserUsageCountsClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Users within this bucket, with frequency counts</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RecordTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">RecordTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Record field type.</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RelationshipFieldMappingClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">RelationshipFieldMappingClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sourceField</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">destinationField</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Individual Field Mapping of a relationship- one of several</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>sourceField</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>destinationField</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RelationshipFieldMappingClass.destinationField">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">destinationField</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>1</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>All fields from dataset B that are required for the join, maps to aFields 1</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RelationshipFieldMappingClass.sourceField">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceField</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>1</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>All fields from dataset A that are required for the join, maps to bFields 1</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RetentionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">RetentionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Base class that encapsulates different retention policies.
|
||
Only one of the fields should be set</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>version</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.VersionBasedRetentionClass" title="datahub.metadata.schema_classes.VersionBasedRetentionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionBasedRetentionClass</span></code></a>])</p></li>
|
||
<li><p><strong>time</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TimeBasedRetentionClass" title="datahub.metadata.schema_classes.TimeBasedRetentionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeBasedRetentionClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RetentionClass.time">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeBasedRetentionClass" title="datahub.metadata.schema_classes.TimeBasedRetentionClass"><span class="pre">TimeBasedRetentionClass</span></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RetentionClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersionBasedRetentionClass" title="datahub.metadata.schema_classes.VersionBasedRetentionClass"><span class="pre">VersionBasedRetentionClass</span></a></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RoleAssociationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">RoleAssociationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Properties of an applied Role. For now, just an Urn</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RoleAssociationClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the External Role</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RoleKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">RoleKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a External AccessManagement</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RoleKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A unique id for the access management IAM.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RoleMembershipClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">RoleMembershipClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">roles</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Carries information about which roles a user or group is assigned to.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>roles</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RoleMembershipClass.roles">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">roles</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RolePropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">RolePropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">requestUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a ExternalRoleProperties</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>requestUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RolePropertiesClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Created Audit stamp</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RolePropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the IAM Role</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RolePropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the IAM Role in the external system</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RolePropertiesClass.requestUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">requestUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Link to access external access management</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RolePropertiesClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Can be READ, ADMIN, WRITE</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RoleUserClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">RoleUserClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Provisioned users of a role</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RoleUserClass.user">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Link provisioned corp user for a role</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RowCountChangeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">RowCountChangeClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining a ROW_COUNT_CHANGE volume assertion.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass" title="datahub.metadata.schema_classes.AssertionValueChangeTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionValueChangeTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>operator</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdOperatorClass</span></code></a>])</p></li>
|
||
<li><p><strong>parameters</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdParametersClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RowCountChangeClass.operator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">operator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><span class="pre">AssertionStdOperatorClass</span></a></em></dt>
|
||
<dd><p>The operator you’d like to apply.</p>
|
||
<p>Note that only numeric operators are valid inputs:
|
||
GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO,
|
||
BETWEEN.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RowCountChangeClass.parameters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><span class="pre">AssertionStdParametersClass</span></a></em></dt>
|
||
<dd><p>The parameters you’d like to provide as input to the operator.</p>
|
||
<p>Note that only numeric parameter types are valid inputs: NUMBER.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RowCountChangeClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass" title="datahub.metadata.schema_classes.AssertionValueChangeTypeClass"><span class="pre">AssertionValueChangeTypeClass</span></a></em></dt>
|
||
<dd><p>a fixed absolute value or a relative percentage.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The type of the value used to evaluate the assertion</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RowCountTotalClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">RowCountTotalClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">operator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining a ROW_COUNT_TOTAL volume assertion.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>operator</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdOperatorClass</span></code></a>])</p></li>
|
||
<li><p><strong>parameters</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdParametersClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RowCountTotalClass.operator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">operator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><span class="pre">AssertionStdOperatorClass</span></a></em></dt>
|
||
<dd><p>The operator you’d like to apply.</p>
|
||
<p>Note that only numeric operators are valid inputs:
|
||
GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO,
|
||
BETWEEN.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RowCountTotalClass.parameters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><span class="pre">AssertionStdParametersClass</span></a></em></dt>
|
||
<dd><p>The parameters you’d like to provide as input to the operator.</p>
|
||
<p>Note that only numeric parameter types are valid inputs: NUMBER.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RunResultTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">RunResultTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RunResultTypeClass.FAILURE">
|
||
<span class="sig-name descname"><span class="pre">FAILURE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FAILURE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RunResultTypeClass.SKIPPED">
|
||
<span class="sig-name descname"><span class="pre">SKIPPED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SKIPPED'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RunResultTypeClass.SUCCESS">
|
||
<span class="sig-name descname"><span class="pre">SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SUCCESS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.RunResultTypeClass.UP_FOR_RETRY">
|
||
<span class="sig-name descname"><span class="pre">UP_FOR_RETRY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UP_FOR_RETRY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SchemaAssertionCompatibilityClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass.EXACT_MATCH">
|
||
<span class="sig-name descname"><span class="pre">EXACT_MATCH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EXACT_MATCH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass.SUBSET">
|
||
<span class="sig-name descname"><span class="pre">SUBSET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SUBSET'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass.SUPERSET">
|
||
<span class="sig-name descname"><span class="pre">SUPERSET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SUPERSET'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaAssertionInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SchemaAssertionInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatibility</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes that are applicable to schema assertions</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>schema</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.SchemaMetadataClass" title="datahub.metadata.schema_classes.SchemaMetadataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaMetadataClass</span></code></a>)</p></li>
|
||
<li><p><strong>compatibility</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass" title="datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaAssertionCompatibilityClass</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaAssertionInfoClass.compatibility">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">compatibility</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass" title="datahub.metadata.schema_classes.SchemaAssertionCompatibilityClass"><span class="pre">SchemaAssertionCompatibilityClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The required compatibility level for the schema assertion to pass.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaAssertionInfoClass.entity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The entity targeted by the assertion</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaAssertionInfoClass.schema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaMetadataClass" title="datahub.metadata.schema_classes.SchemaMetadataClass"><span class="pre">SchemaMetadataClass</span></a></em></dt>
|
||
<dd><p>A definition of the expected structure for the asset</p>
|
||
<p>Note that many of the fields of this model, especially those related to metadata (tags, terms)
|
||
will go unused in this context.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaContractClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SchemaContractClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">assertion</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Expectations for a logical schema</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>assertion</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaContractClass.assertion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">assertion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The assertion representing the schema contract.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldAliasesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SchemaFieldAliasesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>aliases</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldAliasesClass.aliases">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Used to store aliases</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SchemaFieldClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fieldPath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nativeDataType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jsonPath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nullable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recursive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">globalTags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">glossaryTerms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isPartOfKey</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isPartitioningKey</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jsonProps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>SchemaField to describe metadata related to dataset schema.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>fieldPath</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldDataTypeClass" title="datahub.metadata.schema_classes.SchemaFieldDataTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldDataTypeClass</span></code></a>)</p></li>
|
||
<li><p><strong>nativeDataType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>jsonPath</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>nullable</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>label</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>recursive</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>globalTags</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalTagsClass</span></code></a>])</p></li>
|
||
<li><p><strong>glossaryTerms</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlossaryTermsClass</span></code></a>])</p></li>
|
||
<li><p><strong>isPartOfKey</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>isPartitioningKey</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>jsonProps</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the creation of this schema field.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.fieldPath">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldPath</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Flattened name of the field. Field is computed from jsonPath field.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.globalTags">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">globalTags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlobalTagsClass" title="datahub.metadata.schema_classes.GlobalTagsClass"><span class="pre">GlobalTagsClass</span></a></em></dt>
|
||
<dd><p>Tags associated with the field</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.glossaryTerms">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">glossaryTerms</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.GlossaryTermsClass" title="datahub.metadata.schema_classes.GlossaryTermsClass"><span class="pre">GlossaryTermsClass</span></a></em></dt>
|
||
<dd><p>Glossary terms associated with the field</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.isPartOfKey">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isPartOfKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>For schema fields that are part of complex keys, set this field to true
|
||
We do this to easily distinguish between value and key fields</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.isPartitioningKey">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isPartitioningKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>For Datasets which are partitioned, this determines the partitioning key.
|
||
Note that multiple columns can be part of a partitioning key, but currently we do not support
|
||
rendering the ordered partitioning key.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.jsonPath">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">jsonPath</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Flattened name of a field in JSON Path notation.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.jsonProps">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">jsonProps</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>For schema fields that have other properties that are not modeled explicitly,
|
||
use this field to serialize those properties into a JSON string</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.label">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">label</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Label of the field. Provides a more human-readable name for the field than field path. Some sources will
|
||
provide this metadata but not all sources have the concept of a label. If just one string is associated with
|
||
a field in a source, that is most likely a description.</p>
|
||
<p>Note that this field is deprecated and is not surfaced in the UI.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the last modification of this schema field.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.nativeDataType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nativeDataType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native type of the field in the dataset’s platform as declared by platform schema.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.nullable">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nullable</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Indicates if this field is optional or nullable</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.recursive">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">recursive</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>There are use cases when a field in type B references type A. A field in A references field of type B. In such cases, we will mark the first field as recursive.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldDataTypeClass" title="datahub.metadata.schema_classes.SchemaFieldDataTypeClass"><span class="pre">SchemaFieldDataTypeClass</span></a></em></dt>
|
||
<dd><p>Platform independent field type of the field.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldDataTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SchemaFieldDataTypeClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Schema field data types</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.BooleanTypeClass" title="datahub.metadata.schema_classes.BooleanTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BooleanTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.FixedTypeClass" title="datahub.metadata.schema_classes.FixedTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FixedTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StringTypeClass" title="datahub.metadata.schema_classes.StringTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StringTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BytesTypeClass" title="datahub.metadata.schema_classes.BytesTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BytesTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.NumberTypeClass" title="datahub.metadata.schema_classes.NumberTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">NumberTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.DateTypeClass" title="datahub.metadata.schema_classes.DateTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DateTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.TimeTypeClass" title="datahub.metadata.schema_classes.TimeTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.EnumTypeClass" title="datahub.metadata.schema_classes.EnumTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.NullTypeClass" title="datahub.metadata.schema_classes.NullTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">NullTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MapTypeClass" title="datahub.metadata.schema_classes.MapTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MapTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.ArrayTypeClass" title="datahub.metadata.schema_classes.ArrayTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArrayTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.UnionTypeClass" title="datahub.metadata.schema_classes.UnionTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnionTypeClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.RecordTypeClass" title="datahub.metadata.schema_classes.RecordTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RecordTypeClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldDataTypeClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BooleanTypeClass" title="datahub.metadata.schema_classes.BooleanTypeClass"><span class="pre">BooleanTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.FixedTypeClass" title="datahub.metadata.schema_classes.FixedTypeClass"><span class="pre">FixedTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StringTypeClass" title="datahub.metadata.schema_classes.StringTypeClass"><span class="pre">StringTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BytesTypeClass" title="datahub.metadata.schema_classes.BytesTypeClass"><span class="pre">BytesTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.NumberTypeClass" title="datahub.metadata.schema_classes.NumberTypeClass"><span class="pre">NumberTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DateTypeClass" title="datahub.metadata.schema_classes.DateTypeClass"><span class="pre">DateTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeTypeClass" title="datahub.metadata.schema_classes.TimeTypeClass"><span class="pre">TimeTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EnumTypeClass" title="datahub.metadata.schema_classes.EnumTypeClass"><span class="pre">EnumTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.NullTypeClass" title="datahub.metadata.schema_classes.NullTypeClass"><span class="pre">NullTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MapTypeClass" title="datahub.metadata.schema_classes.MapTypeClass"><span class="pre">MapTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ArrayTypeClass" title="datahub.metadata.schema_classes.ArrayTypeClass"><span class="pre">ArrayTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.UnionTypeClass" title="datahub.metadata.schema_classes.UnionTypeClass"><span class="pre">UnionTypeClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.RecordTypeClass" title="datahub.metadata.schema_classes.RecordTypeClass"><span class="pre">RecordTypeClass</span></a></em></dt>
|
||
<dd><p>Data platform specific types</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SchemaFieldInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schemaFieldAliases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>schemaFieldAliases</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldInfoClass.schemaFieldAliases">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schemaFieldAliases</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Used to store field path variations for the schemaField urn.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SchemaFieldKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldPath</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a SchemaField</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>fieldPath</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldKeyClass.fieldPath">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fieldPath</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>fieldPath identifying the schema field</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldKeyClass.parent">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parent</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Parent associated with the schema field</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SchemaFieldSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific schema field entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldKeyClass" title="datahub.metadata.schema_classes.SchemaFieldKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldKeyClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldKeyClass" title="datahub.metadata.schema_classes.SchemaFieldKeyClass"><span class="pre">SchemaFieldKeyClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the dataset. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldSpecClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SchemaFieldSpecClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nativeType</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Lightweight spec used for referencing a particular schema field.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>nativeType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldSpecClass.nativeType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nativeType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The native field type</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldSpecClass.path">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The field path</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaFieldSpecClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The DataHub standard schema field type.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SchemaMetadataClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">schemaName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hash</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">platformSchema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fields</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">primaryKeys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">foreignKeysSpecs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">foreignKeys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>SchemaMetadata to describe metadata related to store schema</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>schemaName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>platform</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>hash</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>platformSchema</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.EspressoSchemaClass" title="datahub.metadata.schema_classes.EspressoSchemaClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">EspressoSchemaClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OracleDDLClass" title="datahub.metadata.schema_classes.OracleDDLClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OracleDDLClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.MySqlDDLClass" title="datahub.metadata.schema_classes.MySqlDDLClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MySqlDDLClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.PrestoDDLClass" title="datahub.metadata.schema_classes.PrestoDDLClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrestoDDLClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.KafkaSchemaClass" title="datahub.metadata.schema_classes.KafkaSchemaClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">KafkaSchemaClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.BinaryJsonSchemaClass" title="datahub.metadata.schema_classes.BinaryJsonSchemaClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BinaryJsonSchemaClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OrcSchemaClass" title="datahub.metadata.schema_classes.OrcSchemaClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrcSchemaClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.SchemalessClass" title="datahub.metadata.schema_classes.SchemalessClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemalessClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.KeyValueSchemaClass" title="datahub.metadata.schema_classes.KeyValueSchemaClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">KeyValueSchemaClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OtherSchemaClass" title="datahub.metadata.schema_classes.OtherSchemaClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OtherSchemaClass</span></code></a>])</p></li>
|
||
<li><p><strong>fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldClass" title="datahub.metadata.schema_classes.SchemaFieldClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaFieldClass</span></code></a>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>deleted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>dataset</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>primaryKeys</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>foreignKeysSpecs</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.ForeignKeySpecClass" title="datahub.metadata.schema_classes.ForeignKeySpecClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ForeignKeySpecClass</span></code></a>]])</p></li>
|
||
<li><p><strong>foreignKeys</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.ForeignKeyConstraintClass" title="datahub.metadata.schema_classes.ForeignKeyConstraintClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ForeignKeyConstraintClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.cluster">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cluster</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The cluster this schema metadata resides from</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.dataset">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dataset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Dataset this schema metadata is associated with.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.deleted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deleted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the deletion of this resource/association/sub-resource. Logically, deleted MUST have a later timestamp than creation. It may or may not have the same time as lastModified depending upon the resource/association/sub-resource semantics.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.fields">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemaFieldClass" title="datahub.metadata.schema_classes.SchemaFieldClass"><span class="pre">SchemaFieldClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Client provided a list of fields from document schema.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.foreignKeys">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">foreignKeys</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.ForeignKeyConstraintClass" title="datahub.metadata.schema_classes.ForeignKeyConstraintClass"><span class="pre">ForeignKeyConstraintClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of foreign key constraints for the schema</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.foreignKeysSpecs">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">foreignKeysSpecs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ForeignKeySpecClass" title="datahub.metadata.schema_classes.ForeignKeySpecClass"><span class="pre">ForeignKeySpecClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Map captures all the references schema makes to external datasets. Map key is ForeignKeySpecName typeref.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.hash">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hash</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>the SHA1 hash of the schema content</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>An AuditStamp corresponding to the last modification of this resource/association/sub-resource. If no modification has happened since creation, lastModified should be the same as created. A value of 0 for time indicates missing data.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.platform">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platform</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>platform:{platform_name})</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Standardized platform urn where schema is defined. The data platform Urn (urn</p>
|
||
</dd>
|
||
<dt class="field-even">Type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>li</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.platformSchema">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">platformSchema</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.EspressoSchemaClass" title="datahub.metadata.schema_classes.EspressoSchemaClass"><span class="pre">EspressoSchemaClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OracleDDLClass" title="datahub.metadata.schema_classes.OracleDDLClass"><span class="pre">OracleDDLClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MySqlDDLClass" title="datahub.metadata.schema_classes.MySqlDDLClass"><span class="pre">MySqlDDLClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PrestoDDLClass" title="datahub.metadata.schema_classes.PrestoDDLClass"><span class="pre">PrestoDDLClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.KafkaSchemaClass" title="datahub.metadata.schema_classes.KafkaSchemaClass"><span class="pre">KafkaSchemaClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.BinaryJsonSchemaClass" title="datahub.metadata.schema_classes.BinaryJsonSchemaClass"><span class="pre">BinaryJsonSchemaClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OrcSchemaClass" title="datahub.metadata.schema_classes.OrcSchemaClass"><span class="pre">OrcSchemaClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SchemalessClass" title="datahub.metadata.schema_classes.SchemalessClass"><span class="pre">SchemalessClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.KeyValueSchemaClass" title="datahub.metadata.schema_classes.KeyValueSchemaClass"><span class="pre">KeyValueSchemaClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OtherSchemaClass" title="datahub.metadata.schema_classes.OtherSchemaClass"><span class="pre">OtherSchemaClass</span></a></em></dt>
|
||
<dd><p>The native schema in the dataset’s platform.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.primaryKeys">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">primaryKeys</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Client provided list of fields that define primary keys to access record. Field order defines hierarchical espresso keys. Empty lists indicates absence of primary key access patter. Value is a <a class="reference external" href="mailto:SchemaField%40fieldPath">SchemaField<span>@</span>fieldPath</a>.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.schemaName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schemaName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Schema name e.g. PageViewEvent, identity.Profile, ams.account_management_tracking</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemaMetadataClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Every change to SchemaMetadata in the resource results in a new version. Version is server assigned. This version is differ from platform native schema version.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SchemalessClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SchemalessClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>The dataset has no specific schema associated with it</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SearchFieldTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass.BOOLEAN">
|
||
<span class="sig-name descname"><span class="pre">BOOLEAN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BOOLEAN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass.BROWSE_PATH">
|
||
<span class="sig-name descname"><span class="pre">BROWSE_PATH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BROWSE_PATH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass.BROWSE_PATH_V2">
|
||
<span class="sig-name descname"><span class="pre">BROWSE_PATH_V2</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BROWSE_PATH_V2'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass.COUNT">
|
||
<span class="sig-name descname"><span class="pre">COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'COUNT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass.DATETIME">
|
||
<span class="sig-name descname"><span class="pre">DATETIME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATETIME'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass.KEYWORD">
|
||
<span class="sig-name descname"><span class="pre">KEYWORD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'KEYWORD'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass.OBJECT">
|
||
<span class="sig-name descname"><span class="pre">OBJECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'OBJECT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass.TEXT">
|
||
<span class="sig-name descname"><span class="pre">TEXT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TEXT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass.TEXT_PARTIAL">
|
||
<span class="sig-name descname"><span class="pre">TEXT_PARTIAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TEXT_PARTIAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass.URN">
|
||
<span class="sig-name descname"><span class="pre">URN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'URN'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass.URN_PARTIAL">
|
||
<span class="sig-name descname"><span class="pre">URN_PARTIAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'URN_PARTIAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SearchFieldTypeClass.WORD_GRAM">
|
||
<span class="sig-name descname"><span class="pre">WORD_GRAM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'WORD_GRAM'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SerializedValueClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">blob</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contentType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schemaType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schemaRef</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Captures the serialized value of a (usually) schema-d blob.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>blob</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code>)</p></li>
|
||
<li><p><strong>contentType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.SerializedValueContentTypeClass" title="datahub.metadata.schema_classes.SerializedValueContentTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SerializedValueContentTypeClass</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>])</p></li>
|
||
<li><p><strong>schemaType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.SerializedValueSchemaTypeClass" title="datahub.metadata.schema_classes.SerializedValueSchemaTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SerializedValueSchemaTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>schemaRef</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueClass.blob">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">blob</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bytes</span></em></dt>
|
||
<dd><p>The serialized blob value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueClass.contentType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">contentType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SerializedValueContentTypeClass" title="datahub.metadata.schema_classes.SerializedValueContentTypeClass"><span class="pre">SerializedValueContentTypeClass</span></a></em></dt>
|
||
<dd><p>The content-type of the serialized blob value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueClass.schemaRef">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schemaRef</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>An optional reference to the schema that models the object.
|
||
e.g., ‘com.linkedin.pegasus2avro.platformresource.slack.SlackConversation’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueClass.schemaType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schemaType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SerializedValueSchemaTypeClass" title="datahub.metadata.schema_classes.SerializedValueSchemaTypeClass"><span class="pre">SerializedValueSchemaTypeClass</span></a></em></dt>
|
||
<dd><dl class="simple">
|
||
<dt>The schema type for the schema that models the object that was serialized</dt><dd><p>into the blob.</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Absence of this field indicates that the schema is not known.
|
||
If the schema is known, the value should be set to the appropriate schema
|
||
type.
|
||
Use the NONE value if the existing schema categories do not apply.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueContentTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SerializedValueContentTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueContentTypeClass.BINARY">
|
||
<span class="sig-name descname"><span class="pre">BINARY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BINARY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueContentTypeClass.JSON">
|
||
<span class="sig-name descname"><span class="pre">JSON</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'JSON'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueSchemaTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SerializedValueSchemaTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueSchemaTypeClass.AVRO">
|
||
<span class="sig-name descname"><span class="pre">AVRO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'AVRO'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueSchemaTypeClass.JSON">
|
||
<span class="sig-name descname"><span class="pre">JSON</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'JSON'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueSchemaTypeClass.NONE">
|
||
<span class="sig-name descname"><span class="pre">NONE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NONE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueSchemaTypeClass.PEGASUS">
|
||
<span class="sig-name descname"><span class="pre">PEGASUS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PEGASUS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueSchemaTypeClass.PROTOBUF">
|
||
<span class="sig-name descname"><span class="pre">PROTOBUF</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PROTOBUF'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SerializedValueSchemaTypeClass.THRIFT">
|
||
<span class="sig-name descname"><span class="pre">THRIFT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'THRIFT'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SiblingsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SiblingsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">siblings</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">primary</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Siblings information of an entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>siblings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>primary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SiblingsClass.primary">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">primary</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>If this is the leader entity of the set of siblings</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SiblingsClass.siblings">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">siblings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of sibling entities</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackNotificationSettingsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SlackNotificationSettingsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">userHandle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Slack Notification settings for an actor.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>userHandle</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>channels</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackNotificationSettingsClass.channels">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">channels</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Optional list of channels to send notifications to</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackNotificationSettingsClass.userHandle">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">userHandle</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Optional user handle</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SlackUserInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">slackInstance</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">realName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">displayName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">teamId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isDeleted</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isAdmin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isOwner</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isPrimaryOwner</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isBot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timezone</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timezoneOffset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">phone</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">profilePictureUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statusText</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statusEmoji</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastUpdatedSeconds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a Slack user.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>slackInstance</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>realName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>displayName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>teamId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>isDeleted</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
<li><p><strong>isAdmin</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
<li><p><strong>isOwner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
<li><p><strong>isPrimaryOwner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
<li><p><strong>isBot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
<li><p><strong>email</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>timezone</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>timezoneOffset</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>title</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>phone</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>profilePictureUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>statusText</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>statusEmoji</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>lastUpdatedSeconds</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.displayName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">displayName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The display name of the Slack member.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.email">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">email</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The email associated with the Slack member.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The unique identifier for the Slack member.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.isAdmin">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isAdmin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the member is an admin.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.isBot">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isBot</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the member is a bot.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.isDeleted">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isDeleted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the member is deleted or not.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.isOwner">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isOwner</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the member is an owner.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.isPrimaryOwner">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isPrimaryOwner</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the member is a primary owner.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.lastUpdatedSeconds">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastUpdatedSeconds</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The timestamp of when the member was last updated. (in seconds)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The username of the Slack member.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.phone">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">phone</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The phone number of the Slack member.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.profilePictureUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">profilePictureUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The URL of the member’s profile picture.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.realName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">realName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The real name of the Slack member.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.slackInstance">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">slackInstance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The dataplatform instance that this Slack member belongs to.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.statusEmoji">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">statusEmoji</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The status emoji of the Slack member.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.statusText">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">statusText</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The status text of the Slack member.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.teamId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">teamId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The ID associated with the Slack team.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.timezone">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timezone</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The timezone of the Slack member.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.timezoneOffset">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timezoneOffset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>The timezone offset of the Slack member.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SlackUserInfoClass.title">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The title of the Slack member.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SourceCodeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SourceCodeClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sourceCode</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Source Code</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>sourceCode</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.SourceCodeUrlClass" title="datahub.metadata.schema_classes.SourceCodeUrlClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceCodeUrlClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SourceCodeClass.sourceCode">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceCode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.SourceCodeUrlClass" title="datahub.metadata.schema_classes.SourceCodeUrlClass"><span class="pre">SourceCodeUrlClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Source Code along with types</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SourceCodeUrlClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SourceCodeUrlClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sourceCodeUrl</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Source Code Url Entity</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.SourceCodeUrlTypeClass" title="datahub.metadata.schema_classes.SourceCodeUrlTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceCodeUrlTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>sourceCodeUrl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SourceCodeUrlClass.sourceCodeUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceCodeUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Source Code Url</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SourceCodeUrlClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SourceCodeUrlTypeClass" title="datahub.metadata.schema_classes.SourceCodeUrlTypeClass"><span class="pre">SourceCodeUrlTypeClass</span></a></em></dt>
|
||
<dd><p>Source Code Url Types</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SourceCodeUrlTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SourceCodeUrlTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SourceCodeUrlTypeClass.EVALUATION_PIPELINE_SOURCE_CODE">
|
||
<span class="sig-name descname"><span class="pre">EVALUATION_PIPELINE_SOURCE_CODE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EVALUATION_PIPELINE_SOURCE_CODE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SourceCodeUrlTypeClass.ML_MODEL_SOURCE_CODE">
|
||
<span class="sig-name descname"><span class="pre">ML_MODEL_SOURCE_CODE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ML_MODEL_SOURCE_CODE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SourceCodeUrlTypeClass.TRAINING_PIPELINE_SOURCE_CODE">
|
||
<span class="sig-name descname"><span class="pre">TRAINING_PIPELINE_SOURCE_CODE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TRAINING_PIPELINE_SOURCE_CODE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SqlAssertionInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SqlAssertionInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entity</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statement</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">changeType</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining a SQL Assertion</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.SqlAssertionTypeClass" title="datahub.metadata.schema_classes.SqlAssertionTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">SqlAssertionTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>statement</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>operator</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdOperatorClass</span></code></a>])</p></li>
|
||
<li><p><strong>parameters</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionStdParametersClass</span></code></a>)</p></li>
|
||
<li><p><strong>changeType</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass" title="datahub.metadata.schema_classes.AssertionValueChangeTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssertionValueChangeTypeClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SqlAssertionInfoClass.changeType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">changeType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionValueChangeTypeClass" title="datahub.metadata.schema_classes.AssertionValueChangeTypeClass"><span class="pre">AssertionValueChangeTypeClass</span></a></em></dt>
|
||
<dd><p>a fixed absolute value or a relative percentage.
|
||
This value is required if the type is METRIC_CHANGE.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The type of the value used to evaluate the assertion</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SqlAssertionInfoClass.entity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The entity targeted by this SQL check.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SqlAssertionInfoClass.operator">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">operator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdOperatorClass" title="datahub.metadata.schema_classes.AssertionStdOperatorClass"><span class="pre">AssertionStdOperatorClass</span></a></em></dt>
|
||
<dd><p>The operator you’d like to apply to the result of the SQL query.</p>
|
||
<p>Note that at this time, only numeric operators are valid inputs:
|
||
GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO,
|
||
BETWEEN.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SqlAssertionInfoClass.parameters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AssertionStdParametersClass" title="datahub.metadata.schema_classes.AssertionStdParametersClass"><span class="pre">AssertionStdParametersClass</span></a></em></dt>
|
||
<dd><p>The parameters you’d like to provide as input to the operator.</p>
|
||
<p>Note that only numeric parameter types are valid inputs: NUMBER.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SqlAssertionInfoClass.statement">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">statement</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The SQL statement to be executed when evaluating the assertion (or computing the metric).
|
||
This should be a valid and complete statement, executable by itself.</p>
|
||
<p>Usually this should be a SELECT query statement.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SqlAssertionInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.SqlAssertionTypeClass" title="datahub.metadata.schema_classes.SqlAssertionTypeClass"><span class="pre">SqlAssertionTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the SQL assertion being monitored.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SqlAssertionTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SqlAssertionTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SqlAssertionTypeClass.METRIC">
|
||
<span class="sig-name descname"><span class="pre">METRIC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'METRIC'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SqlAssertionTypeClass.METRIC_CHANGE">
|
||
<span class="sig-name descname"><span class="pre">METRIC_CHANGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'METRIC_CHANGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SsoSettingsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SsoSettingsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">baseUrl</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oidcSettings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>SSO Integrations, supported on the UI.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>baseUrl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>oidcSettings</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.OidcSettingsClass" title="datahub.metadata.schema_classes.OidcSettingsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OidcSettingsClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SsoSettingsClass.baseUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">baseUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Auth base URL.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SsoSettingsClass.oidcSettings">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">oidcSettings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OidcSettingsClass" title="datahub.metadata.schema_classes.OidcSettingsClass"><span class="pre">OidcSettingsClass</span></a></em></dt>
|
||
<dd><p>Optional OIDC SSO settings.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StatusClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">StatusClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">removed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>The lifecycle status metadata of an entity, e.g. dataset, metric, feature, etc.
|
||
This aspect is used to represent soft deletes conventionally.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>removed</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StatusClass.removed">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">removed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the entity has been removed (soft-deleted).</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StringTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">StringTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>String field type.</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredExecutionReportClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">StructuredExecutionReportClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">serializedValue</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contentType</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A flexible carrier for structured results of an execution request.
|
||
The goal is to allow for free flow of structured responses from execution tasks to the orchestrator or observer.
|
||
The full spectrum of different execution report types is not intended to be modeled by this object.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>serializedValue</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>contentType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredExecutionReportClass.contentType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">contentType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The content-type of the serialized value (e.g. application/json, application/json;gzip etc.)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredExecutionReportClass.serializedValue">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">serializedValue</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The serialized value of the structured report</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredExecutionReportClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The type of the structured report. (e.g. INGESTION_REPORT, TEST_CONNECTION_REPORT, etc.)</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">StructuredPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">properties</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties about an entity governed by StructuredPropertyDefinition</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>properties</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass" title="datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructuredPropertyValueAssignmentClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertiesClass.properties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">properties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass" title="datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass"><span class="pre">StructuredPropertyValueAssignmentClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">StructuredPropertyDefinitionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">qualifiedName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valueType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entityTypes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">displayName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typeQualifier</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowedValues</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cardinality</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">searchConfiguration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">immutable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>qualifiedName</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>valueType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>entityTypes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>displayName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>typeQualifier</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]])</p></li>
|
||
<li><p><strong>allowedValues</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.PropertyValueClass" title="datahub.metadata.schema_classes.PropertyValueClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PropertyValueClass</span></code></a>]])</p></li>
|
||
<li><p><strong>cardinality</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.PropertyCardinalityClass" title="datahub.metadata.schema_classes.PropertyCardinalityClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">PropertyCardinalityClass</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>])</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>searchConfiguration</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DataHubSearchConfigClass" title="datahub.metadata.schema_classes.DataHubSearchConfigClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataHubSearchConfigClass</span></code></a>])</p></li>
|
||
<li><p><strong>immutable</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.allowedValues">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">allowedValues</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.PropertyValueClass" title="datahub.metadata.schema_classes.PropertyValueClass"><span class="pre">PropertyValueClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A list of allowed values that the property is allowed to take.
|
||
If this is not specified, then the property can take any value of given type.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.cardinality">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cardinality</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.PropertyCardinalityClass" title="datahub.metadata.schema_classes.PropertyCardinalityClass"><span class="pre">PropertyCardinalityClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The cardinality of the property. If not specified, then the property is assumed to be single valued..</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Created Audit stamp</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The description of the property. This is the description that will be shown in the UI.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.displayName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">displayName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The display name of the property. This is the name that will be shown in the UI and can be used to look up the property id.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.entityTypes">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entityTypes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.immutable">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">immutable</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the structured property value is immutable once applied to an entity.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Last Modified Audit stamp</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.qualifiedName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">qualifiedName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The fully qualified name of the property. e.g. io.acryl.datahub.myProperty</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.searchConfiguration">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">searchConfiguration</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DataHubSearchConfigClass" title="datahub.metadata.schema_classes.DataHubSearchConfigClass"><span class="pre">DataHubSearchConfigClass</span></a></em></dt>
|
||
<dd><p>Search configuration for this property. If not specified, then the property is indexed using the default mapping.
|
||
from the logical type.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.typeQualifier">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">typeQualifier</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A map that allows for type specialization of the valueType.
|
||
e.g. a valueType of <a class="reference external" href="urn:li:dataType:datahub.urn">urn:li:dataType:datahub.urn</a>
|
||
can be specialized to be a USER or GROUP URN by adding a typeQualifier like
|
||
{ “allowedTypes”: [”<a class="reference external" href="urn:li:entityType:datahub.corpuser">urn:li:entityType:datahub.corpuser</a>”, “<a class="reference external" href="urn:li:entityType:datahub.corpGroup">urn:li:entityType:datahub.corpGroup</a>”] }</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.valueType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">valueType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The value type of the property. Must be a dataType.
|
||
e.g. To indicate that the property is of type DATE, use <a class="reference external" href="urn:li:dataType:datahub.date">urn:li:dataType:datahub.date</a></p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyDefinitionClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Definition version - Allows breaking schema changes. String is compared case-insensitive and new
|
||
versions must be monotonically increasing. Cannot use periods/dots.
|
||
Suggestions: v1, v2</p>
|
||
<blockquote>
|
||
<div><p>20240610, 20240611</p>
|
||
</div></blockquote>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">StructuredPropertyKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The id for a structured proeprty.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyParamsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">StructuredPropertyParamsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyParamsClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The structured property that is required on this entity</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertySettingsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">StructuredPropertySettingsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">isHidden</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">showInSearchFilters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">showInAssetSummary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">showAsAssetBadge</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">showInColumnsTable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Settings specific to a structured property entity</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>isHidden</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>showInSearchFilters</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>showInAssetSummary</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>showAsAssetBadge</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>showInColumnsTable</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertySettingsClass.isHidden">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isHidden</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether or not this asset should be hidden in the main application</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertySettingsClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Last Modified Audit stamp</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertySettingsClass.showAsAssetBadge">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">showAsAssetBadge</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether or not this asset should be displayed as an asset badge on other
|
||
asset’s headers</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertySettingsClass.showInAssetSummary">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">showInAssetSummary</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether or not this asset should be displayed in the asset sidebar</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertySettingsClass.showInColumnsTable">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">showInColumnsTable</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether or not this asset should be displayed as a column in the schema field table
|
||
in a Dataset’s “Columns” tab.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertySettingsClass.showInSearchFilters">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">showInSearchFilters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether or not this asset should be displayed as a search filter</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">StructuredPropertyValueAssignmentClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">propertyUrn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastModified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>propertyUrn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>values</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>lastModified</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who created this relationship edge and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass.lastModified">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastModified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who last modified this relationship edge and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass.propertyUrn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">propertyUrn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The property that is being assigned a value.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.StructuredPropertyValueAssignmentClass.values">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">values</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The value assigned to the property.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SubTypesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SubTypesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">typeNames</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Sub Types. Use this aspect to specialize a generic Entity
|
||
e.g. Making a Dataset also be a View or also be a LookerExplore</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>typeNames</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SubTypesClass.typeNames">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">typeNames</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The names of the specific types.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SystemMetadataClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">SystemMetadataClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lastObserved</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastRunId</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pipelineName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">registryName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">registryVersion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">properties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Metadata associated with each metadata change that is processed by the system</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>lastObserved</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>runId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>lastRunId</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>pipelineName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>registryName</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>registryVersion</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>properties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SystemMetadataClass.lastObserved">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastObserved</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The timestamp the metadata was observed at</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SystemMetadataClass.lastRunId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastRunId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The last run id that produced the metadata. Populated in case of batch-ingestion.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SystemMetadataClass.pipelineName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pipelineName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The ingestion pipeline id that produced the metadata. Populated in case of batch ingestion.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SystemMetadataClass.properties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">properties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Additional properties</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SystemMetadataClass.registryName">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">registryName</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The model registry name that was used to process this event</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SystemMetadataClass.registryVersion">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">registryVersion</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The model registry version that was used to process this event</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SystemMetadataClass.runId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">runId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em></dt>
|
||
<dd><p>The original run id that produced the metadata. Populated in case of batch-ingestion.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.SystemMetadataClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Aspect version
|
||
Initial implementation will use the aspect version’s number, however stored as
|
||
a string in the case where a different aspect versioning scheme is later adopted.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagAssociationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TagAssociationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribution</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Properties of an applied tag. For now, just an Urn. In the future we can extend this with other properties, e.g.
|
||
propagation parameters.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>context</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>attribution</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MetadataAttributionClass" title="datahub.metadata.schema_classes.MetadataAttributionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataAttributionClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagAssociationClass.attribution">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">attribution</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MetadataAttributionClass" title="datahub.metadata.schema_classes.MetadataAttributionClass"><span class="pre">MetadataAttributionClass</span></a></em></dt>
|
||
<dd><p>Information about who, why, and how this metadata was applied</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagAssociationClass.context">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">context</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Additional context about the association</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagAssociationClass.tag">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Urn of the applied tag</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TagKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Tag</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The tag name, which serves as a unique id</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TagPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colorHex</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties associated with a Tag</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>colorHex</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagPropertiesClass.colorHex">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">colorHex</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The color associated with the Tag in Hex. For example #FFFFFF.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagPropertiesClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Documentation of the tag</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagPropertiesClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Display name of the tag</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagSnapshotClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TagSnapshotClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aspects</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A metadata snapshot for a specific dataset entity.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>urn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aspects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TagKeyClass" title="datahub.metadata.schema_classes.TagKeyClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagKeyClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnershipClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.TagPropertiesClass" title="datahub.metadata.schema_classes.TagPropertiesClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagPropertiesClass</span></code></a>, <a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatusClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagSnapshotClass.aspects">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aspects</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.TagKeyClass" title="datahub.metadata.schema_classes.TagKeyClass"><span class="pre">TagKeyClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.OwnershipClass" title="datahub.metadata.schema_classes.OwnershipClass"><span class="pre">OwnershipClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TagPropertiesClass" title="datahub.metadata.schema_classes.TagPropertiesClass"><span class="pre">TagPropertiesClass</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.StatusClass" title="datahub.metadata.schema_classes.StatusClass"><span class="pre">StatusClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>The list of metadata aspects associated with the dataset. Depending on the use case, this can either be all, or a selection, of supported aspects.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TagSnapshotClass.urn">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">urn</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URN for the entity the metadata snapshot is associated with.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TelemetryClientIdClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TelemetryClientIdClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clientId</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>A simple wrapper around a String to persist the client ID for telemetry in DataHub’s backend DB</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>clientId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TelemetryClientIdClass.clientId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clientId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A string representing the telemetry client ID</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TelemetryKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TelemetryKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for the telemetry client ID, only one should ever exist</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TelemetryKeyClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The telemetry entity name, which serves as a unique id</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestDefinitionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TestDefinitionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.TestDefinitionTypeClass" title="datahub.metadata.schema_classes.TestDefinitionTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TestDefinitionTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>json</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestDefinitionClass.json">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">json</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>JSON format configuration for the test</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestDefinitionClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TestDefinitionTypeClass" title="datahub.metadata.schema_classes.TestDefinitionTypeClass"><span class="pre">TestDefinitionTypeClass</span></a></em></dt>
|
||
<dd><p>The Test Definition Type</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestDefinitionTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TestDefinitionTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestDefinitionTypeClass.JSON">
|
||
<span class="sig-name descname"><span class="pre">JSON</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'JSON'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TestInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">definition</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a DataHub Test</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>category</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>definition</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.TestDefinitionClass" title="datahub.metadata.schema_classes.TestDefinitionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TestDefinitionClass</span></code></a>)</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestInfoClass.category">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">category</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Category of the test</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestInfoClass.definition">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TestDefinitionClass" title="datahub.metadata.schema_classes.TestDefinitionClass"><span class="pre">TestDefinitionClass</span></a></em></dt>
|
||
<dd><p>Configuration for the Test</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestInfoClass.description">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Description of the test</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestInfoClass.name">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The name of the test</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TestKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Test</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique id for the test</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestResultClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TestResultClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">test</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">testDefinitionMd5</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastComputed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Information about a Test Result</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>test</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.TestResultTypeClass" title="datahub.metadata.schema_classes.TestResultTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TestResultTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>testDefinitionMd5</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>lastComputed</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestResultClass.lastComputed">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lastComputed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>The audit stamp of when the result was computed, including the actor who computed it.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestResultClass.test">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">test</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The urn of the test</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestResultClass.testDefinitionMd5">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">testDefinitionMd5</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The md5 of the test definition that was used to compute this result.
|
||
See TestInfo.testDefinition.md5 for more information.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestResultClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TestResultTypeClass" title="datahub.metadata.schema_classes.TestResultTypeClass"><span class="pre">TestResultTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the result</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestResultTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TestResultTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestResultTypeClass.FAILURE">
|
||
<span class="sig-name descname"><span class="pre">FAILURE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FAILURE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestResultTypeClass.SUCCESS">
|
||
<span class="sig-name descname"><span class="pre">SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SUCCESS'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestResultsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TestResultsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">failing</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">passing</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a Test Result</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>failing</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TestResultClass" title="datahub.metadata.schema_classes.TestResultClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TestResultClass</span></code></a>])</p></li>
|
||
<li><p><strong>passing</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.TestResultClass" title="datahub.metadata.schema_classes.TestResultClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TestResultClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestResultsClass.failing">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">failing</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.TestResultClass" title="datahub.metadata.schema_classes.TestResultClass"><span class="pre">TestResultClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Results that are failing</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TestResultsClass.passing">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">passing</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.TestResultClass" title="datahub.metadata.schema_classes.TestResultClass"><span class="pre">TestResultClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Results that are passing</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TextCellClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TextCellClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cellId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">changeAuditStamps</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cellTitle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Text cell in a Notebook, which will present content in text format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cellId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>changeAuditStamps</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" title="datahub.metadata.schema_classes.ChangeAuditStampsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">ChangeAuditStampsClass</span></code></a>)</p></li>
|
||
<li><p><strong>text</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>cellTitle</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TextCellClass.cellId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cellId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Unique id for the cell. This id should be globally unique for a Notebook tool even when there are multiple deployments of it. As an example, Notebook URL could be used here for QueryBook such as ‘querybook.com/notebook/773/?cellId=1234’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TextCellClass.cellTitle">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cellTitle</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Title of the cell</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TextCellClass.changeAuditStamps">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">changeAuditStamps</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.ChangeAuditStampsClass" title="datahub.metadata.schema_classes.ChangeAuditStampsClass"><span class="pre">ChangeAuditStampsClass</span></a></em></dt>
|
||
<dd><p>Captures information about who created/last modified/deleted this Notebook cell and when</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TextCellClass.text">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">text</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The actual text in a TextCell in a Notebook</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TimeBasedRetentionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TimeBasedRetentionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">maxAgeInSeconds</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Keep records that are less than X seconds old</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>maxAgeInSeconds</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TimeBasedRetentionClass.maxAgeInSeconds">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maxAgeInSeconds</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TimeStampClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TimeStampClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A standard event timestamp</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>actor</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TimeStampClass.actor">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">actor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The actor urn involved in the event.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Optional</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TimeStampClass.time">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>When did the event occur</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TimeTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TimeTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Time field type. This should also be used for datetimes.</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TimeWindowClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TimeWindowClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startTimeMillis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">length</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>startTimeMillis</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>length</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeWindowSizeClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TimeWindowClass.length">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">length</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.TimeWindowSizeClass" title="datahub.metadata.schema_classes.TimeWindowSizeClass"><span class="pre">TimeWindowSizeClass</span></a></em></dt>
|
||
<dd><p>The length of the window.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TimeWindowClass.startTimeMillis">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">startTimeMillis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Start time as epoch at UTC.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TimeWindowSizeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TimeWindowSizeClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unit</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">multiple</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Defines the size of a time window.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>unit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.CalendarIntervalClass" title="datahub.metadata.schema_classes.CalendarIntervalClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">CalendarIntervalClass</span></code></a>])</p></li>
|
||
<li><p><strong>multiple</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TimeWindowSizeClass.multiple">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">multiple</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>How many units. Defaults to 1.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TimeWindowSizeClass.unit">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unit</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.CalendarIntervalClass" title="datahub.metadata.schema_classes.CalendarIntervalClass"><span class="pre">CalendarIntervalClass</span></a></em></dt>
|
||
<dd><p>Interval unit such as minute/hour/day etc.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TrainingDataClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TrainingDataClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trainingData</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Ideally, the MLModel card would contain as much information about the training data as the evaluation data. However, there might be cases where it is not feasible to provide this level of detailed information about the training data. For example, the data may be proprietary, or require a non-disclosure agreement. In these cases, we advocate for basic details about the distributions over groups in the data, as well as any other details that could inform stakeholders on the kinds of biases the model may have encoded.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>trainingData</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.BaseDataClass" title="datahub.metadata.schema_classes.BaseDataClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseDataClass</span></code></a>])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TrainingDataClass.trainingData">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">trainingData</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.BaseDataClass" title="datahub.metadata.schema_classes.BaseDataClass"><span class="pre">BaseDataClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Details on the dataset(s) used for training the MLModel</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TransformationTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">TransformationTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Type of the transformation involved in generating destination fields from source fields.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TransformationTypeClass.BLACKBOX">
|
||
<span class="sig-name descname"><span class="pre">BLACKBOX</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'BLACKBOX'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.TransformationTypeClass.IDENTITY">
|
||
<span class="sig-name descname"><span class="pre">IDENTITY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'IDENTITY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UDFTransformerClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">UDFTransformerClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">udf</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Field transformation expressed in UDF</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>udf</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UDFTransformerClass.udf">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udf</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>A UDF mentioning how the source fields got transformed to destination field. This is the FQCN(Fully Qualified Class Name) of the udf.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UnionTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">UnionTypeClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nestedTypes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Union field type.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>nestedTypes</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UnionTypeClass.nestedTypes">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">nestedTypes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of types in union type.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UpstreamClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">UpstreamClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auditStamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">properties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Upstream lineage information about a dataset including the source reporting the lineage</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dataset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.DatasetLineageTypeClass" title="datahub.metadata.schema_classes.DatasetLineageTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetLineageTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>auditStamp</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>created</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>properties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>query</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UpstreamClass.auditStamp">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auditStamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who reported the lineage and when.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UpstreamClass.created">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Audit stamp containing who created the lineage and when.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UpstreamClass.dataset">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dataset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The upstream dataset the lineage points to</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UpstreamClass.properties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">properties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>A generic properties bag that allows us to store specific information on this graph edge.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UpstreamClass.query">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">query</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>If the lineage is generated by a query, a reference to the query</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UpstreamClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetLineageTypeClass" title="datahub.metadata.schema_classes.DatasetLineageTypeClass"><span class="pre">DatasetLineageTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the lineage</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UpstreamLineageClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">UpstreamLineageClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">upstreams</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fineGrainedLineages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Upstream lineage of a dataset</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>upstreams</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.UpstreamClass" title="datahub.metadata.schema_classes.UpstreamClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpstreamClass</span></code></a>])</p></li>
|
||
<li><p><strong>fineGrainedLineages</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FineGrainedLineageClass" title="datahub.metadata.schema_classes.FineGrainedLineageClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FineGrainedLineageClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UpstreamLineageClass.fineGrainedLineages">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fineGrainedLineages</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.FineGrainedLineageClass" title="datahub.metadata.schema_classes.FineGrainedLineageClass"><span class="pre">FineGrainedLineageClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of fine-grained lineage information, including field-level lineage</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UpstreamLineageClass.upstreams">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upstreams</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.UpstreamClass" title="datahub.metadata.schema_classes.UpstreamClass"><span class="pre">UpstreamClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>List of upstream dataset lineage information</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UrnForeignKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">UrnForeignKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">currentFieldPath</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>If SchemaMetadata fields make any external references and references are of type com.linkedin.pegasus2avro.common.Urn or any children, this models can be used to mark it.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>currentFieldPath</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UrnForeignKeyClass.currentFieldPath">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">currentFieldPath</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Field in hosting(current) SchemaMetadata.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UsageAggregationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">UsageAggregationClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bucket</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">duration</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metrics</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Usage data for a given resource, rolled up into a bucket.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>bucket</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>duration</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.WindowDurationClass" title="datahub.metadata.schema_classes.WindowDurationClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowDurationClass</span></code></a>])</p></li>
|
||
<li><p><strong>resource</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>metrics</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.UsageAggregationMetricsClass" title="datahub.metadata.schema_classes.UsageAggregationMetricsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">UsageAggregationMetricsClass</span></code></a>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UsageAggregationClass.bucket">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">bucket</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Bucket start time in milliseconds</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UsageAggregationClass.duration">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">duration</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.WindowDurationClass" title="datahub.metadata.schema_classes.WindowDurationClass"><span class="pre">WindowDurationClass</span></a></em></dt>
|
||
<dd><p>Bucket duration</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UsageAggregationClass.metrics">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">metrics</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.UsageAggregationMetricsClass" title="datahub.metadata.schema_classes.UsageAggregationMetricsClass"><span class="pre">UsageAggregationMetricsClass</span></a></em></dt>
|
||
<dd><p>Metrics associated with this bucket</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UsageAggregationClass.resource">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">resource</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Resource associated with these usage stats</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UsageAggregationMetricsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">UsageAggregationMetricsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uniqueUserCount</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">users</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">totalSqlQueries</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">topSqlQueries</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fields</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Metrics for usage data for a given resource and bucket. Not all fields
|
||
make sense for all buckets, so every field is optional.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>uniqueUserCount</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>users</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.UserUsageCountsClass" title="datahub.metadata.schema_classes.UserUsageCountsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">UserUsageCountsClass</span></code></a>]])</p></li>
|
||
<li><p><strong>totalSqlQueries</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>])</p></li>
|
||
<li><p><strong>topSqlQueries</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>fields</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.FieldUsageCountsClass" title="datahub.metadata.schema_classes.FieldUsageCountsClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldUsageCountsClass</span></code></a>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UsageAggregationMetricsClass.fields">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.FieldUsageCountsClass" title="datahub.metadata.schema_classes.FieldUsageCountsClass"><span class="pre">FieldUsageCountsClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Field-level usage stats</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UsageAggregationMetricsClass.topSqlQueries">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">topSqlQueries</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Frequent SQL queries; mostly makes sense for datasets in SQL databases</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UsageAggregationMetricsClass.totalSqlQueries">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">totalSqlQueries</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Total SQL query count</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UsageAggregationMetricsClass.uniqueUserCount">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uniqueUserCount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd><p>Unique user count</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UsageAggregationMetricsClass.users">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">users</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.UserUsageCountsClass" title="datahub.metadata.schema_classes.UserUsageCountsClass"><span class="pre">UserUsageCountsClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Users within this bucket, with frequency counts</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UserUsageCountsClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">UserUsageCountsClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">userEmail</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Records a single user’s usage counts for a given resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
<li><p><strong>user</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>userEmail</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UserUsageCountsClass.count">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">count</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UserUsageCountsClass.user">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.UserUsageCountsClass.userEmail">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">userEmail</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>If user_email is set, we attempt to resolve the user’s urn upon ingest</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ValueFrequencyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ValueFrequencyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frequency</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>frequency</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ValueFrequencyClass.frequency">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">frequency</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ValueFrequencyClass.value">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionBasedRetentionClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">VersionBasedRetentionClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">maxVersions</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Keep max N latest records</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>maxVersions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionBasedRetentionClass.maxVersions">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maxVersions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">VersionInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">versionType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">externalUrl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Information about a Data processing job</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>versionType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
<li><p><strong>externalUrl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionInfoClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionInfoClass.externalUrl">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">externalUrl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>URL where the reference exist</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionInfoClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The version which can indentify a job version like a commit hash or md5 hash</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionInfoClass.versionType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">versionType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The type of the version like git hash or md5 hash</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">VersionPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">versionSet</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sortId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">versioningScheme</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sourceCreatedTimestamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadataCreatedTimestamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isLatest</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Properties about a versioned asset i.e. dataset, ML Model, etc.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>versionSet</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>version</strong> (<a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionTagClass</span></code></a>)</p></li>
|
||
<li><p><strong>sortId</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>aliases</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionTagClass</span></code></a>]])</p></li>
|
||
<li><p><strong>comment</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>versioningScheme</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.VersioningSchemeClass" title="datahub.metadata.schema_classes.VersioningSchemeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersioningSchemeClass</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code>])</p></li>
|
||
<li><p><strong>sourceCreatedTimestamp</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>metadataCreatedTimestamp</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditStampClass</span></code></a>])</p></li>
|
||
<li><p><strong>isLatest</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionPropertiesClass.aliases">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><span class="pre">VersionTagClass</span></a><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Associated aliases for this versioned asset</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionPropertiesClass.comment">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">comment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Comment documenting what this version was created for, changes, or represents</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionPropertiesClass.isLatest">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isLatest</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Marks whether this version is currently the latest. Set by a side effect and should not be modified by API.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionPropertiesClass.metadataCreatedTimestamp">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">metadataCreatedTimestamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Timestamp reflecting when the metadata for this version was created in DataHub</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionPropertiesClass.sortId">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sortId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Sort identifier that determines where a version lives in the order of the Version Set.
|
||
What this looks like depends on the Version Scheme. For sort ids generated by DataHub we use an 8 character string representation.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionPropertiesClass.sourceCreatedTimestamp">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sourceCreatedTimestamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.AuditStampClass" title="datahub.metadata.schema_classes.AuditStampClass"><span class="pre">AuditStampClass</span></a></em></dt>
|
||
<dd><p>Timestamp reflecting when this asset version was created in the source system.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionPropertiesClass.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersionTagClass" title="datahub.metadata.schema_classes.VersionTagClass"><span class="pre">VersionTagClass</span></a></em></dt>
|
||
<dd><p>Label for this versioned asset, is unique within a version set</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionPropertiesClass.versionSet">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">versionSet</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The linked Version Set entity that ties multiple versioned assets together</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionPropertiesClass.versioningScheme">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">versioningScheme</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersioningSchemeClass" title="datahub.metadata.schema_classes.VersioningSchemeClass"><span class="pre">VersioningSchemeClass</span></a></em></dt>
|
||
<dd><p>What versioning scheme <cite>sortId</cite> belongs to.
|
||
Defaults to a plain string that is lexicographically sorted.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionSetKeyClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">VersionSetKeyClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entityType</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Key for a Version Set entity</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>entityType</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionSetKeyClass.entityType">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entityType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>Type of entities included in version set, limits to a single entity type between linked versioned entities</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionSetKeyClass.id">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>ID of the Version Set, generated from platform + asset id / name</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionSetPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">VersionSetPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">latest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">versioningScheme</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customProperties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>latest</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>versioningScheme</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.VersioningSchemeClass" title="datahub.metadata.schema_classes.VersioningSchemeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersioningSchemeClass</span></code></a>])</p></li>
|
||
<li><p><strong>customProperties</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionSetPropertiesClass.customProperties">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customProperties</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||
<dd><p>Custom property bag.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionSetPropertiesClass.latest">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">latest</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The latest versioned entity linked to in this version set</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionSetPropertiesClass.versioningScheme">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">versioningScheme</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VersioningSchemeClass" title="datahub.metadata.schema_classes.VersioningSchemeClass"><span class="pre">VersioningSchemeClass</span></a></em></dt>
|
||
<dd><p>What versioning scheme is being utilized for the versioned entities sort criterion. Static once set</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionTagClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">VersionTagClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">versionTag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadataAttribution</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>A resource-defined string representing the resource state for the purpose of concurrency control</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>versionTag</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
<li><p><strong>metadataAttribution</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.MetadataAttributionClass" title="datahub.metadata.schema_classes.MetadataAttributionClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataAttributionClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionTagClass.metadataAttribution">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">metadataAttribution</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.MetadataAttributionClass" title="datahub.metadata.schema_classes.MetadataAttributionClass"><span class="pre">MetadataAttributionClass</span></a></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersionTagClass.versionTag">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">versionTag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersioningSchemeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">VersioningSchemeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersioningSchemeClass.ALPHANUMERIC_GENERATED_BY_DATAHUB">
|
||
<span class="sig-name descname"><span class="pre">ALPHANUMERIC_GENERATED_BY_DATAHUB</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ALPHANUMERIC_GENERATED_BY_DATAHUB'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VersioningSchemeClass.LEXICOGRAPHIC_STRING">
|
||
<span class="sig-name descname"><span class="pre">LEXICOGRAPHIC_STRING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LEXICOGRAPHIC_STRING'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ViewPropertiesClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">ViewPropertiesClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">materialized</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">viewLogic</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">viewLanguage</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">formattedViewLogic</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_Aspect</span></code></p>
|
||
<p>Details about a View.
|
||
e.g. Gets activated when subTypes is view</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>materialized</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>)</p></li>
|
||
<li><p><strong>viewLogic</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>viewLanguage</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>formattedViewLogic</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ViewPropertiesClass.formattedViewLogic">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">formattedViewLogic</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The formatted view logic. This is particularly used for SQL sources, where the SQL
|
||
logic is formatted for better readability, and with dbt, where this contains the
|
||
compiled SQL logic.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ViewPropertiesClass.materialized">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">materialized</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em></dt>
|
||
<dd><p>Whether the view is materialized</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ViewPropertiesClass.viewLanguage">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">viewLanguage</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The view logic language / dialect</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.ViewPropertiesClass.viewLogic">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">viewLogic</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The view logic</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionInfoClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">VolumeAssertionInfoClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entity</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rowCountTotal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rowCountChange</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incrementingSegmentRowCountTotal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incrementingSegmentRowCountChange</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DictWrapper</span></code></p>
|
||
<p>Attributes defining a dataset Volume Assertion</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#datahub.metadata.schema_classes.VolumeAssertionTypeClass" title="datahub.metadata.schema_classes.VolumeAssertionTypeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">VolumeAssertionTypeClass</span></code></a>])</p></li>
|
||
<li><p><strong>entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p></li>
|
||
<li><p><strong>rowCountTotal</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.RowCountTotalClass" title="datahub.metadata.schema_classes.RowCountTotalClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RowCountTotalClass</span></code></a>])</p></li>
|
||
<li><p><strong>rowCountChange</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.RowCountChangeClass" title="datahub.metadata.schema_classes.RowCountChangeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">RowCountChangeClass</span></code></a>])</p></li>
|
||
<li><p><strong>incrementingSegmentRowCountTotal</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass" title="datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncrementingSegmentRowCountTotalClass</span></code></a>])</p></li>
|
||
<li><p><strong>incrementingSegmentRowCountChange</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass" title="datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncrementingSegmentRowCountChangeClass</span></code></a>])</p></li>
|
||
<li><p><strong>filter</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFilterClass" title="datahub.metadata.schema_classes.DatasetFilterClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetFilterClass</span></code></a>])</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionInfoClass.entity">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">entity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em></dt>
|
||
<dd><p>The entity targeted by this Volume check.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionInfoClass.filter">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filter</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.DatasetFilterClass" title="datahub.metadata.schema_classes.DatasetFilterClass"><span class="pre">DatasetFilterClass</span></a></em></dt>
|
||
<dd><p>A definition of the specific filters that should be applied, when performing monitoring.
|
||
If not provided, there is no filter, and the full table is under consideration.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionInfoClass.incrementingSegmentRowCountChange">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">incrementingSegmentRowCountChange</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass" title="datahub.metadata.schema_classes.IncrementingSegmentRowCountChangeClass"><span class="pre">IncrementingSegmentRowCountChangeClass</span></a></em></dt>
|
||
<dd><p>Produce FAILURE Assertion Result if the asset’s incrementing segment row count delta
|
||
does not meet specific requirements. Required if type is ‘INCREMENTING_SEGMENT_ROW_COUNT_CHANGE’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionInfoClass.incrementingSegmentRowCountTotal">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">incrementingSegmentRowCountTotal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass" title="datahub.metadata.schema_classes.IncrementingSegmentRowCountTotalClass"><span class="pre">IncrementingSegmentRowCountTotalClass</span></a></em></dt>
|
||
<dd><p>Produce FAILURE Assertion Result if the asset’s latest incrementing segment row count total
|
||
does not meet specific requirements. Required if type is ‘INCREMENTING_SEGMENT_ROW_COUNT_TOTAL’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionInfoClass.rowCountChange">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rowCountChange</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.RowCountChangeClass" title="datahub.metadata.schema_classes.RowCountChangeClass"><span class="pre">RowCountChangeClass</span></a></em></dt>
|
||
<dd><p>Produce FAILURE Assertion Result if the delta row count of the asset does not meet specific requirements
|
||
within a given period of time.
|
||
Required if type is ‘ROW_COUNT_CHANGE’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionInfoClass.rowCountTotal">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rowCountTotal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.RowCountTotalClass" title="datahub.metadata.schema_classes.RowCountTotalClass"><span class="pre">RowCountTotalClass</span></a></em></dt>
|
||
<dd><p>Produce FAILURE Assertion Result if the row count of the asset does not meet specific requirements.
|
||
Required if type is ‘ROW_COUNT_TOTAL’</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionInfoClass.type">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datahub.metadata.schema_classes.VolumeAssertionTypeClass" title="datahub.metadata.schema_classes.VolumeAssertionTypeClass"><span class="pre">VolumeAssertionTypeClass</span></a></em></dt>
|
||
<dd><p>The type of the volume assertion being monitored.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionTypeClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">VolumeAssertionTypeClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionTypeClass.INCREMENTING_SEGMENT_ROW_COUNT_CHANGE">
|
||
<span class="sig-name descname"><span class="pre">INCREMENTING_SEGMENT_ROW_COUNT_CHANGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'INCREMENTING_SEGMENT_ROW_COUNT_CHANGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionTypeClass.INCREMENTING_SEGMENT_ROW_COUNT_TOTAL">
|
||
<span class="sig-name descname"><span class="pre">INCREMENTING_SEGMENT_ROW_COUNT_TOTAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'INCREMENTING_SEGMENT_ROW_COUNT_TOTAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionTypeClass.ROW_COUNT_CHANGE">
|
||
<span class="sig-name descname"><span class="pre">ROW_COUNT_CHANGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ROW_COUNT_CHANGE'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.VolumeAssertionTypeClass.ROW_COUNT_TOTAL">
|
||
<span class="sig-name descname"><span class="pre">ROW_COUNT_TOTAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ROW_COUNT_TOTAL'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.WindowDurationClass">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">WindowDurationClass</span></span></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Enum to define the length of a bucket when doing aggregations</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.WindowDurationClass.DAY">
|
||
<span class="sig-name descname"><span class="pre">DAY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DAY'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.WindowDurationClass.HOUR">
|
||
<span class="sig-name descname"><span class="pre">HOUR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'HOUR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.WindowDurationClass.MONTH">
|
||
<span class="sig-name descname"><span class="pre">MONTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MONTH'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.WindowDurationClass.WEEK">
|
||
<span class="sig-name descname"><span class="pre">WEEK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'WEEK'</span></em></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.WindowDurationClass.YEAR">
|
||
<span class="sig-name descname"><span class="pre">YEAR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'YEAR'</span></em></dt>
|
||
<dd></dd></dl>
|
||
</dd></dl>
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="datahub.metadata.schema_classes.get_schema_type">
|
||
<span class="sig-prename descclassname"><span class="pre">datahub.metadata.schema_classes.</span></span><span class="sig-name descname"><span class="pre">get_schema_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fullname</span></span></em><span class="sig-paren">)</span></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>fullname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">RecordSchema</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</section>
|
||
</article></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="slackUtm_uoBr"><div class="slackUtm_uoBr"><hr>Need more help? Join the conversation in <a href="https://datahub.com/slack?utm_source=docs&utm_medium=footer&utm_campaign=docs_footer&utm_content=python-sdk/models">Slack!</a></div></div><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/datahub-project/datahub/blob/master/versioned_docs/version-1.1.0/python-sdk/models.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_VsjB"></div></div></footer><div class="feedbackWrapper_mUHF"><div class="feedbackWidget_PX4d"><div class="feedbackButtons_wn3V"><strong>Is this page helpful?</strong><div><button class="feedbackButton_UgQs"><span role="img" aria-label="like" class="anticon anticon-like"><svg viewBox="64 64 896 896" focusable="false" data-icon="like" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 533.7c16.8-22.2 26.1-49.4 26.1-77.7 0-44.9-25.1-87.4-65.5-111.1a67.67 67.67 0 00-34.3-9.3H572.4l6-122.9c1.4-29.7-9.1-57.9-29.5-79.4A106.62 106.62 0 00471 99.9c-52 0-98 35-111.8 85.1l-85.9 311H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h601.3c9.2 0 18.2-1.8 26.5-5.4 47.6-20.3 78.3-66.8 78.3-118.4 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7-.2-12.6-2-25.1-5.6-37.1zM184 852V568h81v284h-81zm636.4-353l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 22.4-13.2 42.6-33.6 51.8H329V564.8l99.5-360.5a44.1 44.1 0 0142.2-32.3c7.6 0 15.1 2.2 21.1 6.7 9.9 7.4 15.2 18.6 14.6 30.5l-9.6 198.4h314.4C829 418.5 840 436.9 840 456c0 16.5-7.2 32.1-19.6 43z"></path></svg></span></button><button class="feedbackButton_UgQs"><span role="img" aria-label="dislike" class="anticon anticon-dislike"><svg viewBox="64 64 896 896" focusable="false" data-icon="dislike" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 490.3c3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-51.6-30.7-98.1-78.3-118.4a66.1 66.1 0 00-26.5-5.4H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h129.3l85.8 310.8C372.9 889 418.9 924 470.9 924c29.7 0 57.4-11.8 77.9-33.4 20.5-21.5 31-49.7 29.5-79.4l-6-122.9h239.9c12.1 0 23.9-3.2 34.3-9.3 40.4-23.5 65.5-66.1 65.5-111 0-28.3-9.3-55.5-26.1-77.7zM184 456V172h81v284h-81zm627.2 160.4H496.8l9.6 198.4c.6 11.9-4.7 23.1-14.6 30.5-6.1 4.5-13.6 6.8-21.1 6.7a44.28 44.28 0 01-42.2-32.3L329 459.2V172h415.4a56.85 56.85 0 0133.6 51.8c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-14 25.5 21.9 19a56.76 56.76 0 0119.6 43c0 19.1-11 37.5-28.8 48.4z"></path></svg></span></button></div></div></div></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.1.0/python-sdk/clients"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Client</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.1.0/python-sdk/urns"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">URNs</div></a></nav></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/quickstart">Quickstart</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://datahub.com/slack" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" target="_blank" rel="noopener noreferrer" class="footer__link-item">YouTube<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://medium.com/datahub-project" target="_blank" rel="noopener noreferrer" class="footer__link-item">Blog<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/townhalls">Town Halls</a></li><li class="footer__item"><a href="https://datahub.com/resources/?2004611554=dh-stories" target="_blank" rel="noopener noreferrer" class="footer__link-item">Customer Stories<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://demo.datahub.com/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Demo</a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/roadmap" target="_blank" rel="noopener noreferrer" class="footer__link-item">Roadmap<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/datahub-project/datahub" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Feature Requests<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2015-2025 DataHub Project Authors.</div></div></div></footer></div>
|
||
<script src="/assets/js/runtime~main.7bcf907e.js"></script>
|
||
<script src="/assets/js/main.99352010.js"></script>
|
||
</body>
|
||
</html> |