acryl-datahub 0.15.0.2rc4__py3-none-any.whl → 0.15.0.2rc5__py3-none-any.whl

datahub/metadata/schemas/VersionProperties.avsc

@@ -0,0 +1,216 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "versionProperties"
+  },
+  "name": "VersionProperties",
+  "namespace": "com.linkedin.pegasus2avro.common",
+  "fields": [
+    {
+      "Relationship": {
+        "entityTypes": [
+          "versionSet"
+        ],
+        "name": "VersionOf"
+      },
+      "Searchable": {
+        "queryByDefault": false
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": "string",
+      "name": "versionSet",
+      "doc": "The linked Version Set entity that ties multiple versioned assets together",
+      "Urn": "Urn",
+      "entityTypes": [
+        "versionSet"
+      ]
+    },
+    {
+      "Searchable": {
+        "/versionTag": {
+          "fieldName": "version",
+          "queryByDefault": false
+        }
+      },
+      "type": {
+        "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."
+                  }
+                ],
+                "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",
+      "doc": "Label for this versioned asset, is unique within a version set"
+    },
+    {
+      "Searchable": {
+        "/*/versionTag": {
+          "fieldName": "aliases",
+          "queryByDefault": false
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": "com.linkedin.pegasus2avro.common.VersionTag"
+      },
+      "name": "aliases",
+      "default": [],
+      "doc": "Associated aliases for this versioned asset"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "comment",
+      "default": null,
+      "doc": "Comment documenting what this version was created for, changes, or represents"
+    },
+    {
+      "Searchable": {
+        "fieldName": "versionSortId",
+        "queryByDefault": false
+      },
+      "type": "string",
+      "name": "sortId",
+      "doc": "Sort identifier that determines where a version lives in the order of the Version Set.\nWhat this looks like depends on the Version Scheme. For sort ids generated by DataHub we use an 8 character string representation."
+    },
+    {
+      "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": "sourceCreatedTimestamp",
+      "default": null,
+      "doc": "Timestamp reflecting when this asset version was created in the source system."
+    },
+    {
+      "type": [
+        "null",
+        "com.linkedin.pegasus2avro.common.AuditStamp"
+      ],
+      "name": "metadataCreatedTimestamp",
+      "default": null,
+      "doc": "Timestamp reflecting when the metadata for this version was created in DataHub"
+    },
+    {
+      "Searchable": {
+        "fieldType": "BOOLEAN",
+        "queryByDefault": false
+      },
+      "type": [
+        "null",
+        "boolean"
+      ],
+      "name": "isLatest",
+      "default": null,
+      "doc": "Marks whether this version is currently the latest. Set by a side effect and should not be modified by API."
+    }
+  ],
+  "doc": "Properties about a versioned asset i.e. dataset, ML Model, etc."
+}

datahub/metadata/schemas/VersionSetKey.avsc

@@ -0,0 +1,26 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "versionSetKey",
+    "keyForEntity": "versionSet",
+    "entityCategory": "core",
+    "entityAspects": [
+      "versionSetProperties"
+    ]
+  },
+  "name": "VersionSetKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "ID of the Version Set, generated from platform + asset id / name"
+    },
+    {
+      "type": "string",
+      "name": "entityType",
+      "doc": "Type of entities included in version set, limits to a single entity type between linked versioned entities"
+    }
+  ],
+  "doc": "Key for a Version Set entity"
+}

datahub/metadata/schemas/VersionSetProperties.avsc

@@ -0,0 +1,49 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "versionSetProperties"
+  },
+  "name": "VersionSetProperties",
+  "namespace": "com.linkedin.pegasus2avro.versionset",
+  "fields": [
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT",
+          "queryByDefault": true
+        }
+      },
+      "type": {
+        "type": "map",
+        "values": "string"
+      },
+      "name": "customProperties",
+      "default": {},
+      "doc": "Custom property bag."
+    },
+    {
+      "Searchable": {
+        "queryByDefault": "false"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": "string",
+      "name": "latest",
+      "doc": "The latest versioned entity linked to in this version set",
+      "Urn": "Urn"
+    },
+    {
+      "type": {
+        "type": "enum",
+        "name": "VersioningScheme",
+        "namespace": "com.linkedin.pegasus2avro.versionset",
+        "symbols": [
+          "ALPHANUMERIC_GENERATED_BY_DATAHUB"
+        ]
+      },
+      "name": "versioningScheme",
+      "doc": "What versioning scheme is being utilized for the versioned entities sort criterion. Static once set"
+    }
+  ]
+}