acryl-datahub-cloud 0.3.8rc7__py3-none-any.whl → 0.3.8rc9__py3-none-any.whl

acryl_datahub_cloud/metadata/schemas/PostInfo.avsc

@@ -0,0 +1,262 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "postInfo"
+  },
+  "name": "PostInfo",
+  "namespace": "com.linkedin.pegasus2avro.post",
+  "fields": [
+    {
+      "Searchable": {},
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "ENTITY_ANNOUNCEMENT": "The Post is an Entity level announcement.",
+          "HOME_PAGE_ANNOUNCEMENT": "The Post is an Home Page announcement."
+        },
+        "name": "PostType",
+        "namespace": "com.linkedin.pegasus2avro.post",
+        "symbols": [
+          "HOME_PAGE_ANNOUNCEMENT",
+          "ENTITY_ANNOUNCEMENT"
+        ],
+        "doc": "Enum defining types of Posts."
+      },
+      "name": "type",
+      "doc": "Type of the Post."
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "PostContent",
+        "namespace": "com.linkedin.pegasus2avro.post",
+        "fields": [
+          {
+            "Searchable": {
+              "fieldType": "TEXT_PARTIAL"
+            },
+            "type": "string",
+            "name": "title",
+            "doc": "Title of the post."
+          },
+          {
+            "type": {
+              "type": "enum",
+              "symbolDocs": {
+                "LINK": "Link content",
+                "TEXT": "Text content"
+              },
+              "name": "PostContentType",
+              "namespace": "com.linkedin.pegasus2avro.post",
+              "symbols": [
+                "TEXT",
+                "LINK"
+              ],
+              "doc": "Enum defining the type of content held in a Post."
+            },
+            "name": "type",
+            "doc": "Type of content held in the post."
+          },
+          {
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "description",
+            "default": null,
+            "doc": "Optional description of the post."
+          },
+          {
+            "java": {
+              "class": "com.linkedin.pegasus2avro.common.url.Url",
+              "coercerClass": "com.linkedin.pegasus2avro.common.url.UrlCoercer"
+            },
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "link",
+            "default": null,
+            "doc": "Optional link that the post is associated with."
+          },
+          {
+            "type": [
+              "null",
+              {
+                "type": "record",
+                "name": "Media",
+                "namespace": "com.linkedin.pegasus2avro.common",
+                "fields": [
+                  {
+                    "type": {
+                      "type": "enum",
+                      "symbolDocs": {
+                        "IMAGE": "The Media holds an image."
+                      },
+                      "name": "MediaType",
+                      "namespace": "com.linkedin.pegasus2avro.common",
+                      "symbols": [
+                        "IMAGE"
+                      ],
+                      "doc": "Enum defining the type of content a Media object holds."
+                    },
+                    "name": "type",
+                    "doc": "Type of content the Media is storing, e.g. image, video, etc."
+                  },
+                  {
+                    "java": {
+                      "class": "com.linkedin.pegasus2avro.common.url.Url",
+                      "coercerClass": "com.linkedin.pegasus2avro.common.url.UrlCoercer"
+                    },
+                    "type": "string",
+                    "name": "location",
+                    "doc": "Where the media content is stored."
+                  }
+                ],
+                "doc": "Carries information about which roles a user is assigned to."
+              }
+            ],
+            "name": "media",
+            "default": null,
+            "doc": "Optional media that the post is storing"
+          }
+        ],
+        "doc": "Content stored inside a Post."
+      },
+      "name": "content",
+      "doc": "Content stored in the post."
+    },
+    {
+      "Searchable": {
+        "fieldType": "COUNT"
+      },
+      "type": "long",
+      "name": "created",
+      "doc": "The time at which the post was initially created"
+    },
+    {
+      "Searchable": {
+        "fieldType": "COUNT"
+      },
+      "type": "long",
+      "name": "lastModified",
+      "doc": "The time at which the post was last modified"
+    },
+    {
+      "Searchable": {
+        "/time": {
+          "fieldName": "created",
+          "fieldType": "COUNT"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "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": "auditStamp",
+      "default": null,
+      "doc": "The audit stamp at which the request was last updated"
+    },
+    {
+      "Relationship": {
+        "entityTypes": [
+          "dataset",
+          "schemaField",
+          "chart",
+          "container",
+          "dashboard",
+          "dataFlow",
+          "dataJob",
+          "dataProduct",
+          "glossaryTerm",
+          "glossaryNode",
+          "mlModel",
+          "mlFeature",
+          "notebook",
+          "mlFeatureTable",
+          "mlPrimaryKey",
+          "mlModelGroup",
+          "domain",
+          "dataProduct"
+        ],
+        "name": "PostTarget"
+      },
+      "Searchable": {},
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "target",
+      "default": null,
+      "doc": "Optional Entity URN that the post is associated with.",
+      "Urn": "Urn",
+      "entityTypes": [
+        "dataset",
+        "schemaField",
+        "chart",
+        "container",
+        "dashboard",
+        "dataFlow",
+        "dataJob",
+        "dataProduct",
+        "glossaryTerm",
+        "glossaryNode",
+        "mlModel",
+        "mlFeature",
+        "notebook",
+        "mlFeatureTable",
+        "mlPrimaryKey",
+        "mlModelGroup",
+        "domain",
+        "dataProduct"
+      ]
+    }
+  ],
+  "doc": "Information about a DataHub Post."
+}

acryl_datahub_cloud/metadata/schemas/PostKey.avsc

@@ -0,0 +1,22 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "postKey",
+    "keyForEntity": "post",
+    "entityCategory": "core",
+    "entityAspects": [
+      "postInfo",
+      "status"
+    ]
+  },
+  "name": "PostKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the DataHub Post record. Generated on the server side at Post creation time."
+    }
+  ],
+  "doc": "Key for a Post."
+}

acryl_datahub_cloud/metadata/schemas/Proposals.avsc

@@ -0,0 +1,53 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "proposals"
+  },
+  "name": "Proposals",
+  "namespace": "com.linkedin.pegasus2avro.common",
+  "fields": [
+    {
+      "Searchable": {
+        "/*": {
+          "fieldName": "proposedTags",
+          "fieldType": "URN",
+          "filterNameOverride": "Proposed Tag"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "proposedTags",
+      "default": null,
+      "doc": "Proposed tags for a given entity",
+      "Urn": "Urn",
+      "urn_is_array": true
+    },
+    {
+      "Searchable": {
+        "/*": {
+          "fieldName": "proposedGlossaryTerms",
+          "fieldType": "URN",
+          "filterNameOverride": "Proposed Glossary Term"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "proposedGlossaryTerms",
+      "default": null,
+      "doc": "Proposed glossary terms for a given entity",
+      "Urn": "Urn",
+      "urn_is_array": true
+    }
+  ],
+  "doc": "Proposals aspect for proposed tags and glossary terms for an entity.\nThese are secondary indices and ActionRequests remain the source of truth."
+}

acryl_datahub_cloud/metadata/schemas/QuantitativeAnalyses.avsc

@@ -0,0 +1,29 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "mlModelQuantitativeAnalyses"
+  },
+  "name": "QuantitativeAnalyses",
+  "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+  "fields": [
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "unitaryResults",
+      "default": null,
+      "doc": "Link to a dashboard with results showing how the MLModel performed with respect to each factor"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "intersectionalResults",
+      "default": null,
+      "doc": "Link to a dashboard with results showing how the MLModel performed with respect to the intersection of evaluated factors?"
+    }
+  ],
+  "doc": "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."
+}

acryl_datahub_cloud/metadata/schemas/QueryKey.avsc

@@ -0,0 +1,28 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "queryKey",
+    "keyForEntity": "query",
+    "entityCategory": "core",
+    "entityAspects": [
+      "queryProperties",
+      "querySubjects",
+      "queryUsageStatistics",
+      "status",
+      "dataPlatformInstance",
+      "subTypes",
+      "queryUsageFeatures",
+      "lineageFeatures"
+    ]
+  },
+  "name": "QueryKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the Query."
+    }
+  ],
+  "doc": "Key for a Query"
+}

acryl_datahub_cloud/metadata/schemas/QueryProperties.avsc

@@ -0,0 +1,171 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "queryProperties"
+  },
+  "name": "QueryProperties",
+  "namespace": "com.linkedin.pegasus2avro.query",
+  "fields": [
+    {
+      "type": {
+        "type": "record",
+        "name": "QueryStatement",
+        "namespace": "com.linkedin.pegasus2avro.query",
+        "fields": [
+          {
+            "type": "string",
+            "name": "value",
+            "doc": "The query text"
+          },
+          {
+            "type": {
+              "type": "enum",
+              "symbolDocs": {
+                "SQL": "A SQL Query"
+              },
+              "name": "QueryLanguage",
+              "namespace": "com.linkedin.pegasus2avro.query",
+              "symbols": [
+                "SQL"
+              ]
+            },
+            "name": "language",
+            "default": "SQL",
+            "doc": "The language of the Query, e.g. SQL."
+          }
+        ],
+        "doc": "A query statement against one or more data assets."
+      },
+      "name": "statement",
+      "doc": "The Query Statement."
+    },
+    {
+      "Searchable": {},
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "MANUAL": "The query was entered manually by a user (via the UI).",
+          "SYSTEM": "The query was discovered by a crawler."
+        },
+        "name": "QuerySource",
+        "namespace": "com.linkedin.pegasus2avro.query",
+        "symbols": [
+          "MANUAL",
+          "SYSTEM"
+        ]
+      },
+      "name": "source",
+      "doc": "The source of the Query"
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldType": "WORD_GRAM"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "name",
+      "default": null,
+      "doc": "Optional display name to identify the query."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "The Query description."
+    },
+    {
+      "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 capturing the time and actor who created the Query."
+    },
+    {
+      "Searchable": {
+        "/actor": {
+          "fieldName": "lastModifiedBy",
+          "fieldType": "URN"
+        },
+        "/time": {
+          "fieldName": "lastModifiedAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": "com.linkedin.pegasus2avro.common.AuditStamp",
+      "name": "lastModified",
+      "doc": "Audit stamp capturing the time and actor who last modified the Query."
+    },
+    {
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "origin",
+      "default": null,
+      "doc": "The origin of the Query.\nThis is the source of the Query (e.g. a View, Stored Procedure, dbt Model, etc.) that the Query was created from.",
+      "Urn": "Urn"
+    }
+  ],
+  "doc": "Information about a Query against one or more data assets (e.g. Tables or Views)."
+}

acryl_datahub_cloud/metadata/schemas/QuerySubjects.avsc

@@ -0,0 +1,50 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "querySubjects"
+  },
+  "name": "QuerySubjects",
+  "namespace": "com.linkedin.pegasus2avro.query",
+  "fields": [
+    {
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "QuerySubject",
+          "namespace": "com.linkedin.pegasus2avro.query",
+          "fields": [
+            {
+              "Relationship": {
+                "entityTypes": [
+                  "dataset",
+                  "schemaField"
+                ],
+                "name": "IsAssociatedWith"
+              },
+              "Searchable": {
+                "fieldName": "entities",
+                "fieldType": "URN"
+              },
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": "string",
+              "name": "entity",
+              "doc": "An entity which is the subject of a query.",
+              "Urn": "Urn",
+              "entityTypes": [
+                "dataset",
+                "schemaField"
+              ]
+            }
+          ],
+          "doc": "A single subject of a particular query.\nIn the future, we may evolve this model to include richer details\nabout the Query Subject in relation to the query."
+        }
+      },
+      "name": "subjects",
+      "doc": "One or more subjects of the query.\n\nIn single-asset queries (e.g. table select), this will contain the Table reference\nand optionally schema field references.\n\nIn multi-asset queries (e.g. table joins), this may contain multiple Table references\nand optionally schema field references."
+    }
+  ],
+  "doc": "Information about the subjects of a particular Query, i.e. the assets\nbeing queried."
+}