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

acryl_datahub_cloud/metadata/schemas/BusinessAttributeInfo.avsc

@@ -0,0 +1,601 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "businessAttributeInfo"
+  },
+  "name": "BusinessAttributeInfo",
+  "namespace": "com.linkedin.pegasus2avro.businessattribute",
+  "fields": [
+    {
+      "type": "string",
+      "name": "fieldPath",
+      "doc": "FieldPath uniquely identifying the SchemaField this metadata is associated with"
+    },
+    {
+      "Searchable": {
+        "boostScore": 0.1,
+        "fieldName": "editedFieldDescriptions",
+        "fieldType": "TEXT"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "Description"
+    },
+    {
+      "Relationship": {
+        "/tags/*/tag": {
+          "entityTypes": [
+            "tag"
+          ],
+          "name": "EditableSchemaFieldTaggedWith"
+        }
+      },
+      "Searchable": {
+        "/tags/*/attribution/actor": {
+          "fieldName": "editedFieldTagAttributionActors",
+          "fieldType": "URN",
+          "queryByDefault": false
+        },
+        "/tags/*/attribution/source": {
+          "fieldName": "editedFieldTagAttributionSources",
+          "fieldType": "URN",
+          "queryByDefault": false
+        },
+        "/tags/*/attribution/time": {
+          "fieldName": "editedFieldTagAttributionDates",
+          "fieldType": "DATETIME",
+          "queryByDefault": false
+        },
+        "/tags/*/tag": {
+          "boostScore": 0.5,
+          "fieldName": "editedFieldTags",
+          "fieldType": "URN"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "Aspect": {
+            "name": "globalTags"
+          },
+          "name": "GlobalTags",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "Relationship": {
+                "/*/tag": {
+                  "entityTypes": [
+                    "tag"
+                  ],
+                  "name": "TaggedWith"
+                }
+              },
+              "Searchable": {
+                "/*/tag": {
+                  "addToFilters": true,
+                  "boostScore": 0.5,
+                  "fieldName": "tags",
+                  "fieldType": "URN",
+                  "filterNameOverride": "Tagged With",
+                  "hasValuesFieldName": "hasTags",
+                  "queryByDefault": true
+                }
+              },
+              "type": {
+                "type": "array",
+                "items": {
+                  "type": "record",
+                  "name": "TagAssociation",
+                  "namespace": "com.linkedin.pegasus2avro.common",
+                  "fields": [
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.TagUrn"
+                      },
+                      "type": "string",
+                      "name": "tag",
+                      "doc": "Urn of the applied tag",
+                      "Urn": "TagUrn"
+                    },
+                    {
+                      "type": [
+                        "null",
+                        "string"
+                      ],
+                      "name": "context",
+                      "default": null,
+                      "doc": "Additional context about the association"
+                    },
+                    {
+                      "Searchable": {
+                        "/actor": {
+                          "fieldName": "tagAttributionActors",
+                          "fieldType": "URN",
+                          "queryByDefault": false
+                        },
+                        "/source": {
+                          "fieldName": "tagAttributionSources",
+                          "fieldType": "URN",
+                          "queryByDefault": false
+                        },
+                        "/time": {
+                          "fieldName": "tagAttributionDates",
+                          "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 tag. For now, just an Urn. In the future we can extend this with other properties, e.g.\npropagation parameters."
+                }
+              },
+              "name": "tags",
+              "doc": "Tags associated with a given entity"
+            }
+          ],
+          "doc": "Tag aspect used for applying tags to an entity"
+        }
+      ],
+      "name": "globalTags",
+      "default": null,
+      "doc": "Tags associated with the field"
+    },
+    {
+      "Relationship": {
+        "/terms/*/urn": {
+          "entityTypes": [
+            "glossaryTerm"
+          ],
+          "name": "EditableSchemaFieldWithGlossaryTerm"
+        }
+      },
+      "Searchable": {
+        "/terms/*/attribution/actor": {
+          "fieldName": "editedFieldTermAttributionActors",
+          "fieldType": "URN",
+          "queryByDefault": false
+        },
+        "/terms/*/attribution/source": {
+          "fieldName": "editedFieldTermAttributionSources",
+          "fieldType": "URN",
+          "queryByDefault": false
+        },
+        "/terms/*/attribution/time": {
+          "fieldName": "editedFieldTermAttributionDates",
+          "fieldType": "DATETIME",
+          "queryByDefault": false
+        },
+        "/terms/*/urn": {
+          "boostScore": 0.5,
+          "fieldName": "editedFieldGlossaryTerms",
+          "fieldType": "URN"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "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",
+                        "com.linkedin.pegasus2avro.common.MetadataAttribution"
+                      ],
+                      "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"
+        }
+      ],
+      "name": "glossaryTerms",
+      "default": null,
+      "doc": "Glossary terms associated with the field"
+    },
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT",
+          "queryByDefault": true
+        }
+      },
+      "type": {
+        "type": "map",
+        "values": "string"
+      },
+      "name": "customProperties",
+      "default": {},
+      "doc": "Custom property bag."
+    },
+    {
+      "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."
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "Display name of the BusinessAttribute"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "SchemaFieldDataType",
+          "namespace": "com.linkedin.pegasus2avro.schema",
+          "fields": [
+            {
+              "type": [
+                {
+                  "type": "record",
+                  "name": "BooleanType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [],
+                  "doc": "Boolean field type."
+                },
+                {
+                  "type": "record",
+                  "name": "FixedType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [],
+                  "doc": "Fixed field type."
+                },
+                {
+                  "type": "record",
+                  "name": "StringType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [],
+                  "doc": "String field type."
+                },
+                {
+                  "type": "record",
+                  "name": "BytesType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [],
+                  "doc": "Bytes field type."
+                },
+                {
+                  "type": "record",
+                  "name": "NumberType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [],
+                  "doc": "Number data type: long, integer, short, etc.."
+                },
+                {
+                  "type": "record",
+                  "name": "DateType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [],
+                  "doc": "Date field type."
+                },
+                {
+                  "type": "record",
+                  "name": "TimeType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [],
+                  "doc": "Time field type. This should also be used for datetimes."
+                },
+                {
+                  "type": "record",
+                  "name": "EnumType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [],
+                  "doc": "Enum field type."
+                },
+                {
+                  "type": "record",
+                  "name": "NullType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [],
+                  "doc": "Null field type."
+                },
+                {
+                  "type": "record",
+                  "name": "MapType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [
+                    {
+                      "type": [
+                        "null",
+                        "string"
+                      ],
+                      "name": "keyType",
+                      "default": null,
+                      "doc": "Key type in a map"
+                    },
+                    {
+                      "type": [
+                        "null",
+                        "string"
+                      ],
+                      "name": "valueType",
+                      "default": null,
+                      "doc": "Type of the value in a map"
+                    }
+                  ],
+                  "doc": "Map field type."
+                },
+                {
+                  "type": "record",
+                  "name": "ArrayType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [
+                    {
+                      "type": [
+                        "null",
+                        {
+                          "type": "array",
+                          "items": "string"
+                        }
+                      ],
+                      "name": "nestedType",
+                      "default": null,
+                      "doc": "List of types this array holds."
+                    }
+                  ],
+                  "doc": "Array field type."
+                },
+                {
+                  "type": "record",
+                  "name": "UnionType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [
+                    {
+                      "type": [
+                        "null",
+                        {
+                          "type": "array",
+                          "items": "string"
+                        }
+                      ],
+                      "name": "nestedTypes",
+                      "default": null,
+                      "doc": "List of types in union type."
+                    }
+                  ],
+                  "doc": "Union field type."
+                },
+                {
+                  "type": "record",
+                  "name": "RecordType",
+                  "namespace": "com.linkedin.pegasus2avro.schema",
+                  "fields": [],
+                  "doc": "Record field type."
+                }
+              ],
+              "name": "type",
+              "doc": "Data platform specific types"
+            }
+          ],
+          "doc": "Schema field data types"
+        }
+      ],
+      "name": "type",
+      "default": null
+    }
+  ],
+  "doc": "Properties associated with a BusinessAttribute"
+}

acryl_datahub_cloud/metadata/schemas/BusinessAttributeKey.avsc

@@ -0,0 +1,24 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "businessAttributeKey",
+    "keyForEntity": "businessAttribute",
+    "entityCategory": "core",
+    "entityAspects": [
+      "businessAttributeInfo",
+      "status",
+      "ownership",
+      "institutionalMemory"
+    ]
+  },
+  "name": "BusinessAttributeKey",
+  "namespace": "com.linkedin.pegasus2avro.businessattribute",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the Business Attribute."
+    }
+  ],
+  "doc": "Key for a Query"
+}

acryl_datahub_cloud/metadata/schemas/BusinessAttributes.avsc

@@ -0,0 +1,51 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "businessAttributes"
+  },
+  "name": "BusinessAttributes",
+  "namespace": "com.linkedin.pegasus2avro.businessattribute",
+  "fields": [
+    {
+      "Relationship": {
+        "/businessAttributeUrn": {
+          "entityTypes": [
+            "businessAttribute"
+          ],
+          "name": "BusinessAttributeOf"
+        }
+      },
+      "SearchableRef": {
+        "/businessAttributeUrn": {
+          "boostScore": 0.5,
+          "fieldName": "businessAttributeRef",
+          "fieldType": "URN",
+          "refType": "businessAttribute"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "BusinessAttributeAssociation",
+          "namespace": "com.linkedin.pegasus2avro.businessattribute",
+          "fields": [
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.BusinessAttributeUrn"
+              },
+              "type": "string",
+              "name": "businessAttributeUrn",
+              "doc": "Urn of the applied businessAttribute",
+              "Urn": "BusinessAttributeUrn"
+            }
+          ]
+        }
+      ],
+      "name": "businessAttribute",
+      "default": null,
+      "doc": "Business Attribute for this field."
+    }
+  ],
+  "doc": "BusinessAttribute aspect used for applying it to an entity"
+}