updated shortcut functions

Author: m-kovalsky

src/sempy_labs/lakehouse/_shortcuts.py

@@ -103,8 +103,12 @@ def create_shortcut_adls(
     Parameters
     ----------
     shortcut_name : str
+        The name of the shortcut.
     location : str
+        Specifies the location of the target ADLS container. The URI must be in the format https://[account-name].dfs.core.windows.net where [account-name] is the name of the target ADLS account.
     subpath : str
+        	
+Specifies the container and subfolder within the ADLS account where the target folder is located. Must be of the format [container]/[subfolder] where [container] is the name of the container that holds the files and folders; [subfolder] is the name of the subfolder within the container (optional). For example: /mycontainer/mysubfolder.
     connection: Union[str, UUID]
         A string representing the connection that is bound with the shortcut. This can either be the connection Id or the connection name.
     path : str, default="Tables"
@@ -145,8 +149,11 @@ def create_shortcut_amazons3(
     Parameters
     ----------
     shortcut_name : str
+        The name of the shortcut.
     location : str
+        HTTP URL that points to the target bucket in S3. The URL should be in the format https://[bucket-name].s3.[region-code].amazonaws.com, where "bucket-name" is the name of the S3 bucket you want to point to, and "region-code" is the code for the region where the bucket is located. For example: https://my-s3-bucket.s3.us-west-2.amazonaws.com.
     subpath : str
+        Specifies a target folder or subfolder within the S3 bucket.
     connection: Union[str, UUID]
         A string representing the connection that is bound with the shortcut. This can either be the connection Id or the connection name.
     path : str, default="Tables"
@@ -172,13 +179,108 @@ def create_shortcut_amazons3(
     )
 
 
+def create_shortcut_google_cloud(
+    shortcut_name: str,
+    location: str,
+    subpath: str,
+    connection: Union[str, UUID],
+    path: str = "Tables",
+    lakehouse: Optional[str] = None,
+    workspace: Optional[str] = None,
+):
+    """
+    Creates a `shortcut <https://learn.microsoft.com/fabric/onelake/onelake-shortcuts>`_ to a Google Cloud Storage source.
+
+    Parameters
+    ----------
+    shortcut_name : str
+        The name of the shortcut.
+    location : str
+        HTTP URL that points to the target bucket in GCS. The URL should be in the format https://[bucket-name].storage.googleapis.com, where [bucket-name] is the name of the bucket you want to point to. For example: https://my-gcs-bucket.storage.googleapis.com.
+    subpath : str
+        Specifies a target folder or subfolder within the GCS bucket. For example: /folder
+    connection: Union[str, UUID]
+        A string representing the connection that is bound with the shortcut. This can either be the connection Id or the connection name.
+    path : str, default="Tables"
+        A string representing the full path where the shortcut is created, including either "Files" or "Tables".
+    lakehouse : str, default=None
+        The Fabric lakehouse in which the shortcut will be created.
+        Defaults to None which resolves to the default lakehouse attached to the notebook.
+    workspace : str, default=None
+        The name of the Fabric workspace in which the shortcut will be created.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    _create_shortcut_base(
+        shortcut_name=shortcut_name,
+        location=location,
+        subpath=subpath,
+        source="googleCloudStorage",
+        connection=connection,
+        path=path,
+        lakehouse=lakehouse,
+        workspace=workspace,
+    )
+
+
+def create_shortcut_s3_compatible(
+    shortcut_name: str,
+    location: str,
+    subpath: str,
+    bucket: str,
+    connection: Union[str, UUID],
+    path: str = "Tables",
+    lakehouse: Optional[str] = None,
+    workspace: Optional[str] = None,
+):
+    """
+    Creates a `shortcut <https://learn.microsoft.com/fabric/onelake/onelake-shortcuts>`_ to an S3 Compatible source.
+
+    Parameters
+    ----------
+    shortcut_name : str
+        The name of the shortcut.
+    location : str
+        HTTP URL of the S3 compatible endpoint. This endpoint must be able to receive ListBuckets S3 API calls. The URL must be in the non-bucket specific format; no bucket should be specified here. For example: https://s3endpoint.contoso.com.
+    subpath : str
+        Specifies a target folder or subfolder within the S3 compatible bucket. For example: /folder
+    bucket : str
+        Specifies the target bucket within the S3 compatible location.
+    connection: Union[str, UUID]
+        A string representing the connection that is bound with the shortcut. This can either be the connection Id or the connection name.
+    path : str, default="Tables"
+        A string representing the full path where the shortcut is created, including either "Files" or "Tables".
+    lakehouse : str, default=None
+        The Fabric lakehouse in which the shortcut will be created.
+        Defaults to None which resolves to the default lakehouse attached to the notebook.
+    workspace : str, default=None
+        The name of the Fabric workspace in which the shortcut will be created.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    _create_shortcut_base(
+        shortcut_name=shortcut_name,
+        location=location,
+        subpath=subpath,
+        source="s3Compatible",
+        connection=connection,
+        path=path,
+        bucket=bucket,
+        lakehouse=lakehouse,
+        workspace=workspace,
+    )
+
+
 def _create_shortcut_base(
     shortcut_name: str,
     location: str,
     subpath: str,
     source: str,
     connection: Union[str, UUID],
     path: str = "Tables",
+    bucket: Optional[str] = None,
     lakehouse: Optional[str] = None,
     workspace: Optional[str] = None,
 ):
@@ -230,6 +332,11 @@ def _create_shortcut_base(
         },
     }
 
+    if bucket is not None:
+        request_body['target'][source] = {
+            "bucket": bucket
+        }
+
     response = client.post(
         f"/v1/workspaces/{workspace_id}/items/{lakehouse_id}/shortcuts",
         json=request_body,