acryl-datahub 1.2.0.7rc3__py3-none-any.whl → 1.2.0.8__py3-none-any.whl

datahub/metadata/schema.avsc

@@ -3411,6 +3411,80 @@
         "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"
+                          },
+                          "Urn": "Urn",
+                          "entityTypes": [
+                            "structuredProperty"
+                          ],
+                          "type": [
+                            "null",
+                            "string"
+                          ],
+                          "name": "structuredPropertyUrn",
+                          "default": null,
+                          "doc": "The urn of the structured property shown. Required if propertyType is STRUCTURED_PROPERTY"
+                        }
+                      ],
+                      "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",
@@ -3424,12 +3498,14 @@
               "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"
+                  "HOME_PAGE",
+                  "ASSET_SUMMARY"
                 ]
               },
               "name": "surfaceType",
@@ -4646,7 +4722,8 @@
         "forms",
         "testResults",
         "subTypes",
-        "displayProperties"
+        "displayProperties",
+        "assetSettings"
       ]
     },
     "name": "GlossaryNodeKey",
@@ -5042,7 +5119,8 @@
         "structuredProperties",
         "forms",
         "testResults",
-        "displayProperties"
+        "displayProperties",
+        "assetSettings"
       ],
       "entityDoc": "A data domain within an organization."
     },
@@ -5077,7 +5155,8 @@
         "structuredProperties",
         "forms",
         "testResults",
-        "subTypes"
+        "subTypes",
+        "assetSettings"
       ]
     },
     "name": "GlossaryTermKey",
@@ -10036,11 +10115,11 @@
           "filterNameOverride": "Priority"
         },
         "type": [
-          "int",
-          "null"
+          "null",
+          "int"
         ],
         "name": "priority",
-        "default": 0,
+        "default": null,
         "doc": "A numeric severity or priority for the incident. On the UI we will translate this into something easy to understand.\nCurrently supported: 0 - CRITICAL, 1 - HIGH, 2 - MED, 3 - LOW\n(We probably should have modeled as an enum)"
       },
       {
@@ -10702,7 +10781,8 @@
         "structuredProperties",
         "forms",
         "testResults",
-        "subTypes"
+        "subTypes",
+        "assetSettings"
       ]
     },
     "name": "DataProductKey",
@@ -11920,6 +12000,69 @@
     ],
     "doc": "DataHub Global platform settings. Careful - these should not be modified by the outside world!"
   },
+  {
+    "type": "record",
+    "Aspect": {
+      "name": "assetSettings"
+    },
+    "name": "AssetSettings",
+    "namespace": "com.linkedin.pegasus2avro.settings.asset",
+    "fields": [
+      {
+        "type": [
+          "null",
+          {
+            "type": "record",
+            "name": "AssetSummarySettings",
+            "namespace": "com.linkedin.pegasus2avro.settings.asset",
+            "fields": [
+              {
+                "Relationship": {
+                  "/*/template": {
+                    "entityTypes": [
+                      "dataHubPageTemplate"
+                    ],
+                    "name": "HasSummaryTemplate"
+                  }
+                },
+                "type": [
+                  {
+                    "type": "array",
+                    "items": {
+                      "type": "record",
+                      "name": "AssetSummarySettingsTemplate",
+                      "namespace": "com.linkedin.pegasus2avro.settings.asset",
+                      "fields": [
+                        {
+                          "java": {
+                            "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                          },
+                          "Urn": "Urn",
+                          "type": "string",
+                          "name": "template",
+                          "doc": "The urn of the template"
+                        }
+                      ],
+                      "doc": "Object containing the template and any additional info for asset summary settings"
+                    }
+                  },
+                  "null"
+                ],
+                "name": "templates",
+                "default": [],
+                "doc": "The list of templates applied to this asset in order. Right now we only expect one."
+              }
+            ],
+            "doc": "Information related to the asset summary for this asset"
+          }
+        ],
+        "name": "assetSummary",
+        "default": null,
+        "doc": "Information related to the asset summary for this asset"
+      }
+    ],
+    "doc": "Settings associated with this asset"
+  },
   {
     "type": "record",
     "Aspect": {
@@ -14795,9 +14938,6 @@
         "doc": "The display name of the property. This is the name that will be shown in the UI and can be used to look up the property id."
       },
       {
-        "Searchable": {
-          "fieldType": "URN"
-        },
         "UrnValidation": {
           "entityTypes": [
             "dataType"
@@ -19455,11 +19595,15 @@
         "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",
+            "RELATED_TERMS": "Module displaying the related terms of a given glossary term",
             "RICH_TEXT": "Module containing rich text to be rendered"
           },
           "name": "DataHubPageModuleType",
@@ -19470,7 +19614,11 @@
             "ASSET_COLLECTION",
             "HIERARCHY",
             "OWNED_ASSETS",
-            "DOMAINS"
+            "DOMAINS",
+            "ASSETS",
+            "CHILD_HIERARCHY",
+            "DATA_PRODUCTS",
+            "RELATED_TERMS"
           ],
           "doc": "Enum containing the types of page modules that there are"
         },

datahub/metadata/schemas/AssetSettings.avsc

@@ -0,0 +1,63 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "assetSettings"
+  },
+  "name": "AssetSettings",
+  "namespace": "com.linkedin.pegasus2avro.settings.asset",
+  "fields": [
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "AssetSummarySettings",
+          "namespace": "com.linkedin.pegasus2avro.settings.asset",
+          "fields": [
+            {
+              "Relationship": {
+                "/*/template": {
+                  "entityTypes": [
+                    "dataHubPageTemplate"
+                  ],
+                  "name": "HasSummaryTemplate"
+                }
+              },
+              "type": [
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "record",
+                    "name": "AssetSummarySettingsTemplate",
+                    "namespace": "com.linkedin.pegasus2avro.settings.asset",
+                    "fields": [
+                      {
+                        "java": {
+                          "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                        },
+                        "type": "string",
+                        "name": "template",
+                        "doc": "The urn of the template",
+                        "Urn": "Urn"
+                      }
+                    ],
+                    "doc": "Object containing the template and any additional info for asset summary settings"
+                  }
+                },
+                "null"
+              ],
+              "name": "templates",
+              "default": [],
+              "doc": "The list of templates applied to this asset in order. Right now we only expect one."
+            }
+          ],
+          "doc": "Information related to the asset summary for this asset"
+        }
+      ],
+      "name": "assetSummary",
+      "default": null,
+      "doc": "Information related to the asset summary for this asset"
+    }
+  ],
+  "doc": "Settings associated with this asset"
+}

datahub/metadata/schemas/DataHubPageModuleProperties.avsc

@@ -18,11 +18,15 @@
       "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",
+          "RELATED_TERMS": "Module displaying the related terms of a given glossary term",
           "RICH_TEXT": "Module containing rich text to be rendered"
         },
         "name": "DataHubPageModuleType",
@@ -33,7 +37,11 @@
           "ASSET_COLLECTION",
           "HIERARCHY",
           "OWNED_ASSETS",
-          "DOMAINS"
+          "DOMAINS",
+          "ASSETS",
+          "CHILD_HIERARCHY",
+          "DATA_PRODUCTS",
+          "RELATED_TERMS"
         ],
         "doc": "Enum containing the types of page modules that there are"
       },

datahub/metadata/schemas/DataHubPageTemplateProperties.avsc

@@ -39,6 +39,80 @@
       "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",
@@ -52,12 +126,14 @@
             "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"
+                "HOME_PAGE",
+                "ASSET_SUMMARY"
               ]
             },
             "name": "surfaceType",

datahub/metadata/schemas/DataProductKey.avsc

@@ -16,7 +16,8 @@
       "structuredProperties",
       "forms",
       "testResults",
-      "subTypes"
+      "subTypes",
+      "assetSettings"
     ]
   },
   "name": "DataProductKey",

datahub/metadata/schemas/DomainKey.avsc

@@ -11,7 +11,8 @@
       "structuredProperties",
       "forms",
       "testResults",
-      "displayProperties"
+      "displayProperties",
+      "assetSettings"
     ],
     "entityDoc": "A data domain within an organization."
   },

datahub/metadata/schemas/GlossaryNodeKey.avsc

@@ -13,7 +13,8 @@
       "forms",
       "testResults",
       "subTypes",
-      "displayProperties"
+      "displayProperties",
+      "assetSettings"
     ]
   },
   "name": "GlossaryNodeKey",

datahub/metadata/schemas/GlossaryTermKey.avsc

@@ -18,7 +18,8 @@
       "structuredProperties",
       "forms",
       "testResults",
-      "subTypes"
+      "subTypes",
+      "assetSettings"
     ]
   },
   "name": "GlossaryTermKey",

datahub/metadata/schemas/IncidentInfo.avsc

@@ -103,11 +103,11 @@
         "filterNameOverride": "Priority"
       },
       "type": [
-        "int",
-        "null"
+        "null",
+        "int"
       ],
       "name": "priority",
-      "default": 0,
+      "default": null,
       "doc": "A numeric severity or priority for the incident. On the UI we will translate this into something easy to understand.\nCurrently supported: 0 - CRITICAL, 1 - HIGH, 2 - MED, 3 - LOW\n(We probably should have modeled as an enum)"
     },
     {

datahub/metadata/schemas/StructuredPropertyDefinition.avsc

@@ -23,9 +23,6 @@
       "doc": "The display name of the property. This is the name that will be shown in the UI and can be used to look up the property id."
     },
     {
-      "Searchable": {
-        "fieldType": "URN"
-      },
       "UrnValidation": {
         "entityTypes": [
           "dataType"

datahub/sdk/chart.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 from datetime import datetime
 from typing import Dict, List, Optional, Type, Union
 
+from deprecated.sphinx import deprecated
 from typing_extensions import Self
 
 import datahub.metadata.schema_classes as models
@@ -23,11 +24,13 @@ from datahub.sdk._shared import (
     HasTerms,
     LinksInputType,
     OwnersInputType,
+    ParentContainerInputType,
     TagsInputType,
     TermsInputType,
 )
 from datahub.sdk.dataset import Dataset
 from datahub.sdk.entity import Entity, ExtraAspectsType
+from datahub.utilities.sentinels import Unset, unset
 
 
 class Chart(
@@ -70,14 +73,15 @@ class Chart(
         last_refreshed: Optional[datetime] = None,
         chart_type: Optional[Union[str, models.ChartTypeClass]] = None,
         access: Optional[str] = None,
+        input_datasets: Optional[List[Union[DatasetUrnOrStr, Dataset]]] = None,
         # Standard aspects.
+        parent_container: ParentContainerInputType | Unset = unset,
         subtype: Optional[str] = None,
         owners: Optional[OwnersInputType] = None,
         links: Optional[LinksInputType] = None,
         tags: Optional[TagsInputType] = None,
         terms: Optional[TermsInputType] = None,
         domain: Optional[DomainInputType] = None,
-        input_datasets: Optional[List[Union[DatasetUrnOrStr, Dataset]]] = None,
         extra_aspects: ExtraAspectsType = None,
     ):
         """Initialize a new Chart instance."""
@@ -91,19 +95,31 @@ class Chart(
 
         self._set_platform_instance(platform, platform_instance)
 
-        # Set additional properties
+        self._ensure_chart_props(display_name=display_name)
+
+        if display_name is not None:
+            self.set_display_name(display_name)
+        if description is not None:
+            self.set_description(description)
         if external_url is not None:
             self.set_external_url(external_url)
         if chart_url is not None:
             self.set_chart_url(chart_url)
         if custom_properties is not None:
             self.set_custom_properties(custom_properties)
+        if last_modified is not None:
+            self.set_last_modified(last_modified)
         if last_refreshed is not None:
             self.set_last_refreshed(last_refreshed)
         if chart_type is not None:
             self.set_chart_type(chart_type)
         if access is not None:
             self.set_access(access)
+        if input_datasets is not None:
+            self.set_input_datasets(input_datasets)
+
+        if parent_container is not unset:
+            self._set_container(parent_container)
         if subtype is not None:
             self.set_subtype(subtype)
         if owners is not None:
@@ -116,14 +132,6 @@ class Chart(
             self.set_terms(terms)
         if domain is not None:
             self.set_domain(domain)
-        if last_modified is not None:
-            self.set_last_modified(last_modified)
-        if input_datasets is not None:
-            self.set_input_datasets(input_datasets)
-        if description is not None:
-            self.set_description(description)
-        if display_name is not None:
-            self.set_display_name(display_name)
 
     @classmethod
     def _new_from_graph(cls, urn: Urn, current_aspects: models.AspectBag) -> Self:
@@ -139,11 +147,13 @@ class Chart(
         assert isinstance(self._urn, ChartUrn)
         return self._urn
 
-    def _ensure_chart_props(self) -> models.ChartInfoClass:
+    def _ensure_chart_props(
+        self, display_name: Optional[str] = None
+    ) -> models.ChartInfoClass:
         """Ensure chart properties exist, using a safer approach."""
         return self._setdefault_aspect(
             models.ChartInfoClass(
-                title=self.urn.chart_id,
+                title=display_name or self.urn.chart_id,
                 description="",
                 lastModified=models.ChangeAuditStampsClass(),
             )
@@ -155,13 +165,15 @@ class Chart(
         return self.urn.chart_id
 
     @property
+    @deprecated("Use display_name instead", version="1.2.0.7")
     def title(self) -> str:
-        """Get the title of the chart."""
-        return self._ensure_chart_props().title
+        """Get the display name of the chart."""
+        return self.display_name
 
+    @deprecated("Use set_display_name instead", version="1.2.0.7")
     def set_title(self, title: str) -> None:
-        """Set the title of the chart."""
-        self._ensure_chart_props().title = title
+        """Set the display name of the chart."""
+        self.set_display_name(title)
 
     @property
     def description(self) -> Optional[str]:
@@ -173,13 +185,13 @@ class Chart(
         self._ensure_chart_props().description = description
 
     @property
-    def display_name(self) -> Optional[str]:
+    def display_name(self) -> str:
         """Get the display name of the chart."""
-        return self.title
+        return self._ensure_chart_props().title
 
     def set_display_name(self, display_name: str) -> None:
         """Set the display name of the chart."""
-        self.set_title(display_name)
+        self._ensure_chart_props().title = display_name
 
     @property
     def external_url(self) -> Optional[str]:
@@ -250,9 +262,11 @@ class Chart(
     def set_chart_type(self, chart_type: Union[str, models.ChartTypeClass]) -> None:
         """Set the type of the chart."""
         if isinstance(chart_type, str):
-            assert chart_type in get_enum_options(models.ChartTypeClass), (
-                f"Invalid chart type: {chart_type}"
-            )
+            chart_type_options = get_enum_options(models.ChartTypeClass)
+            if chart_type not in chart_type_options:
+                raise ValueError(
+                    f"Invalid chart type: {chart_type}; valid types are {chart_type_options}"
+                )
         self._ensure_chart_props().type = chart_type
 
     @property