acryl-datahub 1.1.0.5rc3__py3-none-any.whl → 1.1.0.5rc5__py3-none-any.whl

datahub/metadata/_urns/urn_defs.py

@@ -1395,6 +1395,62 @@ class GlossaryTermUrn(_SpecificUrn):
     def name(self) -> str:
         return self._entity_ids[0]
 
+if TYPE_CHECKING:
+    from datahub.metadata.schema_classes import DataHubPageTemplateKeyClass
+
+class DataHubPageTemplateUrn(_SpecificUrn):
+    ENTITY_TYPE: ClassVar[Literal["dataHubPageTemplate"]] = "dataHubPageTemplate"
+    _URN_PARTS: ClassVar[int] = 1
+
+    def __init__(self, id: Union["DataHubPageTemplateUrn", str], *, _allow_coercion: bool = True) -> None:
+        if _allow_coercion:
+            # Field coercion logic (if any is required).
+            if isinstance(id, str):
+                if id.startswith('urn:li:'):
+                    try:
+                        id = DataHubPageTemplateUrn.from_string(id)
+                    except InvalidUrnError:
+                        raise InvalidUrnError(f'Expecting a DataHubPageTemplateUrn but got {id}')
+                else:
+                    id = UrnEncoder.encode_string(id)
+
+        # Validation logic.
+        if not id:
+            raise InvalidUrnError("DataHubPageTemplateUrn id cannot be empty")
+        if isinstance(id, DataHubPageTemplateUrn):
+            id = id.id
+        elif isinstance(id, Urn):
+            raise InvalidUrnError(f'Expecting a DataHubPageTemplateUrn but got {id}')
+        if UrnEncoder.contains_reserved_char(id):
+            raise InvalidUrnError(f'DataHubPageTemplateUrn id contains reserved characters')
+
+        super().__init__(self.ENTITY_TYPE, [id])
+
+    @classmethod
+    def _parse_ids(cls, entity_ids: List[str]) -> "DataHubPageTemplateUrn":
+        if len(entity_ids) != cls._URN_PARTS:
+            raise InvalidUrnError(f"DataHubPageTemplateUrn should have {cls._URN_PARTS} parts, got {len(entity_ids)}: {entity_ids}")
+        return cls(id=entity_ids[0], _allow_coercion=False)
+
+    @classmethod
+    def underlying_key_aspect_type(cls) -> Type["DataHubPageTemplateKeyClass"]:
+        from datahub.metadata.schema_classes import DataHubPageTemplateKeyClass
+
+        return DataHubPageTemplateKeyClass
+
+    def to_key_aspect(self) -> "DataHubPageTemplateKeyClass":
+        from datahub.metadata.schema_classes import DataHubPageTemplateKeyClass
+
+        return DataHubPageTemplateKeyClass(id=self.id)
+
+    @classmethod
+    def from_key_aspect(cls, key_aspect: "DataHubPageTemplateKeyClass") -> "DataHubPageTemplateUrn":
+        return cls(id=key_aspect.id)
+
+    @property
+    def id(self) -> str:
+        return self._entity_ids[0]
+
 if TYPE_CHECKING:
     from datahub.metadata.schema_classes import CorpGroupKeyClass
 
@@ -1919,6 +1975,62 @@ class TagUrn(_SpecificUrn):
     def name(self) -> str:
         return self._entity_ids[0]
 
+if TYPE_CHECKING:
+    from datahub.metadata.schema_classes import DataHubPageModuleKeyClass
+
+class DataHubPageModuleUrn(_SpecificUrn):
+    ENTITY_TYPE: ClassVar[Literal["dataHubPageModule"]] = "dataHubPageModule"
+    _URN_PARTS: ClassVar[int] = 1
+
+    def __init__(self, id: Union["DataHubPageModuleUrn", str], *, _allow_coercion: bool = True) -> None:
+        if _allow_coercion:
+            # Field coercion logic (if any is required).
+            if isinstance(id, str):
+                if id.startswith('urn:li:'):
+                    try:
+                        id = DataHubPageModuleUrn.from_string(id)
+                    except InvalidUrnError:
+                        raise InvalidUrnError(f'Expecting a DataHubPageModuleUrn but got {id}')
+                else:
+                    id = UrnEncoder.encode_string(id)
+
+        # Validation logic.
+        if not id:
+            raise InvalidUrnError("DataHubPageModuleUrn id cannot be empty")
+        if isinstance(id, DataHubPageModuleUrn):
+            id = id.id
+        elif isinstance(id, Urn):
+            raise InvalidUrnError(f'Expecting a DataHubPageModuleUrn but got {id}')
+        if UrnEncoder.contains_reserved_char(id):
+            raise InvalidUrnError(f'DataHubPageModuleUrn id contains reserved characters')
+
+        super().__init__(self.ENTITY_TYPE, [id])
+
+    @classmethod
+    def _parse_ids(cls, entity_ids: List[str]) -> "DataHubPageModuleUrn":
+        if len(entity_ids) != cls._URN_PARTS:
+            raise InvalidUrnError(f"DataHubPageModuleUrn should have {cls._URN_PARTS} parts, got {len(entity_ids)}: {entity_ids}")
+        return cls(id=entity_ids[0], _allow_coercion=False)
+
+    @classmethod
+    def underlying_key_aspect_type(cls) -> Type["DataHubPageModuleKeyClass"]:
+        from datahub.metadata.schema_classes import DataHubPageModuleKeyClass
+
+        return DataHubPageModuleKeyClass
+
+    def to_key_aspect(self) -> "DataHubPageModuleKeyClass":
+        from datahub.metadata.schema_classes import DataHubPageModuleKeyClass
+
+        return DataHubPageModuleKeyClass(id=self.id)
+
+    @classmethod
+    def from_key_aspect(cls, key_aspect: "DataHubPageModuleKeyClass") -> "DataHubPageModuleUrn":
+        return cls(id=key_aspect.id)
+
+    @property
+    def id(self) -> str:
+        return self._entity_ids[0]
+
 if TYPE_CHECKING:
     from datahub.metadata.schema_classes import DataHubRoleKeyClass
 

datahub/metadata/com/linkedin/pegasus2avro/identity/__init__.py

@@ -12,6 +12,7 @@ from .....schema_classes import CorpGroupInfoClass
 from .....schema_classes import CorpUserAppearanceSettingsClass
 from .....schema_classes import CorpUserCredentialsClass
 from .....schema_classes import CorpUserEditableInfoClass
+from .....schema_classes import CorpUserHomePageSettingsClass
 from .....schema_classes import CorpUserInfoClass
 from .....schema_classes import CorpUserSettingsClass
 from .....schema_classes import CorpUserStatusClass
@@ -27,6 +28,7 @@ CorpGroupInfo = CorpGroupInfoClass
 CorpUserAppearanceSettings = CorpUserAppearanceSettingsClass
 CorpUserCredentials = CorpUserCredentialsClass
 CorpUserEditableInfo = CorpUserEditableInfoClass
+CorpUserHomePageSettings = CorpUserHomePageSettingsClass
 CorpUserInfo = CorpUserInfoClass
 CorpUserSettings = CorpUserSettingsClass
 CorpUserStatus = CorpUserStatusClass

datahub/metadata/com/linkedin/pegasus2avro/metadata/key/__init__.py

@@ -20,6 +20,8 @@ from ......schema_classes import DataHubActionKeyClass
 from ......schema_classes import DataHubConnectionKeyClass
 from ......schema_classes import DataHubIngestionSourceKeyClass
 from ......schema_classes import DataHubOpenAPISchemaKeyClass
+from ......schema_classes import DataHubPageModuleKeyClass
+from ......schema_classes import DataHubPageTemplateKeyClass
 from ......schema_classes import DataHubPersonaKeyClass
 from ......schema_classes import DataHubPolicyKeyClass
 from ......schema_classes import DataHubRetentionKeyClass
@@ -74,6 +76,8 @@ DataHubActionKey = DataHubActionKeyClass
 DataHubConnectionKey = DataHubConnectionKeyClass
 DataHubIngestionSourceKey = DataHubIngestionSourceKeyClass
 DataHubOpenAPISchemaKey = DataHubOpenAPISchemaKeyClass
+DataHubPageModuleKey = DataHubPageModuleKeyClass
+DataHubPageTemplateKey = DataHubPageTemplateKeyClass
 DataHubPersonaKey = DataHubPersonaKeyClass
 DataHubPolicyKey = DataHubPolicyKeyClass
 DataHubRetentionKey = DataHubRetentionKeyClass

datahub/metadata/com/linkedin/pegasus2avro/module/__init__.py

@@ -0,0 +1,27 @@
+# mypy: ignore-errors
+# flake8: noqa
+
+# This file is autogenerated by /metadata-ingestion/scripts/avro_codegen.py
+# Do not modify manually!
+
+# pylint: skip-file
+# fmt: off
+# isort: skip_file
+from .....schema_classes import DataHubPageModuleParamsClass
+from .....schema_classes import DataHubPageModulePropertiesClass
+from .....schema_classes import DataHubPageModuleTypeClass
+from .....schema_classes import DataHubPageModuleVisibilityClass
+from .....schema_classes import LinkModuleParamsClass
+from .....schema_classes import PageModuleScopeClass
+from .....schema_classes import RichTextModuleParamsClass
+
+
+DataHubPageModuleParams = DataHubPageModuleParamsClass
+DataHubPageModuleProperties = DataHubPageModulePropertiesClass
+DataHubPageModuleType = DataHubPageModuleTypeClass
+DataHubPageModuleVisibility = DataHubPageModuleVisibilityClass
+LinkModuleParams = LinkModuleParamsClass
+PageModuleScope = PageModuleScopeClass
+RichTextModuleParams = RichTextModuleParamsClass
+
+# fmt: on

datahub/metadata/com/linkedin/pegasus2avro/settings/global/__init__.py

@@ -8,6 +8,7 @@
 # fmt: off
 # isort: skip_file
 from ......schema_classes import DocPropagationFeatureSettingsClass
+from ......schema_classes import GlobalHomePageSettingsClass
 from ......schema_classes import GlobalSettingsInfoClass
 from ......schema_classes import GlobalViewsSettingsClass
 from ......schema_classes import OidcSettingsClass
@@ -15,6 +16,7 @@ from ......schema_classes import SsoSettingsClass
 
 
 DocPropagationFeatureSettings = DocPropagationFeatureSettingsClass
+GlobalHomePageSettings = GlobalHomePageSettingsClass
 GlobalSettingsInfo = GlobalSettingsInfoClass
 GlobalViewsSettings = GlobalViewsSettingsClass
 OidcSettings = OidcSettingsClass

datahub/metadata/com/linkedin/pegasus2avro/template/__init__.py

@@ -0,0 +1,25 @@
+# mypy: ignore-errors
+# flake8: noqa
+
+# This file is autogenerated by /metadata-ingestion/scripts/avro_codegen.py
+# Do not modify manually!
+
+# pylint: skip-file
+# fmt: off
+# isort: skip_file
+from .....schema_classes import DataHubPageTemplatePropertiesClass
+from .....schema_classes import DataHubPageTemplateRowClass
+from .....schema_classes import DataHubPageTemplateSurfaceClass
+from .....schema_classes import DataHubPageTemplateVisibilityClass
+from .....schema_classes import PageTemplateScopeClass
+from .....schema_classes import PageTemplateSurfaceTypeClass
+
+
+DataHubPageTemplateProperties = DataHubPageTemplatePropertiesClass
+DataHubPageTemplateRow = DataHubPageTemplateRowClass
+DataHubPageTemplateSurface = DataHubPageTemplateSurfaceClass
+DataHubPageTemplateVisibility = DataHubPageTemplateVisibilityClass
+PageTemplateScope = PageTemplateScopeClass
+PageTemplateSurfaceType = PageTemplateSurfaceTypeClass
+
+# fmt: on

datahub/metadata/schema.avsc

@@ -737,6 +737,31 @@
         "name": "notificationSettings",
         "default": null,
         "doc": "Notification settings for a user"
+      },
+      {
+        "type": [
+          "null",
+          {
+            "type": "record",
+            "name": "CorpUserHomePageSettings",
+            "namespace": "com.linkedin.pegasus2avro.identity",
+            "fields": [
+              {
+                "java": {
+                  "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                },
+                "Urn": "Urn",
+                "type": "string",
+                "name": "pageTemplate",
+                "doc": "The page template that will be rendered in the UI by default for this user"
+              }
+            ],
+            "doc": "Settings related to the home page for a user"
+          }
+        ],
+        "name": "homePage",
+        "default": null,
+        "doc": "Settings related to the home page for a user"
       }
     ],
     "doc": "Settings that a user can customize through the datahub ui"
@@ -3259,6 +3284,165 @@
       }
     ]
   },
+  {
+    "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": {
+            "ASSET_COLLECTION": "A module with a collection of assets",
+            "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",
+            "RICH_TEXT": "Module containing rich text to be rendered",
+            "SUBSCRIBED_ASSETS": "Module displaying assets subscribed to by a given user"
+          },
+          "name": "DataHubPageModuleType",
+          "namespace": "com.linkedin.pegasus2avro.module",
+          "symbols": [
+            "LINK",
+            "RICH_TEXT",
+            "ASSET_COLLECTION",
+            "HIERARCHY",
+            "OWNED_ASSETS",
+            "SUBSCRIBED_ASSETS",
+            "DOMAINS"
+          ],
+          "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": [
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "Urn": "Urn",
+                      "type": "string",
+                      "name": "linkUrn"
+                    }
+                  ]
+                }
+              ],
+              "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"
+            }
+          ],
+          "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": "com.linkedin.pegasus2avro.common.AuditStamp",
+        "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"
+  },
   {
     "type": "record",
     "Aspect": {
@@ -11465,6 +11649,138 @@
     ],
     "doc": "Information about a DataHub Post."
   },
+  {
+    "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": [
+              {
+                "Urn": "Urn",
+                "urn_is_array": true,
+                "type": {
+                  "type": "array",
+                  "items": "string"
+                },
+                "name": "modules",
+                "doc": "The modules that exist in this template row"
+              }
+            ],
+            "doc": "A row of modules contained in a template"
+          }
+        },
+        "name": "rows",
+        "doc": "The rows of modules contained in this template"
+      },
+      {
+        "type": {
+          "type": "record",
+          "name": "DataHubPageTemplateSurface",
+          "namespace": "com.linkedin.pegasus2avro.template",
+          "fields": [
+            {
+              "Searchable": {
+                "fieldType": "KEYWORD"
+              },
+              "type": {
+                "type": "enum",
+                "symbolDocs": {
+                  "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"
+                ]
+              },
+              "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": "com.linkedin.pegasus2avro.common.AuditStamp",
+        "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"
+  },
   {
     "type": "record",
     "Aspect": {
@@ -12251,6 +12567,27 @@
     ],
     "doc": "Key for a GlossaryTerm"
   },
+  {
+    "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"
+  },
   {
     "type": "record",
     "Aspect": {
@@ -12571,6 +12908,27 @@
     ],
     "doc": "Key for a Tag"
   },
+  {
+    "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"
+  },
   {
     "type": "record",
     "Aspect": {
@@ -18148,6 +18506,31 @@
           "columnPropagationEnabled": true
         },
         "doc": "Settings related to the documentation propagation feature"
+      },
+      {
+        "type": [
+          "null",
+          {
+            "type": "record",
+            "name": "GlobalHomePageSettings",
+            "namespace": "com.linkedin.pegasus2avro.settings.global",
+            "fields": [
+              {
+                "java": {
+                  "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                },
+                "Urn": "Urn",
+                "type": "string",
+                "name": "defaultTemplate",
+                "doc": "The urn that will be rendered in the UI by default for all users"
+              }
+            ],
+            "doc": "Global settings related to the home page for an instance"
+          }
+        ],
+        "name": "homePage",
+        "default": null,
+        "doc": "Global settings related to the home page for an instance"
       }
     ],
     "doc": "DataHub Global platform settings. Careful - these should not be modified by the outside world!"

datahub/metadata/schemas/CorpUserSettings.avsc

@@ -159,6 +159,31 @@
       "name": "notificationSettings",
       "default": null,
       "doc": "Notification settings for a user"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "CorpUserHomePageSettings",
+          "namespace": "com.linkedin.pegasus2avro.identity",
+          "fields": [
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": "string",
+              "name": "pageTemplate",
+              "doc": "The page template that will be rendered in the UI by default for this user",
+              "Urn": "Urn"
+            }
+          ],
+          "doc": "Settings related to the home page for a user"
+        }
+      ],
+      "name": "homePage",
+      "default": null,
+      "doc": "Settings related to the home page for a user"
     }
   ],
   "doc": "Settings that a user can customize through the datahub ui"