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

acryl_datahub_cloud/metadata/schemas/Documentation.avsc

@@ -0,0 +1,152 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "documentation"
+  },
+  "name": "Documentation",
+  "namespace": "com.linkedin.pegasus2avro.common",
+  "fields": [
+    {
+      "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": "lastModified",
+      "default": null,
+      "doc": "The time and actor that generated or last updated this documentation."
+    },
+    {
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "DocumentationAssociation",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "type": "string",
+              "name": "documentation",
+              "doc": "Description of this asset"
+            },
+            {
+              "Searchable": {
+                "/actor": {
+                  "fieldName": "documentationAttributionActors",
+                  "fieldType": "URN",
+                  "queryByDefault": false
+                },
+                "/source": {
+                  "fieldName": "documentationAttributionSources",
+                  "fieldType": "URN",
+                  "queryByDefault": false
+                },
+                "/time": {
+                  "fieldName": "documentationAttributionDates",
+                  "fieldType": "DATETIME",
+                  "queryByDefault": false
+                }
+              },
+              "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": "attribution",
+              "default": null,
+              "doc": "Information about who, why, and how this metadata was applied"
+            }
+          ],
+          "doc": "Properties of applied documentation including the attribution of the doc"
+        }
+      },
+      "name": "documentations",
+      "doc": "Documentations associated with this asset. We could be receiving docs from different sources"
+    }
+  ],
+  "doc": "Aspect used for storing all applicable documentations on assets.\nThis aspect supports multiple documentations from different sources.\nThere is an implicit assumption that there is only one documentation per\n   source.\nFor example, if there are two documentations from the same source, the\n   latest one will overwrite the previous one.\nIf there are two documentations from different sources, both will be\n   stored.\nFuture evolution considerations:\nThe first entity that uses this aspect is Schema Field. We will expand this\n    aspect to other entities eventually.\nThe values of the documentation are not currently searchable. This will be\n    changed once this aspect develops opinion on which documentation entry is\n    the authoritative one.\nEnsuring that there is only one documentation per source is a business\n    rule that is not enforced by the aspect yet. This will currently be enforced by the\n    application that uses this aspect. We will eventually enforce this rule in\n    the aspect using AspectMutators."
+}

acryl_datahub_cloud/metadata/schemas/DomainKey.avsc

@@ -0,0 +1,30 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "domainKey",
+    "keyForEntity": "domain",
+    "entityCategory": "core",
+    "entityAspects": [
+      "domainProperties",
+      "institutionalMemory",
+      "ownership",
+      "structuredProperties",
+      "forms",
+      "testResults",
+      "displayProperties",
+      "share",
+      "origin"
+    ],
+    "entityDoc": "A data domain within an organization."
+  },
+  "name": "DomainKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the domain. Should be separate from the name used for displaying a Domain."
+    }
+  ],
+  "doc": "Key for an Asset Domain"
+}

acryl_datahub_cloud/metadata/schemas/DomainProperties.avsc

@@ -0,0 +1,137 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "domainProperties"
+  },
+  "name": "DomainProperties",
+  "namespace": "com.linkedin.pegasus2avro.domain",
+  "fields": [
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT",
+          "queryByDefault": true
+        }
+      },
+      "type": {
+        "type": "map",
+        "values": "string"
+      },
+      "name": "customProperties",
+      "default": {},
+      "doc": "Custom property bag."
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "Display name of the Domain"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT",
+        "hasValuesFieldName": "hasDescription"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "Description of the Domain"
+    },
+    {
+      "Searchable": {
+        "/time": {
+          "fieldName": "createdTime",
+          "fieldType": "DATETIME"
+        }
+      },
+      "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": "Created Audit stamp"
+    },
+    {
+      "Relationship": {
+        "entityTypes": [
+          "domain"
+        ],
+        "name": "IsPartOf"
+      },
+      "Searchable": {
+        "fieldName": "parentDomain",
+        "fieldType": "URN",
+        "hasValuesFieldName": "hasParentDomain"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "parentDomain",
+      "default": null,
+      "doc": "Optional: Parent of the domain",
+      "Urn": "Urn",
+      "entityTypes": [
+        "domain"
+      ]
+    }
+  ],
+  "doc": "Information about a Domain"
+}

acryl_datahub_cloud/metadata/schemas/Domains.avsc

@@ -0,0 +1,38 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "domains"
+  },
+  "name": "Domains",
+  "namespace": "com.linkedin.pegasus2avro.domain",
+  "fields": [
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "domain"
+          ],
+          "name": "AssociatedWith"
+        }
+      },
+      "Searchable": {
+        "/*": {
+          "addToFilters": true,
+          "fieldName": "domains",
+          "fieldType": "URN",
+          "filterNameOverride": "In Domain",
+          "hasValuesFieldName": "hasDomain"
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "domains",
+      "doc": "The Domains attached to an Asset",
+      "Urn": "Urn",
+      "urn_is_array": true
+    }
+  ],
+  "doc": "Links from an Asset to its Domains"
+}

acryl_datahub_cloud/metadata/schemas/DynamicFormAssignment.avsc

@@ -0,0 +1,150 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dynamicFormAssignment"
+  },
+  "name": "DynamicFormAssignment",
+  "namespace": "com.linkedin.pegasus2avro.form",
+  "fields": [
+    {
+      "type": {
+        "type": "record",
+        "name": "Filter",
+        "namespace": "com.linkedin.pegasus2avro.metadata.query.filter",
+        "fields": [
+          {
+            "type": [
+              "null",
+              {
+                "type": "array",
+                "items": {
+                  "type": "record",
+                  "name": "ConjunctiveCriterion",
+                  "namespace": "com.linkedin.pegasus2avro.metadata.query.filter",
+                  "fields": [
+                    {
+                      "type": {
+                        "type": "array",
+                        "items": {
+                          "type": "record",
+                          "name": "Criterion",
+                          "namespace": "com.linkedin.pegasus2avro.metadata.query.filter",
+                          "fields": [
+                            {
+                              "type": "string",
+                              "name": "field",
+                              "doc": "The name of the field that the criterion refers to"
+                            },
+                            {
+                              "type": "string",
+                              "name": "value",
+                              "doc": "The value of the intended field"
+                            },
+                            {
+                              "type": {
+                                "type": "array",
+                                "items": "string"
+                              },
+                              "name": "values",
+                              "default": [],
+                              "doc": "Values. one of which the intended field should match\nNote, if values is set, the above \"value\" field will be ignored"
+                            },
+                            {
+                              "type": {
+                                "type": "enum",
+                                "symbolDocs": {
+                                  "ANCESTORS_INCL": "Represent the relation: URN field matches any nested parent in addition to the given URN",
+                                  "BETWEEN": "Represent the relation within an inclusive range, e.g. 3 <= ownerCount <= 5. Note that the values in Criterion must have two entries for a lower and upper bound.",
+                                  "CONTAIN": "Represent the relation: String field contains value, e.g. name contains Profile",
+                                  "DESCENDANTS_INCL": "Represent the relation: URN field any nested children in addition to the given URN",
+                                  "END_WITH": "Represent the relation: String field ends with value, e.g. name ends with Event",
+                                  "EQUAL": "Represent the relation: field = value, e.g. platform = hdfs",
+                                  "EXISTS": "Represents the relation: field exists and is non-empty, e.g. owners is not null and != [] (empty)",
+                                  "GREATER_THAN": "Represent the relation greater than, e.g. ownerCount > 5",
+                                  "GREATER_THAN_OR_EQUAL_TO": "Represent the relation greater than or equal to, e.g. ownerCount >= 5",
+                                  "IEQUAL": "Represent the relation: field = value and support case insensitive values, e.g. platform = hdfs",
+                                  "IN": "Represent the relation: String field is one of the array values to, e.g. name in [\"Profile\", \"Event\"]",
+                                  "IS_NULL": "Represent the relation: field is null, e.g. platform is null",
+                                  "LESS_THAN": "Represent the relation less than, e.g. ownerCount < 3",
+                                  "LESS_THAN_OR_EQUAL_TO": "Represent the relation less than or equal to, e.g. ownerCount <= 3",
+                                  "RELATED_INCL": "Represent the relation: URN field matches any nested child or parent in addition to the given URN",
+                                  "START_WITH": "Represent the relation: String field starts with value, e.g. name starts with PageView"
+                                },
+                                "name": "Condition",
+                                "namespace": "com.linkedin.pegasus2avro.metadata.query.filter",
+                                "symbols": [
+                                  "CONTAIN",
+                                  "END_WITH",
+                                  "EQUAL",
+                                  "IEQUAL",
+                                  "IS_NULL",
+                                  "EXISTS",
+                                  "GREATER_THAN",
+                                  "GREATER_THAN_OR_EQUAL_TO",
+                                  "IN",
+                                  "LESS_THAN",
+                                  "LESS_THAN_OR_EQUAL_TO",
+                                  "BETWEEN",
+                                  "START_WITH",
+                                  "DESCENDANTS_INCL",
+                                  "ANCESTORS_INCL",
+                                  "RELATED_INCL"
+                                ],
+                                "doc": "The matching condition in a filter criterion"
+                              },
+                              "name": "condition",
+                              "default": "EQUAL",
+                              "doc": "The condition for the criterion, e.g. EQUAL, START_WITH"
+                            },
+                            {
+                              "type": "boolean",
+                              "name": "negated",
+                              "default": false,
+                              "doc": "Whether the condition should be negated"
+                            }
+                          ],
+                          "doc": "A criterion for matching a field with given value"
+                        }
+                      },
+                      "name": "and",
+                      "doc": "A list of and criteria the filter applies to the query"
+                    }
+                  ],
+                  "doc": "A list of criterion and'd together."
+                }
+              }
+            ],
+            "name": "or",
+            "default": null,
+            "doc": "A list of disjunctive criterion for the filter. (or operation to combine filters)"
+          },
+          {
+            "type": [
+              "null",
+              {
+                "type": "array",
+                "items": "com.linkedin.pegasus2avro.metadata.query.filter.Criterion"
+              }
+            ],
+            "name": "criteria",
+            "default": null,
+            "doc": "Deprecated! A list of conjunctive criterion for the filter. If \"or\" field is provided, then this field is ignored."
+          }
+        ],
+        "doc": "The filter for finding a record or a collection of records"
+      },
+      "name": "filter",
+      "doc": "The filter applied when assigning this form to entities. Entities that match this filter\nwill have this form applied to them. Right now this filter only supports filtering by\nplatform, entity type, container, and domain through the UI."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "json",
+      "default": null,
+      "doc": "The 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": "Information about how a form is assigned to entities dynamically. Provide a filter to\nmatch a set of entities instead of explicitly applying a form to specific entities."
+}

acryl_datahub_cloud/metadata/schemas/ERModelRelationshipKey.avsc

@@ -0,0 +1,28 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "erModelRelationshipKey",
+    "keyForEntity": "erModelRelationship",
+    "entityCategory": "_unset_",
+    "entityAspects": [
+      "erModelRelationshipProperties",
+      "editableERModelRelationshipProperties",
+      "institutionalMemory",
+      "ownership",
+      "status",
+      "globalTags",
+      "glossaryTerms",
+      "lineageFeatures"
+    ],
+    "entityDoc": "ER Model Relationship of  Dataset Fields"
+  },
+  "name": "ERModelRelationshipKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id"
+    }
+  ],
+  "doc": "Key for a ERModelRelationship"
+}