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

acryl_datahub_cloud/metadata/schemas/DashboardInfo.avsc

@@ -0,0 +1,403 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dashboardInfo"
+  },
+  "name": "DashboardInfo",
+  "namespace": "com.linkedin.pegasus2avro.dashboard",
+  "fields": [
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT",
+          "queryByDefault": true
+        }
+      },
+      "type": {
+        "type": "map",
+        "values": "string"
+      },
+      "name": "customProperties",
+      "default": {},
+      "doc": "Custom property bag."
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.url.Url",
+        "coercerClass": "com.linkedin.pegasus2avro.common.url.UrlCoercer"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "externalUrl",
+      "default": null,
+      "doc": "URL where the reference exist"
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "title",
+      "doc": "Title of the dashboard"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT",
+        "hasValuesFieldName": "hasDescription"
+      },
+      "type": "string",
+      "name": "description",
+      "doc": "Detailed description about the dashboard"
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "chart"
+          ],
+          "isLineage": true,
+          "name": "Contains"
+        }
+      },
+      "deprecated": true,
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "charts",
+      "default": [],
+      "doc": "Charts in a dashboard\nDeprecated! Use chartEdges instead.",
+      "Urn": "ChartUrn",
+      "urn_is_array": true
+    },
+    {
+      "Relationship": {
+        "/*/destinationUrn": {
+          "createdActor": "chartEdges/*/created/actor",
+          "createdOn": "chartEdges/*/created/time",
+          "entityTypes": [
+            "chart"
+          ],
+          "isLineage": true,
+          "name": "Contains",
+          "properties": "chartEdges/*/properties",
+          "updatedActor": "chartEdges/*/lastModified/actor",
+          "updatedOn": "chartEdges/*/lastModified/time"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": {
+            "type": "record",
+            "name": "Edge",
+            "namespace": "com.linkedin.pegasus2avro.common",
+            "fields": [
+              {
+                "java": {
+                  "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                },
+                "type": [
+                  "null",
+                  "string"
+                ],
+                "name": "sourceUrn",
+                "default": null,
+                "doc": "Urn of the source of this relationship edge.\nIf not specified, assumed to be the entity that this aspect belongs to.",
+                "Urn": "Urn"
+              },
+              {
+                "java": {
+                  "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                },
+                "type": "string",
+                "name": "destinationUrn",
+                "doc": "Urn of the destination of this relationship edge.",
+                "Urn": "Urn"
+              },
+              {
+                "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": "created",
+                "default": null,
+                "doc": "Audit stamp containing who created this relationship edge and when"
+              },
+              {
+                "type": [
+                  "null",
+                  "com.linkedin.pegasus2avro.common.AuditStamp"
+                ],
+                "name": "lastModified",
+                "default": null,
+                "doc": "Audit stamp containing who last modified this relationship edge and when"
+              },
+              {
+                "type": [
+                  "null",
+                  {
+                    "type": "map",
+                    "values": "string"
+                  }
+                ],
+                "name": "properties",
+                "default": null,
+                "doc": "A generic properties bag that allows us to store specific information on this graph edge."
+              }
+            ],
+            "doc": "A common structure to represent all edges to entities when used inside aspects as collections\nThis ensures that all edges have common structure around audit-stamps and will support PATCH, time-travel automatically."
+          }
+        }
+      ],
+      "name": "chartEdges",
+      "default": null,
+      "doc": "Charts in a dashboard"
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "dataset"
+          ],
+          "isLineage": true,
+          "name": "Consumes"
+        }
+      },
+      "deprecated": true,
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "datasets",
+      "default": [],
+      "doc": "Datasets consumed by a dashboard\nDeprecated! Use datasetEdges instead.",
+      "Urn": "Urn",
+      "urn_is_array": true
+    },
+    {
+      "Relationship": {
+        "/*/destinationUrn": {
+          "createdActor": "datasetEdges/*/created/actor",
+          "createdOn": "datasetEdges/*/created/time",
+          "entityTypes": [
+            "dataset"
+          ],
+          "isLineage": true,
+          "name": "Consumes",
+          "properties": "datasetEdges/*/properties",
+          "updatedActor": "datasetEdges/*/lastModified/actor",
+          "updatedOn": "datasetEdges/*/lastModified/time"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "com.linkedin.pegasus2avro.common.Edge"
+        }
+      ],
+      "name": "datasetEdges",
+      "default": null,
+      "doc": "Datasets consumed by a dashboard"
+    },
+    {
+      "Relationship": {
+        "/*/destinationUrn": {
+          "createdActor": "datasetEdges/*/created/actor",
+          "createdOn": "datasetEdges/*/created/time",
+          "entityTypes": [
+            "dashboard"
+          ],
+          "isLineage": true,
+          "name": "DashboardContainsDashboard",
+          "properties": "datasetEdges/*/properties",
+          "updatedActor": "datasetEdges/*/lastModified/actor",
+          "updatedOn": "datasetEdges/*/lastModified/time"
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": "com.linkedin.pegasus2avro.common.Edge"
+      },
+      "name": "dashboards",
+      "default": [],
+      "doc": "Dashboards included by this dashboard.\nSome dashboard entities (e.g. PowerBI Apps) can contain other dashboards.\n\nThe Edge's sourceUrn should never be set, as it will always be the base dashboard."
+    },
+    {
+      "Searchable": {
+        "/lastModified/time": {
+          "fieldName": "lastModifiedAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": {
+        "type": "record",
+        "name": "ChangeAuditStamps",
+        "namespace": "com.linkedin.pegasus2avro.common",
+        "fields": [
+          {
+            "type": "com.linkedin.pegasus2avro.common.AuditStamp",
+            "name": "created",
+            "default": {
+              "actor": "urn:li:corpuser:unknown",
+              "impersonator": null,
+              "time": 0,
+              "message": null
+            },
+            "doc": "An AuditStamp corresponding to the creation of this resource/association/sub-resource. A value of 0 for time indicates missing data."
+          },
+          {
+            "type": "com.linkedin.pegasus2avro.common.AuditStamp",
+            "name": "lastModified",
+            "default": {
+              "actor": "urn:li:corpuser:unknown",
+              "impersonator": null,
+              "time": 0,
+              "message": null
+            },
+            "doc": "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."
+          },
+          {
+            "type": [
+              "null",
+              "com.linkedin.pegasus2avro.common.AuditStamp"
+            ],
+            "name": "deleted",
+            "default": null,
+            "doc": "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."
+          }
+        ],
+        "doc": "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 https://github.com/linkedin/rest.li/wiki/Validation-in-Rest.li#restli-validation-annotations"
+      },
+      "name": "lastModified",
+      "doc": "Captures information about who created/last modified/deleted this dashboard and when"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.url.Url",
+        "coercerClass": "com.linkedin.pegasus2avro.common.url.UrlCoercer"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "dashboardUrl",
+      "default": null,
+      "doc": "URL for the dashboard. This could be used as an external link on DataHub to allow users access/view the dashboard"
+    },
+    {
+      "Searchable": {
+        "addToFilters": true,
+        "fieldType": "KEYWORD",
+        "filterNameOverride": "Access Level"
+      },
+      "type": [
+        "null",
+        {
+          "type": "enum",
+          "symbolDocs": {
+            "PRIVATE": "Private availability to certain set of users",
+            "PUBLIC": "Publicly available access level"
+          },
+          "name": "AccessLevel",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "symbols": [
+            "PUBLIC",
+            "PRIVATE"
+          ],
+          "doc": "The various access levels"
+        }
+      ],
+      "name": "access",
+      "default": null,
+      "doc": "Access level for the dashboard"
+    },
+    {
+      "Searchable": {
+        "queryByDefault": false
+      },
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "lastRefreshed",
+      "default": null,
+      "doc": "The time when this dashboard last refreshed"
+    },
+    {
+      "Searchable": {
+        "queryByDefault": false
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "lastRefreshedBy",
+      "default": null,
+      "doc": "The actor who last refreshed this dashboard",
+      "Urn": "Urn"
+    }
+  ],
+  "doc": "Information about a dashboard"
+}

acryl_datahub_cloud/metadata/schemas/DashboardKey.avsc

@@ -0,0 +1,57 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dashboardKey",
+    "keyForEntity": "dashboard",
+    "entityCategory": "_unset_",
+    "entityAspects": [
+      "domains",
+      "container",
+      "deprecation",
+      "dashboardUsageStatistics",
+      "inputFields",
+      "usageFeatures",
+      "lineageFeatures",
+      "subTypes",
+      "embed",
+      "proposals",
+      "dashboardInfo",
+      "editableDashboardProperties",
+      "ownership",
+      "status",
+      "globalTags",
+      "browsePaths",
+      "glossaryTerms",
+      "institutionalMemory",
+      "dataPlatformInstance",
+      "browsePathsV2",
+      "structuredProperties",
+      "incidentsSummary",
+      "forms",
+      "testResults",
+      "share",
+      "origin",
+      "documentation"
+    ]
+  },
+  "name": "DashboardKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "Searchable": {
+        "boostScore": 4.0,
+        "fieldName": "tool",
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": "string",
+      "name": "dashboardTool",
+      "doc": "The name of the dashboard tool such as looker, redash etc."
+    },
+    {
+      "type": "string",
+      "name": "dashboardId",
+      "doc": "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'"
+    }
+  ],
+  "doc": "Key for a Dashboard"
+}