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

acryl_datahub_cloud/metadata/schemas/InstitutionalMemory.avsc

@@ -0,0 +1,88 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "institutionalMemory"
+  },
+  "name": "InstitutionalMemory",
+  "namespace": "com.linkedin.pegasus2avro.common",
+  "fields": [
+    {
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "InstitutionalMemoryMetadata",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.url.Url",
+                "coercerClass": "com.linkedin.pegasus2avro.common.url.UrlCoercer"
+              },
+              "type": "string",
+              "name": "url",
+              "doc": "Link to an engineering design document or a wiki page."
+            },
+            {
+              "type": "string",
+              "name": "description",
+              "doc": "Description of the link."
+            },
+            {
+              "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": "createStamp",
+              "doc": "Audit stamp associated with creation of this record"
+            }
+          ],
+          "doc": "Metadata corresponding to a record of institutional memory."
+        }
+      },
+      "name": "elements",
+      "doc": "List of records that represent institutional memory of an entity. Each record consists of a link, description, creator and timestamps associated with that record."
+    }
+  ],
+  "doc": "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."
+}

acryl_datahub_cloud/metadata/schemas/IntendedUse.avsc

@@ -0,0 +1,56 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "intendedUse"
+  },
+  "name": "IntendedUse",
+  "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+  "fields": [
+    {
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "primaryUses",
+      "default": null,
+      "doc": "Primary Use cases for the MLModel."
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": {
+            "type": "enum",
+            "name": "IntendedUserType",
+            "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+            "symbols": [
+              "ENTERPRISE",
+              "HOBBY",
+              "ENTERTAINMENT"
+            ]
+          }
+        }
+      ],
+      "name": "primaryUsers",
+      "default": null,
+      "doc": "Primary Intended Users - For example, was the MLModel developed for entertainment purposes, for hobbyists, or enterprise solutions?"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "outOfScopeUses",
+      "default": null,
+      "doc": "Highlight technology that the MLModel might easily be confused with, or related contexts that users could try to apply the MLModel to."
+    }
+  ],
+  "doc": "Intended Use for the ML Model"
+}

acryl_datahub_cloud/metadata/schemas/InviteToken.avsc

@@ -0,0 +1,34 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "inviteToken"
+  },
+  "name": "InviteToken",
+  "namespace": "com.linkedin.pegasus2avro.identity",
+  "fields": [
+    {
+      "type": "string",
+      "name": "token",
+      "doc": "The encrypted invite token."
+    },
+    {
+      "Searchable": {
+        "fieldName": "role",
+        "fieldType": "KEYWORD",
+        "hasValuesFieldName": "hasRole"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "role",
+      "default": null,
+      "doc": "The role that this invite token may be associated with",
+      "Urn": "Urn"
+    }
+  ],
+  "doc": "Aspect used to store invite tokens."
+}

acryl_datahub_cloud/metadata/schemas/InviteTokenKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "inviteTokenKey",
+    "keyForEntity": "inviteToken",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "inviteToken"
+    ]
+  },
+  "name": "InviteTokenKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the invite token."
+    }
+  ],
+  "doc": "Key for an InviteToken."
+}

acryl_datahub_cloud/metadata/schemas/LineageFeatures.avsc

@@ -0,0 +1,76 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "lineageFeatures"
+  },
+  "name": "LineageFeatures",
+  "namespace": "com.linkedin.pegasus2avro.metadata.search.features",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldName": "upstreamCountFeature",
+        "fieldType": "COUNT"
+      },
+      "type": "int",
+      "name": "upstreamCount",
+      "doc": "Cached number of entities related by lineage, upstream."
+    },
+    {
+      "Searchable": {
+        "fieldName": "downstreamCountFeature",
+        "fieldType": "COUNT"
+      },
+      "type": "int",
+      "name": "downstreamCount",
+      "doc": "Cached number of entities related by lineage, downstream."
+    },
+    {
+      "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": "computedAt",
+      "doc": "Record of when and how lineage features were computed."
+    }
+  ]
+}

acryl_datahub_cloud/metadata/schemas/LinkPreviewInfo.avsc

@@ -0,0 +1,38 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "linkPreviewInfo"
+  },
+  "name": "LinkPreviewInfo",
+  "namespace": "com.linkedin.pegasus2avro.link",
+  "fields": [
+    {
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "SLACK_MESSAGE": "Preview of a Slack Message",
+          "TEAMS_MESSAGE": "Preview of a Microsoft Teams Message"
+        },
+        "name": "LinkPreviewType",
+        "namespace": "com.linkedin.pegasus2avro.link",
+        "symbols": [
+          "SLACK_MESSAGE",
+          "TEAMS_MESSAGE"
+        ]
+      },
+      "name": "type",
+      "doc": "The type of the Link Preview"
+    },
+    {
+      "type": "string",
+      "name": "json",
+      "doc": "The JSON-encoded preview. Understood and rendered by DataHub UI."
+    },
+    {
+      "type": "long",
+      "name": "lastRefreshedMs",
+      "doc": "The time at which the preview was last refreshed."
+    }
+  ],
+  "doc": "Information about a Link Preview"
+}

acryl_datahub_cloud/metadata/schemas/LinkPreviewKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "linkPreviewKey",
+    "keyForEntity": "linkPreview",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "linkPreviewInfo"
+    ]
+  },
+  "name": "LinkPreviewKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the Link Preview, derived by encoding the URL itself."
+    }
+  ],
+  "doc": "Key for an Link Preview"
+}

acryl_datahub_cloud/metadata/schemas/MLFeatureKey.avsc

@@ -0,0 +1,57 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "mlFeatureKey",
+    "keyForEntity": "mlFeature",
+    "entityCategory": "core",
+    "entityAspects": [
+      "glossaryTerms",
+      "editableMlFeatureProperties",
+      "domains",
+      "proposals",
+      "mlFeatureProperties",
+      "ownership",
+      "institutionalMemory",
+      "status",
+      "deprecation",
+      "browsePaths",
+      "globalTags",
+      "dataPlatformInstance",
+      "browsePathsV2",
+      "structuredProperties",
+      "forms",
+      "testResults",
+      "share",
+      "origin",
+      "lineageFeatures",
+      "documentation",
+      "incidentsSummary"
+    ]
+  },
+  "name": "MLFeatureKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": "string",
+      "name": "featureNamespace",
+      "doc": "Namespace for the feature"
+    },
+    {
+      "Searchable": {
+        "boostScore": 8.0,
+        "enableAutocomplete": true,
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "Name of the feature"
+    }
+  ],
+  "doc": "Key for an MLFeature"
+}

acryl_datahub_cloud/metadata/schemas/MLFeatureProperties.avsc

@@ -0,0 +1,189 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "mlFeatureProperties"
+  },
+  "name": "MLFeatureProperties",
+  "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+  "fields": [
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT",
+          "queryByDefault": true
+        }
+      },
+      "type": {
+        "type": "map",
+        "values": "string"
+      },
+      "name": "customProperties",
+      "default": {},
+      "doc": "Custom property bag."
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT",
+        "hasValuesFieldName": "hasDescription"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "Documentation of the MLFeature"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "enum",
+          "symbolDocs": {
+            "AUDIO": "Audio Data",
+            "BINARY": "Binary data is discrete data that can be in only one of two categories - either yes or no, 1 or 0, off or on, etc",
+            "BYTE": "Bytes data are binary-encoded values that can represent complex objects.",
+            "CONTINUOUS": "Continuous data are made of uncountable values, often the result of a measurement such as height, weight, age etc.",
+            "COUNT": "Count data is discrete whole number data - no negative numbers here.\nCount data often has many small values, such as zero and one.",
+            "IMAGE": "Image Data",
+            "INTERVAL": "Interval data has equal spaces between the numbers and does not represent a temporal pattern.\nExamples include percentages, temperatures, and income.",
+            "MAP": "Mapping Data Type ex: dict, map",
+            "NOMINAL": "Nominal data is made of discrete values with no numerical relationship between the different categories - mean and median are meaningless.\nAnimal species is one example. For example, pig is not higher than bird and lower than fish.",
+            "ORDINAL": "Ordinal data are discrete integers that can be ranked or sorted.\nFor example, the distance between first and second may not be the same as the distance between second and third.",
+            "SEQUENCE": "Sequence Data Type ex: list, tuple, range",
+            "SET": "Set Data Type ex: set, frozenset",
+            "TEXT": "Text Data",
+            "TIME": "Time data is a cyclical, repeating continuous form of data.\nThe relevant time features can be any period- daily, weekly, monthly, annual, etc.",
+            "UNKNOWN": "Unknown data are data that we don't know the type for.",
+            "USELESS": "Useless data is unique, discrete data with no potential relationship with the outcome variable.\nA useless feature has high cardinality. An example would be bank account numbers that were generated randomly.",
+            "VIDEO": "Video Data"
+          },
+          "name": "MLFeatureDataType",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "symbols": [
+            "USELESS",
+            "NOMINAL",
+            "ORDINAL",
+            "BINARY",
+            "COUNT",
+            "TIME",
+            "INTERVAL",
+            "IMAGE",
+            "VIDEO",
+            "AUDIO",
+            "TEXT",
+            "MAP",
+            "SEQUENCE",
+            "SET",
+            "CONTINUOUS",
+            "BYTE",
+            "UNKNOWN"
+          ],
+          "doc": "MLFeature Data Type"
+        }
+      ],
+      "name": "dataType",
+      "default": null,
+      "doc": "Data Type of the MLFeature"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "VersionTag",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "versionTag",
+              "default": null
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "MetadataAttribution",
+                  "namespace": "com.linkedin.pegasus2avro.common",
+                  "fields": [
+                    {
+                      "type": "long",
+                      "name": "time",
+                      "doc": "When this metadata was updated."
+                    },
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": "string",
+                      "name": "actor",
+                      "doc": "The 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.",
+                      "Urn": "Urn"
+                    },
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": [
+                        "null",
+                        "string"
+                      ],
+                      "name": "source",
+                      "default": null,
+                      "doc": "The DataHub source responsible for applying the associated metadata. This will only be filled out\nwhen a DataHub source is responsible. This includes the specific metadata test urn, the automation urn.",
+                      "Urn": "Urn"
+                    },
+                    {
+                      "type": {
+                        "type": "map",
+                        "values": "string"
+                      },
+                      "name": "sourceDetail",
+                      "default": {},
+                      "doc": "The details associated with why this metadata was applied. For example, this could include\nthe actual regex rule, sql statement, ingestion pipeline ID, etc.\nAlso can include flags like 'propagated'=true or 'inferred'=true."
+                    }
+                  ],
+                  "doc": "Information about who, why, and how this metadata was applied"
+                }
+              ],
+              "name": "metadataAttribution",
+              "default": null
+            }
+          ],
+          "doc": "A resource-defined string representing the resource state for the purpose of concurrency control"
+        }
+      ],
+      "name": "version",
+      "default": null,
+      "doc": "Version of the MLFeature"
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "dataset"
+          ],
+          "isLineage": true,
+          "name": "DerivedFrom"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "sources",
+      "default": null,
+      "doc": "Source of the MLFeature",
+      "Urn": "Urn",
+      "urn_is_array": true
+    }
+  ],
+  "doc": "Properties associated with a MLFeature"
+}

acryl_datahub_cloud/metadata/schemas/MLFeatureTableKey.avsc

@@ -0,0 +1,66 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "mlFeatureTableKey",
+    "keyForEntity": "mlFeatureTable",
+    "entityCategory": "core",
+    "entityAspects": [
+      "glossaryTerms",
+      "editableMlFeatureTableProperties",
+      "domains",
+      "proposals",
+      "mlFeatureTableProperties",
+      "ownership",
+      "institutionalMemory",
+      "status",
+      "deprecation",
+      "browsePaths",
+      "globalTags",
+      "dataPlatformInstance",
+      "browsePathsV2",
+      "structuredProperties",
+      "forms",
+      "testResults",
+      "share",
+      "origin",
+      "lineageFeatures",
+      "documentation"
+    ]
+  },
+  "name": "MLFeatureTableKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "Relationship": {
+        "entityTypes": [
+          "dataPlatform"
+        ],
+        "name": "SourcePlatform"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": "string",
+      "name": "platform",
+      "doc": "Data platform urn associated with the feature table",
+      "Urn": "Urn",
+      "entityTypes": [
+        "dataPlatform"
+      ]
+    },
+    {
+      "Searchable": {
+        "boostScore": 8.0,
+        "enableAutocomplete": true,
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "Name of the feature table"
+    }
+  ],
+  "doc": "Key for an MLFeatureTable"
+}