feat(gooddata-sdk): report whether create_or_update created or updated

docs/content/en/latest/administration/organization/create_or_update_jwk.md

@@ -6,7 +6,7 @@ weight: 100
 api_ref: "CatalogOrganizationService.create_or_update_jwk"
 ---
 
-``create_or_update_jwk( jwk: CatalogJwk ) -> None``
+``create_or_update_jwk( jwk: CatalogJwk ) -> UpsertOutcome``
 
 Create a new jwk or overwrite an existing jwk with the same id.
 
@@ -18,4 +18,6 @@ Create a new jwk or overwrite an existing jwk with the same id.
 
 ## Returns
 
-_None_
+| type | description |
+| -- | -- |
+| UpsertOutcome | CREATED if the jwk did not exist yet, UPDATED if it did. |

docs/content/en/latest/administration/user-groups/create_or_update_user_group.md

@@ -19,7 +19,10 @@ User group entity object.
 {{< /parameter >}}
 {{% /parameters-block %}}
 
-{{% parameters-block title="Returns" None="yes" %}}
+{{% parameters-block title="Returns" %}}
+{{< parameter p_type="UpsertOutcome" >}}
+CREATED if the user group did not exist yet, UPDATED if it did.
+{{< /parameter >}}
 {{% /parameters-block %}}
 
 ## Example

docs/content/en/latest/administration/users/create_or_update_user.md

@@ -19,7 +19,10 @@ User entity object.
 {{< /parameter >}}
 {{% /parameters-block %}}
 
-{{% parameters-block title="Returns" None="yes" %}}
+{{% parameters-block title="Returns" %}}
+{{< parameter p_type="UpsertOutcome" >}}
+CREATED if the user did not exist yet, UPDATED if it did.
+{{< /parameter >}}
 {{% /parameters-block %}}
 
 ## Example

docs/content/en/latest/data/data-source/create_or_update_data_source.md

@@ -20,7 +20,10 @@ Catalog data source object
 
 {{% /parameters-block %}}
 
-{{% parameters-block title="Returns" None="yes"%}}
+{{% parameters-block title="Returns" %}}
+{{< parameter p_type="UpsertOutcome" >}}
+CREATED if the data source did not exist yet, UPDATED if it did.
+{{< /parameter >}}
 {{% /parameters-block %}}
 
 ### Example

docs/content/en/latest/workspace/workspaces/create_or_update.md

@@ -15,7 +15,10 @@ Creates a new workspace or overwrite an existing workspace with the same id.
 Data source Object, including physical data model.
 {{< /parameter >}}
 {{% /parameters-block %}}
-{{% parameters-block title="Returns" None="yes" %}}
+{{% parameters-block title="Returns" %}}
+{{< parameter p_type="UpsertOutcome" >}}
+CREATED if the workspace did not exist yet, UPDATED if it did.
+{{< /parameter >}}
 {{% /parameters-block %}}
 {{% parameters-block title="Raises" %}}
 {{< parameter p_type="Value Error" >}}

packages/gooddata-sdk/src/gooddata_sdk/__init__.py

@@ -177,6 +177,7 @@
     CatalogOrganizationPermissionAssignment,
 )
 from gooddata_sdk.catalog.rule import CatalogAssigneeRule
+from gooddata_sdk.catalog.types import UpsertOutcome
 from gooddata_sdk.catalog.user.declarative_model.user import (
     CatalogDeclarativeUser,
     CatalogDeclarativeUserPermission,

packages/gooddata-sdk/src/gooddata_sdk/catalog/data_source/service.py

@@ -35,6 +35,7 @@
 )
 from gooddata_sdk.catalog.data_source.entity_model.data_source import CatalogDataSource
 from gooddata_sdk.catalog.entity import ClientSecretCredentialsFromFile, TokenCredentialsFromFile
+from gooddata_sdk.catalog.types import UpsertOutcome
 from gooddata_sdk.catalog.workspace.declarative_model.workspace.logical_model.ldm import CatalogDeclarativeModel
 from gooddata_sdk.client import GoodDataApiClient
 from gooddata_sdk.utils import get_ds_credentials, load_all_entities_dict, read_layout_from_file
@@ -57,7 +58,7 @@ def __init__(self, api_client: GoodDataApiClient) -> None:
     def create_or_update_data_source(
         self,
         data_source: CatalogDataSource,
-    ) -> None:
+    ) -> UpsertOutcome:
         """Pushes the Data Source to the GoodData environment.
 
         Automatically decides, whether to create or update.
@@ -67,7 +68,8 @@ def create_or_update_data_source(
                 Catalog Data Source object
 
         Returns:
-            None
+            UpsertOutcome:
+                CREATED if the data source did not exist yet, UPDATED if it did.
         """
         try:
             self._entities_api.get_entity_data_sources(data_source.id)
@@ -77,6 +79,8 @@ def create_or_update_data_source(
             )
         except NotFoundException:
             self._entities_api.create_entity_data_sources(data_source.to_api())
+            return UpsertOutcome.CREATED
+        return UpsertOutcome.UPDATED
 
     def get_data_source(self, data_source_id: str) -> CatalogDataSource:
         """Retrieve Data Source entity using data source id.

packages/gooddata-sdk/src/gooddata_sdk/catalog/organization/service.py

@@ -43,6 +43,7 @@
 from gooddata_sdk.catalog.organization.entity_model.setting import CatalogOrganizationSetting
 from gooddata_sdk.catalog.organization.layout.identity_provider import CatalogDeclarativeIdentityProvider
 from gooddata_sdk.catalog.organization.layout.notification_channel import CatalogDeclarativeNotificationChannel
+from gooddata_sdk.catalog.types import UpsertOutcome
 from gooddata_sdk.client import GoodDataApiClient
 from gooddata_sdk.utils import load_all_entities, load_all_entities_dict
 
@@ -107,15 +108,16 @@ def update_allowed_origins(self, allowed_origins: list[str]) -> None:
         patch_document = JsonApiOrganizationPatchDocument(data=patch_data)
         self._entities_api.patch_entity_organizations(organization.id, patch_document)
 
-    def create_or_update_jwk(self, jwk: CatalogJwk) -> None:
+    def create_or_update_jwk(self, jwk: CatalogJwk) -> UpsertOutcome:
         """Create a new jwk or overwrite an existing jwk with the same id.
 
         Args:
             jwk (CatalogJwk):
                 Catalog Jwk object to be created or updated.
 
         Returns:
-            None
+            UpsertOutcome:
+                CREATED if the jwk did not exist yet, UPDATED if it did.
 
         Raises:
             ValueError: Jwk can not be updated.
@@ -126,6 +128,8 @@ def create_or_update_jwk(self, jwk: CatalogJwk) -> None:
             self._entities_api.update_entity_jwks(id=jwk.id, json_api_jwk_in_document=jwk_document.to_api())
         except NotFoundException:
             self._entities_api.create_entity_jwks(json_api_jwk_in_document=jwk_document.to_api())
+            return UpsertOutcome.CREATED
+        return UpsertOutcome.UPDATED
 
     def get_jwk(self, jwk_id: str) -> CatalogJwk:
         """Get an individual jwk.
@@ -473,15 +477,16 @@ def patch_identity_provider_attributes(self, identity_provider_id: str, attribut
             identity_provider_id, CatalogIdentityProvider.to_api_patch(identity_provider_id, attributes)
         )
 
-    def create_or_update_export_template(self, export_template: CatalogExportTemplate) -> None:
+    def create_or_update_export_template(self, export_template: CatalogExportTemplate) -> UpsertOutcome:
         """Create a new export template or overwrite an existing export template with the same id.
 
         Args:
             export_template (CatalogExportTemplate):
                 Catalog export template object to be created or updated.
 
         Returns:
-            None
+            UpsertOutcome:
+                CREATED if the export template did not exist yet, UPDATED if it did.
 
         Raises:
             ValueError: Export template cannot be updated.
@@ -500,6 +505,8 @@ def create_or_update_export_template(self, export_template: CatalogExportTemplat
                     data=export_template.to_api()
                 )
             )
+            return UpsertOutcome.CREATED
+        return UpsertOutcome.UPDATED
 
     def get_export_template(self, export_template_id: str) -> CatalogExportTemplate:
         """Get an individual export template.

packages/gooddata-sdk/src/gooddata_sdk/catalog/types.py

@@ -1,5 +1,20 @@
 # (C) 2022 GoodData Corporation
 from __future__ import annotations
 
+from enum import Enum
+
 # Use typing collection types to support python < py3.9
 ValidObjects = dict[str, set[str]]
+
+
+class UpsertOutcome(str, Enum):
+    """Which branch a ``create_or_update*`` method took.
+
+    The outcome is best-effort: it reports the branch the SDK chose after its
+    existence check, and that check is not atomic with the write that follows.
+    A concurrent actor can create or delete the entity in between, so treat the
+    value as informational rather than as an authoritative audit record.
+    """
+
+    CREATED = "created"
+    UPDATED = "updated"

packages/gooddata-sdk/src/gooddata_sdk/catalog/user/service.py

@@ -9,6 +9,7 @@
 from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument
 
 from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase
+from gooddata_sdk.catalog.types import UpsertOutcome
 from gooddata_sdk.catalog.user.declarative_model.user import CatalogDeclarativeUsers
 from gooddata_sdk.catalog.user.declarative_model.user_and_user_groups import CatalogDeclarativeUsersUserGroups
 from gooddata_sdk.catalog.user.declarative_model.user_group import CatalogDeclarativeUserGroups
@@ -25,7 +26,7 @@
 class CatalogUserService(CatalogServiceBase):
     # Entity methods for users
 
-    def create_or_update_user(self, user: CatalogUser) -> None:
+    def create_or_update_user(self, user: CatalogUser) -> UpsertOutcome:
         """Creates a new user or overwrites an existing user.
 
 
@@ -34,7 +35,8 @@ def create_or_update_user(self, user: CatalogUser) -> None:
                 User entity object.
 
         Returns:
-            None
+            UpsertOutcome:
+                CREATED if the user did not exist yet, UPDATED if it did.
         """
         try:
             self.get_user(user_id=user.id)
@@ -43,6 +45,8 @@ def create_or_update_user(self, user: CatalogUser) -> None:
         except NotFoundException:
             user_document = CatalogUserDocument(data=user)
             self._entities_api.create_entity_users(json_api_user_in_document=user_document.to_api())
+            return UpsertOutcome.CREATED
+        return UpsertOutcome.UPDATED
 
     def get_user(self, user_id: str) -> CatalogUser:
         """Get an individual user using User id.
@@ -89,15 +93,16 @@ def list_users(self) -> list[CatalogUser]:
 
     # Entity methods for user groups
 
-    def create_or_update_user_group(self, user_group: CatalogUserGroup) -> None:
+    def create_or_update_user_group(self, user_group: CatalogUserGroup) -> UpsertOutcome:
         """Create a new user group or overwrite an existing user group.
 
         Args:
             user_group (CatalogUserGroup):
                 UserGroup entity object.
 
         Returns:
-            None
+            UpsertOutcome:
+                CREATED if the user group did not exist yet, UPDATED if it did.
         """
         try:
             self.get_user_group(user_group_id=user_group.id)
@@ -108,6 +113,8 @@ def create_or_update_user_group(self, user_group: CatalogUserGroup) -> None:
         except NotFoundException:
             user_group_document = CatalogUserGroupDocument(data=user_group)
             self._entities_api.create_entity_user_groups(user_group_document.to_api())
+            return UpsertOutcome.CREATED
+        return UpsertOutcome.UPDATED
 
     def get_user_group(self, user_group_id: str) -> CatalogUserGroup:
         """Get an individual user group using user group id.