acryl-datahub 1.1.1rc4__py3-none-any.whl → 1.3.0.1rc9__py3-none-any.whl

datahub/metadata/schemas/DataHubPageModuleKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPageModuleKey",
+    "keyForEntity": "dataHubPageModule",
+    "entityCategory": "core",
+    "entityAspects": [
+      "dataHubPageModuleProperties"
+    ]
+  },
+  "name": "DataHubPageModuleKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "Unique id for the module."
+    }
+  ],
+  "doc": "Key for a DataHubPageModule"
+}

datahub/metadata/schemas/DataHubPageModuleProperties.avsc

@@ -0,0 +1,298 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPageModuleProperties"
+  },
+  "name": "DataHubPageModuleProperties",
+  "namespace": "com.linkedin.pegasus2avro.module",
+  "fields": [
+    {
+      "type": "string",
+      "name": "name",
+      "doc": "The display name of this module"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "ASSETS": "Module displaying the assets of parent entity",
+          "ASSET_COLLECTION": "A module with a collection of assets",
+          "CHILD_HIERARCHY": "Module displaying the hierarchy of the children of a given entity. Glossary or Domains.",
+          "DATA_PRODUCTS": "Module displaying child data products of a given domain",
+          "DOMAINS": "Module displaying the top domains",
+          "HIERARCHY": "A module displaying a hierarchy to navigate",
+          "LINK": "Link type module",
+          "OWNED_ASSETS": "Module displaying assets owned by a user",
+          "PLATFORMS": "Module displaying the platforms in an instance",
+          "RELATED_TERMS": "Module displaying the related terms of a given glossary term",
+          "RICH_TEXT": "Module containing rich text to be rendered"
+        },
+        "name": "DataHubPageModuleType",
+        "namespace": "com.linkedin.pegasus2avro.module",
+        "symbols": [
+          "LINK",
+          "RICH_TEXT",
+          "ASSET_COLLECTION",
+          "HIERARCHY",
+          "OWNED_ASSETS",
+          "DOMAINS",
+          "ASSETS",
+          "CHILD_HIERARCHY",
+          "DATA_PRODUCTS",
+          "RELATED_TERMS",
+          "PLATFORMS"
+        ],
+        "doc": "Enum containing the types of page modules that there are"
+      },
+      "name": "type",
+      "doc": "The type of this module - the purpose it serves"
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "DataHubPageModuleVisibility",
+        "namespace": "com.linkedin.pegasus2avro.module",
+        "fields": [
+          {
+            "Searchable": {
+              "fieldType": "KEYWORD"
+            },
+            "type": {
+              "type": "enum",
+              "symbolDocs": {
+                "GLOBAL": "This module is discoverable and can be used by any user on the platform",
+                "PERSONAL": "This module is used for individual use only"
+              },
+              "name": "PageModuleScope",
+              "namespace": "com.linkedin.pegasus2avro.module",
+              "symbols": [
+                "PERSONAL",
+                "GLOBAL"
+              ]
+            },
+            "name": "scope",
+            "doc": "Audit stamp for when and by whom this module was created"
+          }
+        ],
+        "doc": "Info about the visibility of this module"
+      },
+      "name": "visibility",
+      "doc": "Info about the visibility of this module"
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "DataHubPageModuleParams",
+        "namespace": "com.linkedin.pegasus2avro.module",
+        "fields": [
+          {
+            "type": [
+              "null",
+              {
+                "type": "record",
+                "name": "LinkModuleParams",
+                "namespace": "com.linkedin.pegasus2avro.module",
+                "fields": [
+                  {
+                    "type": "string",
+                    "name": "linkUrl"
+                  },
+                  {
+                    "type": [
+                      "null",
+                      "string"
+                    ],
+                    "name": "imageUrl",
+                    "default": null
+                  },
+                  {
+                    "type": [
+                      "null",
+                      "string"
+                    ],
+                    "name": "description",
+                    "default": null
+                  }
+                ]
+              }
+            ],
+            "name": "linkParams",
+            "default": null,
+            "doc": "The params required if the module is type LINK"
+          },
+          {
+            "type": [
+              "null",
+              {
+                "type": "record",
+                "name": "RichTextModuleParams",
+                "namespace": "com.linkedin.pegasus2avro.module",
+                "fields": [
+                  {
+                    "type": "string",
+                    "name": "content"
+                  }
+                ]
+              }
+            ],
+            "name": "richTextParams",
+            "default": null,
+            "doc": "The params required if the module is type RICH_TEXT"
+          },
+          {
+            "type": [
+              "null",
+              {
+                "type": "record",
+                "name": "AssetCollectionModuleParams",
+                "namespace": "com.linkedin.pegasus2avro.module",
+                "fields": [
+                  {
+                    "type": {
+                      "type": "array",
+                      "items": "string"
+                    },
+                    "name": "assetUrns",
+                    "Urn": "Urn",
+                    "urn_is_array": true
+                  },
+                  {
+                    "type": [
+                      "null",
+                      "string"
+                    ],
+                    "name": "dynamicFilterJson",
+                    "default": null,
+                    "doc": "Optional dynamic filters\n\nThe 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": "The params required if the module is type ASSET_COLLECTION"
+              }
+            ],
+            "name": "assetCollectionParams",
+            "default": null,
+            "doc": "The params required if the module is type ASSET_COLLECTION"
+          },
+          {
+            "type": [
+              "null",
+              {
+                "type": "record",
+                "name": "HierarchyModuleParams",
+                "namespace": "com.linkedin.pegasus2avro.module",
+                "fields": [
+                  {
+                    "type": [
+                      "null",
+                      {
+                        "type": "array",
+                        "items": "string"
+                      }
+                    ],
+                    "name": "assetUrns",
+                    "default": null,
+                    "Urn": "Urn",
+                    "urn_is_array": true
+                  },
+                  {
+                    "type": "boolean",
+                    "name": "showRelatedEntities"
+                  },
+                  {
+                    "type": [
+                      "null",
+                      "string"
+                    ],
+                    "name": "relatedEntitiesFilterJson",
+                    "default": null,
+                    "doc": "Optional filters to filter relatedEntities (assetUrns) out\n\nThe 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": "The params required if the module is type HIERARCHY_VIEW"
+              }
+            ],
+            "name": "hierarchyViewParams",
+            "default": null,
+            "doc": "The params required if the module is type HIERARCHY_VIEW"
+          }
+        ],
+        "doc": "The specific parameters stored for a module"
+      },
+      "name": "params",
+      "doc": "The specific parameters stored for this module"
+    },
+    {
+      "Searchable": {
+        "/actor": {
+          "fieldName": "createdBy",
+          "fieldType": "URN"
+        },
+        "/time": {
+          "fieldName": "createdAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "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": "created",
+      "doc": "Audit stamp for when and by whom this template was created"
+    },
+    {
+      "Searchable": {
+        "/time": {
+          "fieldName": "lastModifiedAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": "com.linkedin.pegasus2avro.common.AuditStamp",
+      "name": "lastModified",
+      "doc": "Audit stamp for when and by whom this template was last updated"
+    }
+  ],
+  "doc": "The main properties of a DataHub page module"
+}

datahub/metadata/schemas/DataHubPageTemplateKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPageTemplateKey",
+    "keyForEntity": "dataHubPageTemplate",
+    "entityCategory": "core",
+    "entityAspects": [
+      "dataHubPageTemplateProperties"
+    ]
+  },
+  "name": "DataHubPageTemplateKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "Unique id for the template."
+    }
+  ],
+  "doc": "Key for a DataHubPageTemplate"
+}

datahub/metadata/schemas/DataHubPageTemplateProperties.avsc

@@ -0,0 +1,251 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPageTemplateProperties"
+  },
+  "name": "DataHubPageTemplateProperties",
+  "namespace": "com.linkedin.pegasus2avro.template",
+  "fields": [
+    {
+      "Relationship": {
+        "/*/modules/*": {
+          "entityTypes": [
+            "dataHubPageModule"
+          ],
+          "name": "ContainedIn"
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "DataHubPageTemplateRow",
+          "namespace": "com.linkedin.pegasus2avro.template",
+          "fields": [
+            {
+              "type": {
+                "type": "array",
+                "items": "string"
+              },
+              "name": "modules",
+              "doc": "The modules that exist in this template row",
+              "Urn": "Urn",
+              "urn_is_array": true
+            }
+          ],
+          "doc": "A row of modules contained in a template"
+        }
+      },
+      "name": "rows",
+      "doc": "The rows of modules contained in this template"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "DataHubPageTemplateAssetSummary",
+          "namespace": "com.linkedin.pegasus2avro.template",
+          "fields": [
+            {
+              "type": [
+                "null",
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "record",
+                    "name": "SummaryElement",
+                    "namespace": "com.linkedin.pegasus2avro.template",
+                    "fields": [
+                      {
+                        "type": {
+                          "type": "enum",
+                          "name": "SummaryElementType",
+                          "namespace": "com.linkedin.pegasus2avro.template",
+                          "symbols": [
+                            "CREATED",
+                            "TAGS",
+                            "GLOSSARY_TERMS",
+                            "OWNERS",
+                            "DOMAIN",
+                            "STRUCTURED_PROPERTY"
+                          ]
+                        },
+                        "name": "elementType",
+                        "doc": "The type of element/property"
+                      },
+                      {
+                        "Relationship": {
+                          "entityTypes": [
+                            "structuredProperty"
+                          ],
+                          "name": "ContainsStructuredProperty"
+                        },
+                        "java": {
+                          "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                        },
+                        "type": [
+                          "null",
+                          "string"
+                        ],
+                        "name": "structuredPropertyUrn",
+                        "default": null,
+                        "doc": "The urn of the structured property shown. Required if propertyType is STRUCTURED_PROPERTY",
+                        "Urn": "Urn",
+                        "entityTypes": [
+                          "structuredProperty"
+                        ]
+                      }
+                    ],
+                    "doc": "Info for a given asset summary element"
+                  }
+                }
+              ],
+              "name": "summaryElements",
+              "default": null,
+              "doc": "The optional list of properties shown on an asset summary page header."
+            }
+          ],
+          "doc": "The page template info for asset summaries"
+        }
+      ],
+      "name": "assetSummary",
+      "default": null,
+      "doc": "The optional info for asset summaries. Should be populated if surfaceType is ASSET_SUMMARY"
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "DataHubPageTemplateSurface",
+        "namespace": "com.linkedin.pegasus2avro.template",
+        "fields": [
+          {
+            "Searchable": {
+              "fieldType": "KEYWORD"
+            },
+            "type": {
+              "type": "enum",
+              "symbolDocs": {
+                "ASSET_SUMMARY": "This template applies to what to display on asset summary pages",
+                "HOME_PAGE": "This template applies to what to display on the home page for users."
+              },
+              "name": "PageTemplateSurfaceType",
+              "namespace": "com.linkedin.pegasus2avro.template",
+              "symbols": [
+                "HOME_PAGE",
+                "ASSET_SUMMARY"
+              ]
+            },
+            "name": "surfaceType",
+            "doc": "Where exactly is this template being used"
+          }
+        ],
+        "doc": "Info about the surface area of the product that this template is deployed in"
+      },
+      "name": "surface",
+      "doc": "Info about the surface area of the product that this template is deployed in"
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "DataHubPageTemplateVisibility",
+        "namespace": "com.linkedin.pegasus2avro.template",
+        "fields": [
+          {
+            "Searchable": {
+              "fieldType": "KEYWORD"
+            },
+            "type": {
+              "type": "enum",
+              "symbolDocs": {
+                "GLOBAL": "This template is used across users",
+                "PERSONAL": "This template is used for individual use only"
+              },
+              "name": "PageTemplateScope",
+              "namespace": "com.linkedin.pegasus2avro.template",
+              "symbols": [
+                "PERSONAL",
+                "GLOBAL"
+              ]
+            },
+            "name": "scope",
+            "doc": "The scope of this template and who can use/see it"
+          }
+        ],
+        "doc": "Info about the visibility of this template"
+      },
+      "name": "visibility",
+      "doc": "Info about the visibility of this template"
+    },
+    {
+      "Searchable": {
+        "/actor": {
+          "fieldName": "createdBy",
+          "fieldType": "URN"
+        },
+        "/time": {
+          "fieldName": "createdAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "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": "created",
+      "doc": "Audit stamp for when and by whom this template was created"
+    },
+    {
+      "Searchable": {
+        "/time": {
+          "fieldName": "lastModifiedAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": "com.linkedin.pegasus2avro.common.AuditStamp",
+      "name": "lastModified",
+      "doc": "Audit stamp for when and by whom this template was last updated"
+    }
+  ],
+  "doc": "The main properties of a DataHub page template"
+}

datahub/metadata/schemas/DataHubPolicyInfo.avsc

@@ -110,13 +110,15 @@
                                 "type": "enum",
                                 "symbolDocs": {
                                   "EQUALS": "Whether the field matches the value",
+                                  "NOT_EQUALS": "Whether the field does not match the value",
                                   "STARTS_WITH": "Whether the field value starts with the value"
                                 },
                                 "name": "PolicyMatchCondition",
                                 "namespace": "com.linkedin.pegasus2avro.policy",
                                 "symbols": [
                                   "EQUALS",
-                                  "STARTS_WITH"
+                                  "STARTS_WITH",
+                                  "NOT_EQUALS"
                                 ],
                                 "doc": "The matching condition in a filter criterion"
                               },
@@ -138,6 +140,15 @@
               "name": "filter",
               "default": null,
               "doc": "Filter to apply privileges to"
+            },
+            {
+              "type": [
+                "null",
+                "com.linkedin.pegasus2avro.policy.PolicyMatchFilter"
+              ],
+              "name": "privilegeConstraints",
+              "default": null,
+              "doc": "Constraints around what sub-resources operations are allowed to modify, i.e. NOT_EQUALS - cannot modify a particular defined tag, EQUALS - can only modify a particular defined tag, STARTS_WITH - can only modify a tag starting with xyz"
             }
           ],
           "doc": "Information used to filter DataHub resource."

datahub/metadata/schemas/DataJobInfo.avsc

@@ -213,13 +213,17 @@
             "DEV": "Designates development fabrics",
             "EI": "Designates early-integration fabrics",
             "NON_PROD": "Designates non-production fabrics",
+            "PRD": "Alternative Prod spelling",
             "PRE": "Designates pre-production fabrics",
             "PROD": "Designates production fabrics",
             "QA": "Designates quality assurance fabrics",
             "RVW": "Designates review fabrics",
             "SANDBOX": "Designates sandbox fabrics",
+            "SBX": "Alternative spelling for sandbox",
+            "SIT": "System Integration Testing",
             "STG": "Designates staging fabrics",
             "TEST": "Designates testing fabrics",
+            "TST": "Alternative Test spelling",
             "UAT": "Designates user acceptance testing fabrics"
           },
           "name": "FabricType",
@@ -236,6 +240,10 @@
             "PROD",
             "CORP",
             "RVW",
+            "PRD",
+            "TST",
+            "SIT",
+            "SBX",
             "SANDBOX"
           ],
           "doc": "Fabric group type"

datahub/metadata/schemas/DataJobInputOutput.avsc

@@ -375,6 +375,14 @@
                 "doc": "The type of upstream entity"
               },
               {
+                "Searchable": {
+                  "/*": {
+                    "fieldName": "fineGrainedUpstreams",
+                    "fieldType": "URN",
+                    "hasValuesFieldName": "hasFineGrainedUpstreams",
+                    "queryByDefault": false
+                  }
+                },
                 "type": [
                   "null",
                   {

datahub/metadata/schemas/DataJobKey.avsc

@@ -8,6 +8,7 @@
       "datahubIngestionRunSummary",
       "datahubIngestionCheckpoint",
       "domains",
+      "applications",
       "deprecation",
       "versionInfo",
       "dataJobInfo",