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

acryl_datahub_cloud/metadata/schemas/GlossaryNodeInfo.avsc

@@ -0,0 +1,89 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "glossaryNodeInfo"
+  },
+  "name": "GlossaryNodeInfo",
+  "namespace": "com.linkedin.pegasus2avro.glossary",
+  "fields": [
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT",
+          "queryByDefault": true
+        }
+      },
+      "type": {
+        "type": "map",
+        "values": "string"
+      },
+      "name": "customProperties",
+      "default": {},
+      "doc": "Custom property bag."
+    },
+    {
+      "Searchable": {},
+      "type": "string",
+      "name": "definition",
+      "doc": "Definition of business node"
+    },
+    {
+      "Relationship": {
+        "entityTypes": [
+          "glossaryNode"
+        ],
+        "name": "IsPartOf"
+      },
+      "Searchable": {
+        "fieldName": "parentNode",
+        "fieldType": "URN",
+        "hasValuesFieldName": "hasParentNode"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.GlossaryNodeUrn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "parentNode",
+      "default": null,
+      "doc": "Parent node of the glossary term",
+      "Urn": "GlossaryNodeUrn",
+      "entityTypes": [
+        "glossaryNode"
+      ]
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldName": "displayName",
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "WORD_GRAM"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "name",
+      "default": null,
+      "doc": "Display name of the node"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "id",
+      "default": null,
+      "doc": "Optional id for the GlossaryNode"
+    }
+  ],
+  "doc": "Properties associated with a GlossaryNode"
+}

acryl_datahub_cloud/metadata/schemas/GlossaryNodeKey.avsc

@@ -0,0 +1,33 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "glossaryNodeKey",
+    "keyForEntity": "glossaryNode",
+    "entityCategory": "core",
+    "entityAspects": [
+      "glossaryNodeInfo",
+      "institutionalMemory",
+      "ownership",
+      "status",
+      "structuredProperties",
+      "forms",
+      "testResults",
+      "displayProperties",
+      "share",
+      "origin"
+    ]
+  },
+  "name": "GlossaryNodeKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "Searchable": {
+        "enableAutocomplete": true,
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "name"
+    }
+  ],
+  "doc": "Key for a GlossaryNode"
+}

acryl_datahub_cloud/metadata/schemas/GlossaryRelatedTerms.avsc

@@ -0,0 +1,125 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "glossaryRelatedTerms"
+  },
+  "name": "GlossaryRelatedTerms",
+  "namespace": "com.linkedin.pegasus2avro.glossary",
+  "fields": [
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "glossaryTerm"
+          ],
+          "name": "IsA"
+        }
+      },
+      "Searchable": {
+        "/*": {
+          "fieldName": "isRelatedTerms",
+          "fieldType": "URN",
+          "queryByDefault": false
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "isRelatedTerms",
+      "default": null,
+      "doc": "The relationship Is A with glossary term",
+      "Urn": "GlossaryTermUrn",
+      "urn_is_array": true
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "glossaryTerm"
+          ],
+          "name": "HasA"
+        }
+      },
+      "Searchable": {
+        "/*": {
+          "fieldName": "hasRelatedTerms",
+          "fieldType": "URN",
+          "queryByDefault": false
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "hasRelatedTerms",
+      "default": null,
+      "doc": "The relationship Has A with glossary term",
+      "Urn": "GlossaryTermUrn",
+      "urn_is_array": true
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "glossaryTerm"
+          ],
+          "name": "HasValue"
+        }
+      },
+      "Searchable": {
+        "/*": {
+          "fieldName": "values",
+          "fieldType": "URN"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "values",
+      "default": null,
+      "doc": "The relationship Has Value with glossary term.\nThese are fixed value a term has. For example a ColorEnum where RED, GREEN and YELLOW are fixed values.",
+      "Urn": "GlossaryTermUrn",
+      "urn_is_array": true
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "glossaryTerm"
+          ],
+          "name": "IsRelatedTo"
+        }
+      },
+      "Searchable": {
+        "/*": {
+          "fieldName": "relatedTerms",
+          "fieldType": "URN"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "relatedTerms",
+      "default": null,
+      "doc": "The relationship isRelatedTo with glossary term",
+      "Urn": "GlossaryTermUrn",
+      "urn_is_array": true
+    }
+  ],
+  "doc": "Has A / Is A lineage information about a glossary Term reporting the lineage"
+}

acryl_datahub_cloud/metadata/schemas/GlossaryTermInfo.avsc

@@ -0,0 +1,131 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "glossaryTermInfo"
+  },
+  "name": "GlossaryTermInfo",
+  "namespace": "com.linkedin.pegasus2avro.glossary",
+  "fields": [
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT",
+          "queryByDefault": true
+        }
+      },
+      "type": {
+        "type": "map",
+        "values": "string"
+      },
+      "name": "customProperties",
+      "default": {},
+      "doc": "Custom property bag."
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "id",
+      "default": null,
+      "doc": "Optional id for the term"
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "WORD_GRAM"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "name",
+      "default": null,
+      "doc": "Display name of the term"
+    },
+    {
+      "Searchable": {},
+      "type": "string",
+      "name": "definition",
+      "doc": "Definition of business term."
+    },
+    {
+      "Relationship": {
+        "entityTypes": [
+          "glossaryNode"
+        ],
+        "name": "IsPartOf"
+      },
+      "Searchable": {
+        "fieldName": "parentNode",
+        "fieldType": "URN",
+        "hasValuesFieldName": "hasParentNode"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.GlossaryNodeUrn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "parentNode",
+      "default": null,
+      "doc": "Parent node of the glossary term",
+      "Urn": "GlossaryNodeUrn",
+      "entityTypes": [
+        "glossaryNode"
+      ]
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": "string",
+      "name": "termSource",
+      "doc": "Source of the Business Term (INTERNAL or EXTERNAL) with default value as INTERNAL"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "sourceRef",
+      "default": null,
+      "doc": "External Reference to the business-term"
+    },
+    {
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.url.Url",
+        "coercerClass": "com.linkedin.pegasus2avro.common.url.UrlCoercer"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "sourceUrl",
+      "default": null,
+      "doc": "The abstracted URL such as https://spec.edmcouncil.org/fibo/ontology/FBC/FinancialInstruments/FinancialInstruments/CashInstrument."
+    },
+    {
+      "deprecated": true,
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "rawSchema",
+      "default": null,
+      "doc": "Schema definition of the glossary term"
+    }
+  ],
+  "doc": "Properties associated with a GlossaryTerm"
+}

acryl_datahub_cloud/metadata/schemas/GlossaryTermKey.avsc

@@ -0,0 +1,39 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "glossaryTermKey",
+    "keyForEntity": "glossaryTerm",
+    "entityCategory": "core",
+    "entityAspects": [
+      "glossaryTermInfo",
+      "glossaryRelatedTerms",
+      "institutionalMemory",
+      "schemaMetadata",
+      "ownership",
+      "deprecation",
+      "domains",
+      "status",
+      "browsePaths",
+      "structuredProperties",
+      "forms",
+      "testResults",
+      "share",
+      "origin"
+    ]
+  },
+  "name": "GlossaryTermKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "Searchable": {
+        "enableAutocomplete": true,
+        "fieldName": "id",
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "The term name, which serves as a unique id"
+    }
+  ],
+  "doc": "Key for a GlossaryTerm"
+}

acryl_datahub_cloud/metadata/schemas/GlossaryTerms.avsc

@@ -0,0 +1,190 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "glossaryTerms"
+  },
+  "name": "GlossaryTerms",
+  "namespace": "com.linkedin.pegasus2avro.common",
+  "fields": [
+    {
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "GlossaryTermAssociation",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "Relationship": {
+                "entityTypes": [
+                  "glossaryTerm"
+                ],
+                "name": "TermedWith"
+              },
+              "Searchable": {
+                "addToFilters": true,
+                "fieldName": "glossaryTerms",
+                "fieldType": "URN",
+                "filterNameOverride": "Glossary Term Applied",
+                "hasValuesFieldName": "hasGlossaryTerms"
+              },
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.GlossaryTermUrn"
+              },
+              "type": "string",
+              "name": "urn",
+              "doc": "Urn of the applied glossary term",
+              "Urn": "GlossaryTermUrn",
+              "entityTypes": [
+                "glossaryTerm"
+              ]
+            },
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "actor",
+              "default": null,
+              "doc": "The user URN which will be credited for adding associating this term to the entity",
+              "Urn": "Urn"
+            },
+            {
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "context",
+              "default": null,
+              "doc": "Additional context about the association"
+            },
+            {
+              "Searchable": {
+                "/actor": {
+                  "fieldName": "termAttributionActors",
+                  "fieldType": "URN",
+                  "queryByDefault": false
+                },
+                "/source": {
+                  "fieldName": "termAttributionSources",
+                  "fieldType": "URN",
+                  "queryByDefault": false
+                },
+                "/time": {
+                  "fieldName": "termAttributionDates",
+                  "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 an applied glossary term."
+        }
+      },
+      "name": "terms",
+      "doc": "The related business terms"
+    },
+    {
+      "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": "auditStamp",
+      "doc": "Audit stamp containing who reported the related business term"
+    }
+  ],
+  "doc": "Related business terms information"
+}

acryl_datahub_cloud/metadata/schemas/GroupMembership.avsc

@@ -0,0 +1,28 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "groupMembership"
+  },
+  "name": "GroupMembership",
+  "namespace": "com.linkedin.pegasus2avro.identity",
+  "fields": [
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "corpGroup"
+          ],
+          "name": "IsMemberOfGroup"
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "groups",
+      "Urn": "Urn",
+      "urn_is_array": true
+    }
+  ],
+  "doc": "Carries information about the CorpGroups a user is in."
+}