acryl-datahub 1.0.0rc18__py3-none-any.whl → 1.3.0.1rc9__py3-none-any.whl

datahub/metadata/schemas/DataHubFileInfo.avsc

@@ -0,0 +1,230 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubFileInfo"
+  },
+  "name": "DataHubFileInfo",
+  "namespace": "com.linkedin.pegasus2avro.file",
+  "fields": [
+    {
+      "type": {
+        "type": "record",
+        "name": "BucketStorageLocation",
+        "namespace": "com.linkedin.pegasus2avro.file",
+        "fields": [
+          {
+            "Searchable": {
+              "fieldType": "KEYWORD"
+            },
+            "type": "string",
+            "name": "storageBucket",
+            "doc": "The storage bucket this file is stored in"
+          },
+          {
+            "Searchable": {
+              "fieldType": "KEYWORD"
+            },
+            "type": "string",
+            "name": "storageKey",
+            "doc": "The key for where this file is stored inside of the given bucket"
+          }
+        ],
+        "doc": "Information where a file is stored"
+      },
+      "name": "bucketStorageLocation",
+      "doc": "Info about where a file is stored"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": "string",
+      "name": "originalFileName",
+      "doc": "The original filename as uploaded by the user"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": "string",
+      "name": "mimeType",
+      "doc": "MIME type of the file (e.g., image/png, application/pdf)"
+    },
+    {
+      "type": "long",
+      "name": "sizeInBytes",
+      "doc": "Size of the file in bytes"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "ASSET_DOCUMENTATION": "File uploaded for entity documentation"
+        },
+        "name": "FileUploadScenario",
+        "namespace": "com.linkedin.pegasus2avro.file",
+        "symbols": [
+          "ASSET_DOCUMENTATION"
+        ]
+      },
+      "name": "scenario",
+      "doc": "The scenario/context in which this file was uploaded"
+    },
+    {
+      "Relationship": {
+        "entityTypes": [
+          "dataset",
+          "chart",
+          "container",
+          "dashboard",
+          "dataFlow",
+          "dataJob",
+          "glossaryTerm",
+          "glossaryNode",
+          "mlModel",
+          "mlFeature",
+          "notebook",
+          "mlFeatureTable",
+          "mlPrimaryKey",
+          "mlModelGroup",
+          "domain",
+          "dataProduct",
+          "businessAttribute"
+        ],
+        "name": "ReferencedBy"
+      },
+      "Searchable": {
+        "fieldType": "URN"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "referencedByAsset",
+      "default": null,
+      "doc": "Optional URN of the entity this file is associated with (e.g., the dataset whose docs contain this file)",
+      "Urn": "Urn",
+      "entityTypes": [
+        "dataset",
+        "chart",
+        "container",
+        "dashboard",
+        "dataFlow",
+        "dataJob",
+        "glossaryTerm",
+        "glossaryNode",
+        "mlModel",
+        "mlFeature",
+        "notebook",
+        "mlFeatureTable",
+        "mlPrimaryKey",
+        "mlModelGroup",
+        "domain",
+        "dataProduct",
+        "businessAttribute"
+      ]
+    },
+    {
+      "Relationship": {
+        "entityTypes": [
+          "schemaField"
+        ],
+        "name": "ReferencedBy"
+      },
+      "Searchable": {
+        "fieldType": "URN"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "schemaField",
+      "default": null,
+      "doc": "The dataset schema field urn this file is referenced by",
+      "Urn": "Urn",
+      "entityTypes": [
+        "schemaField"
+      ]
+    },
+    {
+      "Searchable": {
+        "/actor": {
+          "fieldName": "createdBy",
+          "fieldType": "URN"
+        },
+        "/time": {
+          "fieldName": "createdAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": {
+        "type": "record",
+        "name": "AuditStamp",
+        "namespace": "com.linkedin.pegasus2avro.common",
+        "fields": [
+          {
+            "type": "long",
+            "name": "time",
+            "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."
+          },
+          {
+            "java": {
+              "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+            },
+            "type": "string",
+            "name": "actor",
+            "doc": "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.",
+            "Urn": "Urn"
+          },
+          {
+            "java": {
+              "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+            },
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "impersonator",
+            "default": null,
+            "doc": "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.",
+            "Urn": "Urn"
+          },
+          {
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "message",
+            "default": null,
+            "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."
+          }
+        ],
+        "doc": "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."
+      },
+      "name": "created",
+      "doc": "Timestamp when this file was created and by whom"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "contentHash",
+      "default": null,
+      "doc": "SHA-256 hash of file contents"
+    }
+  ],
+  "doc": "Information about a DataHub file - a file stored in S3 for use within DataHub platform features like documentation, home pages, and announcements."
+}

datahub/metadata/schemas/DataHubFileKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubFileKey",
+    "keyForEntity": "dataHubFile",
+    "entityCategory": "core",
+    "entityAspects": [
+      "dataHubFileInfo"
+    ]
+  },
+  "name": "DataHubFileKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "Unique id for the file."
+    }
+  ],
+  "doc": "Key for a DataHubFile"
+}

datahub/metadata/schemas/DataHubIngestionSourceKey.avsc

@@ -5,7 +5,8 @@
     "keyForEntity": "dataHubIngestionSource",
     "entityCategory": "internal",
     "entityAspects": [
-      "dataHubIngestionSourceInfo"
+      "dataHubIngestionSourceInfo",
+      "ownership"
     ]
   },
   "name": "DataHubIngestionSourceKey",

datahub/metadata/schemas/DataHubOpenAPISchemaKey.avsc

@@ -0,0 +1,22 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubOpenAPISchemaKey",
+    "keyForEntity": "dataHubOpenAPISchema",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "systemMetadata"
+    ],
+    "entityDoc": "Contains aspects which are used in OpenAPI requests/responses which are not otherwise present in the data model."
+  },
+  "name": "DataHubOpenAPISchemaKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the DataHub OpenAPI schema."
+    }
+  ],
+  "doc": "Key for a Query"
+}

datahub/metadata/schemas/DataHubPageModuleKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPageModuleKey",
+    "keyForEntity": "dataHubPageModule",
+    "entityCategory": "core",
+    "entityAspects": [
+      "dataHubPageModuleProperties"
+    ]
+  },
+  "name": "DataHubPageModuleKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "Unique id for the module."
+    }
+  ],
+  "doc": "Key for a DataHubPageModule"
+}

datahub/metadata/schemas/DataHubPageModuleProperties.avsc

@@ -0,0 +1,298 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPageModuleProperties"
+  },
+  "name": "DataHubPageModuleProperties",
+  "namespace": "com.linkedin.pegasus2avro.module",
+  "fields": [
+    {
+      "type": "string",
+      "name": "name",
+      "doc": "The display name of this module"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "ASSETS": "Module displaying the assets of parent entity",
+          "ASSET_COLLECTION": "A module with a collection of assets",
+          "CHILD_HIERARCHY": "Module displaying the hierarchy of the children of a given entity. Glossary or Domains.",
+          "DATA_PRODUCTS": "Module displaying child data products of a given domain",
+          "DOMAINS": "Module displaying the top domains",
+          "HIERARCHY": "A module displaying a hierarchy to navigate",
+          "LINK": "Link type module",
+          "OWNED_ASSETS": "Module displaying assets owned by a user",
+          "PLATFORMS": "Module displaying the platforms in an instance",
+          "RELATED_TERMS": "Module displaying the related terms of a given glossary term",
+          "RICH_TEXT": "Module containing rich text to be rendered"
+        },
+        "name": "DataHubPageModuleType",
+        "namespace": "com.linkedin.pegasus2avro.module",
+        "symbols": [
+          "LINK",
+          "RICH_TEXT",
+          "ASSET_COLLECTION",
+          "HIERARCHY",
+          "OWNED_ASSETS",
+          "DOMAINS",
+          "ASSETS",
+          "CHILD_HIERARCHY",
+          "DATA_PRODUCTS",
+          "RELATED_TERMS",
+          "PLATFORMS"
+        ],
+        "doc": "Enum containing the types of page modules that there are"
+      },
+      "name": "type",
+      "doc": "The type of this module - the purpose it serves"
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "DataHubPageModuleVisibility",
+        "namespace": "com.linkedin.pegasus2avro.module",
+        "fields": [
+          {
+            "Searchable": {
+              "fieldType": "KEYWORD"
+            },
+            "type": {
+              "type": "enum",
+              "symbolDocs": {
+                "GLOBAL": "This module is discoverable and can be used by any user on the platform",
+                "PERSONAL": "This module is used for individual use only"
+              },
+              "name": "PageModuleScope",
+              "namespace": "com.linkedin.pegasus2avro.module",
+              "symbols": [
+                "PERSONAL",
+                "GLOBAL"
+              ]
+            },
+            "name": "scope",
+            "doc": "Audit stamp for when and by whom this module was created"
+          }
+        ],
+        "doc": "Info about the visibility of this module"
+      },
+      "name": "visibility",
+      "doc": "Info about the visibility of this module"
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "DataHubPageModuleParams",
+        "namespace": "com.linkedin.pegasus2avro.module",
+        "fields": [
+          {
+            "type": [
+              "null",
+              {
+                "type": "record",
+                "name": "LinkModuleParams",
+                "namespace": "com.linkedin.pegasus2avro.module",
+                "fields": [
+                  {
+                    "type": "string",
+                    "name": "linkUrl"
+                  },
+                  {
+                    "type": [
+                      "null",
+                      "string"
+                    ],
+                    "name": "imageUrl",
+                    "default": null
+                  },
+                  {
+                    "type": [
+                      "null",
+                      "string"
+                    ],
+                    "name": "description",
+                    "default": null
+                  }
+                ]
+              }
+            ],
+            "name": "linkParams",
+            "default": null,
+            "doc": "The params required if the module is type LINK"
+          },
+          {
+            "type": [
+              "null",
+              {
+                "type": "record",
+                "name": "RichTextModuleParams",
+                "namespace": "com.linkedin.pegasus2avro.module",
+                "fields": [
+                  {
+                    "type": "string",
+                    "name": "content"
+                  }
+                ]
+              }
+            ],
+            "name": "richTextParams",
+            "default": null,
+            "doc": "The params required if the module is type RICH_TEXT"
+          },
+          {
+            "type": [
+              "null",
+              {
+                "type": "record",
+                "name": "AssetCollectionModuleParams",
+                "namespace": "com.linkedin.pegasus2avro.module",
+                "fields": [
+                  {
+                    "type": {
+                      "type": "array",
+                      "items": "string"
+                    },
+                    "name": "assetUrns",
+                    "Urn": "Urn",
+                    "urn_is_array": true
+                  },
+                  {
+                    "type": [
+                      "null",
+                      "string"
+                    ],
+                    "name": "dynamicFilterJson",
+                    "default": null,
+                    "doc": "Optional dynamic filters\n\nThe stringified json representing the logical predicate built in the UI to select assets.\nThis predicate is turned into orFilters to send through graphql since graphql doesn't support\narbitrary nesting. This string is used to restore the UI for this logical predicate."
+                  }
+                ],
+                "doc": "The params required if the module is type ASSET_COLLECTION"
+              }
+            ],
+            "name": "assetCollectionParams",
+            "default": null,
+            "doc": "The params required if the module is type ASSET_COLLECTION"
+          },
+          {
+            "type": [
+              "null",
+              {
+                "type": "record",
+                "name": "HierarchyModuleParams",
+                "namespace": "com.linkedin.pegasus2avro.module",
+                "fields": [
+                  {
+                    "type": [
+                      "null",
+                      {
+                        "type": "array",
+                        "items": "string"
+                      }
+                    ],
+                    "name": "assetUrns",
+                    "default": null,
+                    "Urn": "Urn",
+                    "urn_is_array": true
+                  },
+                  {
+                    "type": "boolean",
+                    "name": "showRelatedEntities"
+                  },
+                  {
+                    "type": [
+                      "null",
+                      "string"
+                    ],
+                    "name": "relatedEntitiesFilterJson",
+                    "default": null,
+                    "doc": "Optional filters to filter relatedEntities (assetUrns) out\n\nThe stringified json representing the logical predicate built in the UI to select assets.\nThis predicate is turned into orFilters to send through graphql since graphql doesn't support\narbitrary nesting. This string is used to restore the UI for this logical predicate."
+                  }
+                ],
+                "doc": "The params required if the module is type HIERARCHY_VIEW"
+              }
+            ],
+            "name": "hierarchyViewParams",
+            "default": null,
+            "doc": "The params required if the module is type HIERARCHY_VIEW"
+          }
+        ],
+        "doc": "The specific parameters stored for a module"
+      },
+      "name": "params",
+      "doc": "The specific parameters stored for this module"
+    },
+    {
+      "Searchable": {
+        "/actor": {
+          "fieldName": "createdBy",
+          "fieldType": "URN"
+        },
+        "/time": {
+          "fieldName": "createdAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": {
+        "type": "record",
+        "name": "AuditStamp",
+        "namespace": "com.linkedin.pegasus2avro.common",
+        "fields": [
+          {
+            "type": "long",
+            "name": "time",
+            "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."
+          },
+          {
+            "java": {
+              "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+            },
+            "type": "string",
+            "name": "actor",
+            "doc": "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.",
+            "Urn": "Urn"
+          },
+          {
+            "java": {
+              "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+            },
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "impersonator",
+            "default": null,
+            "doc": "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.",
+            "Urn": "Urn"
+          },
+          {
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "message",
+            "default": null,
+            "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."
+          }
+        ],
+        "doc": "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."
+      },
+      "name": "created",
+      "doc": "Audit stamp for when and by whom this template was created"
+    },
+    {
+      "Searchable": {
+        "/time": {
+          "fieldName": "lastModifiedAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": "com.linkedin.pegasus2avro.common.AuditStamp",
+      "name": "lastModified",
+      "doc": "Audit stamp for when and by whom this template was last updated"
+    }
+  ],
+  "doc": "The main properties of a DataHub page module"
+}

datahub/metadata/schemas/DataHubPageTemplateKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPageTemplateKey",
+    "keyForEntity": "dataHubPageTemplate",
+    "entityCategory": "core",
+    "entityAspects": [
+      "dataHubPageTemplateProperties"
+    ]
+  },
+  "name": "DataHubPageTemplateKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "Unique id for the template."
+    }
+  ],
+  "doc": "Key for a DataHubPageTemplate"
+}