databricks-sdk 0.28.0__py3-none-any.whl → 0.30.0__py3-none-any.whl

databricks/sdk/service/oauth2.py

@@ -15,14 +15,14 @@ _LOG = logging.getLogger('databricks.sdk')
 
 @dataclass
 class CreateCustomAppIntegration:
-    name: str
-    """name of the custom oauth app"""
+    confidential: Optional[bool] = None
+    """This field indicates whether an OAuth client secret is required to authenticate this client."""
 
-    redirect_urls: List[str]
-    """List of oauth redirect urls"""
+    name: Optional[str] = None
+    """Name of the custom OAuth app"""
 
-    confidential: Optional[bool] = None
-    """indicates if an oauth client-secret should be generated"""
+    redirect_urls: Optional[List[str]] = None
+    """List of OAuth redirect urls"""
 
     scopes: Optional[List[str]] = None
     """OAuth scopes granted to the application. Supported scopes: all-apis, sql, offline_access,
@@ -54,14 +54,14 @@ class CreateCustomAppIntegration:
 @dataclass
 class CreateCustomAppIntegrationOutput:
     client_id: Optional[str] = None
-    """oauth client-id generated by the Databricks"""
+    """OAuth client-id generated by the Databricks"""
 
     client_secret: Optional[str] = None
-    """oauth client-secret generated by the Databricks if this is a confidential oauth app
+    """OAuth client-secret generated by the Databricks. If this is a confidential OAuth app
     client-secret will be generated."""
 
     integration_id: Optional[str] = None
-    """unique integration id for the custom oauth app"""
+    """Unique integration id for the custom OAuth app"""
 
     def as_dict(self) -> dict:
         """Serializes the CreateCustomAppIntegrationOutput into a dictionary suitable for use as a JSON request body."""
@@ -82,7 +82,7 @@ class CreateCustomAppIntegrationOutput:
 @dataclass
 class CreatePublishedAppIntegration:
     app_id: Optional[str] = None
-    """app_id of the oauth published app integration. For example power-bi, tableau-deskop"""
+    """App id of the OAuth published app integration. For example power-bi, tableau-deskop"""
 
     token_access_policy: Optional[TokenAccessPolicy] = None
     """Token access policy"""
@@ -104,7 +104,7 @@ class CreatePublishedAppIntegration:
 @dataclass
 class CreatePublishedAppIntegrationOutput:
     integration_id: Optional[str] = None
-    """unique integration id for the published oauth app"""
+    """Unique integration id for the published OAuth app"""
 
     def as_dict(self) -> dict:
         """Serializes the CreatePublishedAppIntegrationOutput into a dictionary suitable for use as a JSON request body."""
@@ -160,6 +160,28 @@ class CreateServicePrincipalSecretResponse:
                    update_time=d.get('update_time', None))
 
 
+@dataclass
+class DataPlaneInfo:
+    authorization_details: Optional[str] = None
+    """Authorization details as a string."""
+
+    endpoint_url: Optional[str] = None
+    """The URL of the endpoint for this operation in the dataplane."""
+
+    def as_dict(self) -> dict:
+        """Serializes the DataPlaneInfo into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.authorization_details is not None: body['authorization_details'] = self.authorization_details
+        if self.endpoint_url is not None: body['endpoint_url'] = self.endpoint_url
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> DataPlaneInfo:
+        """Deserializes the DataPlaneInfo from a dictionary."""
+        return cls(authorization_details=d.get('authorization_details', None),
+                   endpoint_url=d.get('endpoint_url', None))
+
+
 @dataclass
 class DeleteCustomAppIntegrationOutput:
 
@@ -205,19 +227,27 @@ class DeleteResponse:
 @dataclass
 class GetCustomAppIntegrationOutput:
     client_id: Optional[str] = None
-    """oauth client id of the custom oauth app"""
+    """The client id of the custom OAuth app"""
 
     confidential: Optional[bool] = None
-    """indicates if an oauth client-secret should be generated"""
+    """This field indicates whether an OAuth client secret is required to authenticate this client."""
+
+    create_time: Optional[str] = None
+
+    created_by: Optional[int] = None
+
+    creator_username: Optional[str] = None
 
     integration_id: Optional[str] = None
     """ID of this custom app"""
 
     name: Optional[str] = None
-    """name of the custom oauth app"""
+    """The display name of the custom OAuth app"""
 
     redirect_urls: Optional[List[str]] = None
-    """List of oauth redirect urls"""
+    """List of OAuth redirect urls"""
+
+    scopes: Optional[List[str]] = None
 
     token_access_policy: Optional[TokenAccessPolicy] = None
     """Token access policy"""
@@ -227,9 +257,13 @@ class GetCustomAppIntegrationOutput:
         body = {}
         if self.client_id is not None: body['client_id'] = self.client_id
         if self.confidential is not None: body['confidential'] = self.confidential
+        if self.create_time is not None: body['create_time'] = self.create_time
+        if self.created_by is not None: body['created_by'] = self.created_by
+        if self.creator_username is not None: body['creator_username'] = self.creator_username
         if self.integration_id is not None: body['integration_id'] = self.integration_id
         if self.name is not None: body['name'] = self.name
         if self.redirect_urls: body['redirect_urls'] = [v for v in self.redirect_urls]
+        if self.scopes: body['scopes'] = [v for v in self.scopes]
         if self.token_access_policy: body['token_access_policy'] = self.token_access_policy.as_dict()
         return body
 
@@ -238,39 +272,51 @@ class GetCustomAppIntegrationOutput:
         """Deserializes the GetCustomAppIntegrationOutput from a dictionary."""
         return cls(client_id=d.get('client_id', None),
                    confidential=d.get('confidential', None),
+                   create_time=d.get('create_time', None),
+                   created_by=d.get('created_by', None),
+                   creator_username=d.get('creator_username', None),
                    integration_id=d.get('integration_id', None),
                    name=d.get('name', None),
                    redirect_urls=d.get('redirect_urls', None),
+                   scopes=d.get('scopes', None),
                    token_access_policy=_from_dict(d, 'token_access_policy', TokenAccessPolicy))
 
 
 @dataclass
 class GetCustomAppIntegrationsOutput:
     apps: Optional[List[GetCustomAppIntegrationOutput]] = None
-    """Array of Custom OAuth App Integrations defined for the account."""
+    """List of Custom OAuth App Integrations defined for the account."""
+
+    next_page_token: Optional[str] = None
 
     def as_dict(self) -> dict:
         """Serializes the GetCustomAppIntegrationsOutput into a dictionary suitable for use as a JSON request body."""
         body = {}
         if self.apps: body['apps'] = [v.as_dict() for v in self.apps]
+        if self.next_page_token is not None: body['next_page_token'] = self.next_page_token
         return body
 
     @classmethod
     def from_dict(cls, d: Dict[str, any]) -> GetCustomAppIntegrationsOutput:
         """Deserializes the GetCustomAppIntegrationsOutput from a dictionary."""
-        return cls(apps=_repeated_dict(d, 'apps', GetCustomAppIntegrationOutput))
+        return cls(apps=_repeated_dict(d, 'apps', GetCustomAppIntegrationOutput),
+                   next_page_token=d.get('next_page_token', None))
 
 
 @dataclass
 class GetPublishedAppIntegrationOutput:
     app_id: Optional[str] = None
-    """app-id of the published app integration"""
+    """App-id of the published app integration"""
+
+    create_time: Optional[str] = None
+
+    created_by: Optional[int] = None
 
     integration_id: Optional[str] = None
-    """unique integration id for the published oauth app"""
+    """Unique integration id for the published OAuth app"""
 
     name: Optional[str] = None
-    """name of the published oauth app"""
+    """Display name of the published OAuth app"""
 
     token_access_policy: Optional[TokenAccessPolicy] = None
     """Token access policy"""
@@ -279,6 +325,8 @@ class GetPublishedAppIntegrationOutput:
         """Serializes the GetPublishedAppIntegrationOutput into a dictionary suitable for use as a JSON request body."""
         body = {}
         if self.app_id is not None: body['app_id'] = self.app_id
+        if self.create_time is not None: body['create_time'] = self.create_time
+        if self.created_by is not None: body['created_by'] = self.created_by
         if self.integration_id is not None: body['integration_id'] = self.integration_id
         if self.name is not None: body['name'] = self.name
         if self.token_access_policy: body['token_access_policy'] = self.token_access_policy.as_dict()
@@ -288,6 +336,8 @@ class GetPublishedAppIntegrationOutput:
     def from_dict(cls, d: Dict[str, any]) -> GetPublishedAppIntegrationOutput:
         """Deserializes the GetPublishedAppIntegrationOutput from a dictionary."""
         return cls(app_id=d.get('app_id', None),
+                   create_time=d.get('create_time', None),
+                   created_by=d.get('created_by', None),
                    integration_id=d.get('integration_id', None),
                    name=d.get('name', None),
                    token_access_policy=_from_dict(d, 'token_access_policy', TokenAccessPolicy))
@@ -296,24 +346,28 @@ class GetPublishedAppIntegrationOutput:
 @dataclass
 class GetPublishedAppIntegrationsOutput:
     apps: Optional[List[GetPublishedAppIntegrationOutput]] = None
-    """Array of Published OAuth App Integrations defined for the account."""
+    """List of Published OAuth App Integrations defined for the account."""
+
+    next_page_token: Optional[str] = None
 
     def as_dict(self) -> dict:
         """Serializes the GetPublishedAppIntegrationsOutput into a dictionary suitable for use as a JSON request body."""
         body = {}
         if self.apps: body['apps'] = [v.as_dict() for v in self.apps]
+        if self.next_page_token is not None: body['next_page_token'] = self.next_page_token
         return body
 
     @classmethod
     def from_dict(cls, d: Dict[str, any]) -> GetPublishedAppIntegrationsOutput:
         """Deserializes the GetPublishedAppIntegrationsOutput from a dictionary."""
-        return cls(apps=_repeated_dict(d, 'apps', GetPublishedAppIntegrationOutput))
+        return cls(apps=_repeated_dict(d, 'apps', GetPublishedAppIntegrationOutput),
+                   next_page_token=d.get('next_page_token', None))
 
 
 @dataclass
 class GetPublishedAppsOutput:
     apps: Optional[List[PublishedAppOutput]] = None
-    """Array of Published OAuth Apps."""
+    """List of Published OAuth Apps."""
 
     next_page_token: Optional[str] = None
     """A token that can be used to get the next page of results. If not present, there are no more
@@ -366,7 +420,7 @@ class PublishedAppOutput:
     apps."""
 
     name: Optional[str] = None
-    """Name of the published OAuth app."""
+    """The display name of the published OAuth app."""
 
     redirect_urls: Optional[List[str]] = None
     """Redirect URLs of the published OAuth app."""
@@ -463,13 +517,12 @@ class TokenAccessPolicy:
 @dataclass
 class UpdateCustomAppIntegration:
     integration_id: Optional[str] = None
-    """The oauth app integration ID."""
 
     redirect_urls: Optional[List[str]] = None
-    """List of oauth redirect urls to be updated in the custom oauth app integration"""
+    """List of OAuth redirect urls to be updated in the custom OAuth app integration"""
 
     token_access_policy: Optional[TokenAccessPolicy] = None
-    """Token access policy to be updated in the custom oauth app integration"""
+    """Token access policy to be updated in the custom OAuth app integration"""
 
     def as_dict(self) -> dict:
         """Serializes the UpdateCustomAppIntegration into a dictionary suitable for use as a JSON request body."""
@@ -504,10 +557,9 @@ class UpdateCustomAppIntegrationOutput:
 @dataclass
 class UpdatePublishedAppIntegration:
     integration_id: Optional[str] = None
-    """The oauth app integration ID."""
 
     token_access_policy: Optional[TokenAccessPolicy] = None
-    """Token access policy to be updated in the published oauth app integration"""
+    """Token access policy to be updated in the published OAuth app integration"""
 
     def as_dict(self) -> dict:
         """Serializes the UpdatePublishedAppIntegration into a dictionary suitable for use as a JSON request body."""
@@ -538,31 +590,31 @@ class UpdatePublishedAppIntegrationOutput:
 
 
 class CustomAppIntegrationAPI:
-    """These APIs enable administrators to manage custom oauth app integrations, which is required for
+    """These APIs enable administrators to manage custom OAuth app integrations, which is required for
     adding/using Custom OAuth App Integration like Tableau Cloud for Databricks in AWS cloud."""
 
     def __init__(self, api_client):
         self._api = api_client
 
     def create(self,
-               name: str,
-               redirect_urls: List[str],
                *,
                confidential: Optional[bool] = None,
+               name: Optional[str] = None,
+               redirect_urls: Optional[List[str]] = None,
                scopes: Optional[List[str]] = None,
                token_access_policy: Optional[TokenAccessPolicy] = None) -> CreateCustomAppIntegrationOutput:
         """Create Custom OAuth App Integration.
         
         Create Custom OAuth App Integration.
         
-        You can retrieve the custom oauth app integration via :method:CustomAppIntegration/get.
+        You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.
         
-        :param name: str
-          name of the custom oauth app
-        :param redirect_urls: List[str]
-          List of oauth redirect urls
         :param confidential: bool (optional)
-          indicates if an oauth client-secret should be generated
+          This field indicates whether an OAuth client secret is required to authenticate this client.
+        :param name: str (optional)
+          Name of the custom OAuth app
+        :param redirect_urls: List[str] (optional)
+          List of OAuth redirect urls
         :param scopes: List[str] (optional)
           OAuth scopes granted to the application. Supported scopes: all-apis, sql, offline_access, openid,
           profile, email.
@@ -588,11 +640,10 @@ class CustomAppIntegrationAPI:
     def delete(self, integration_id: str):
         """Delete Custom OAuth App Integration.
         
-        Delete an existing Custom OAuth App Integration. You can retrieve the custom oauth app integration via
+        Delete an existing Custom OAuth App Integration. You can retrieve the custom OAuth app integration via
         :method:CustomAppIntegration/get.
         
         :param integration_id: str
-          The oauth app integration ID.
         
         
         """
@@ -610,7 +661,6 @@ class CustomAppIntegrationAPI:
         Gets the Custom OAuth App Integration for the given integration id.
         
         :param integration_id: str
-          The oauth app integration ID.
         
         :returns: :class:`GetCustomAppIntegrationOutput`
         """
@@ -623,21 +673,39 @@ class CustomAppIntegrationAPI:
             headers=headers)
         return GetCustomAppIntegrationOutput.from_dict(res)
 
-    def list(self) -> Iterator[GetCustomAppIntegrationOutput]:
+    def list(self,
+             *,
+             include_creator_username: Optional[bool] = None,
+             page_size: Optional[int] = None,
+             page_token: Optional[str] = None) -> Iterator[GetCustomAppIntegrationOutput]:
         """Get custom oauth app integrations.
         
-        Get the list of custom oauth app integrations for the specified Databricks account
+        Get the list of custom OAuth app integrations for the specified Databricks account
+        
+        :param include_creator_username: bool (optional)
+        :param page_size: int (optional)
+        :param page_token: str (optional)
         
         :returns: Iterator over :class:`GetCustomAppIntegrationOutput`
         """
 
+        query = {}
+        if include_creator_username is not None: query['include_creator_username'] = include_creator_username
+        if page_size is not None: query['page_size'] = page_size
+        if page_token is not None: query['page_token'] = page_token
         headers = {'Accept': 'application/json', }
 
-        json = self._api.do('GET',
-                            f'/api/2.0/accounts/{self._api.account_id}/oauth2/custom-app-integrations',
-                            headers=headers)
-        parsed = GetCustomAppIntegrationsOutput.from_dict(json).apps
-        return parsed if parsed is not None else []
+        while True:
+            json = self._api.do('GET',
+                                f'/api/2.0/accounts/{self._api.account_id}/oauth2/custom-app-integrations',
+                                query=query,
+                                headers=headers)
+            if 'apps' in json:
+                for v in json['apps']:
+                    yield GetCustomAppIntegrationOutput.from_dict(v)
+            if 'next_page_token' not in json or not json['next_page_token']:
+                return
+            query['page_token'] = json['next_page_token']
 
     def update(self,
                integration_id: str,
@@ -646,15 +714,14 @@ class CustomAppIntegrationAPI:
                token_access_policy: Optional[TokenAccessPolicy] = None):
         """Updates Custom OAuth App Integration.
         
-        Updates an existing custom OAuth App Integration. You can retrieve the custom oauth app integration
+        Updates an existing custom OAuth App Integration. You can retrieve the custom OAuth app integration
         via :method:CustomAppIntegration/get.
         
         :param integration_id: str
-          The oauth app integration ID.
         :param redirect_urls: List[str] (optional)
-          List of oauth redirect urls to be updated in the custom oauth app integration
+          List of OAuth redirect urls to be updated in the custom OAuth app integration
         :param token_access_policy: :class:`TokenAccessPolicy` (optional)
-          Token access policy to be updated in the custom oauth app integration
+          Token access policy to be updated in the custom OAuth app integration
         
         
         """
@@ -687,7 +754,7 @@ class OAuthPublishedAppsAPI:
         Get all the available published OAuth apps in Databricks.
         
         :param page_size: int (optional)
-          The max number of OAuth published apps to return.
+          The max number of OAuth published apps to return in one page.
         :param page_token: str (optional)
           A token that can be used to get the next page of results.
         
@@ -701,7 +768,7 @@ class OAuthPublishedAppsAPI:
 
         while True:
             json = self._api.do('GET',
-                                f'/api/2.0/accounts/{self._api.account_id}/oauth2/published-apps/',
+                                f'/api/2.0/accounts/{self._api.account_id}/oauth2/published-apps',
                                 query=query,
                                 headers=headers)
             if 'apps' in json:
@@ -713,7 +780,7 @@ class OAuthPublishedAppsAPI:
 
 
 class PublishedAppIntegrationAPI:
-    """These APIs enable administrators to manage published oauth app integrations, which is required for
+    """These APIs enable administrators to manage published OAuth app integrations, which is required for
     adding/using Published OAuth App Integration like Tableau Desktop for Databricks in AWS cloud."""
 
     def __init__(self, api_client):
@@ -728,10 +795,10 @@ class PublishedAppIntegrationAPI:
         
         Create Published OAuth App Integration.
         
-        You can retrieve the published oauth app integration via :method:PublishedAppIntegration/get.
+        You can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.
         
         :param app_id: str (optional)
-          app_id of the oauth published app integration. For example power-bi, tableau-deskop
+          App id of the OAuth published app integration. For example power-bi, tableau-deskop
         :param token_access_policy: :class:`TokenAccessPolicy` (optional)
           Token access policy
         
@@ -751,11 +818,10 @@ class PublishedAppIntegrationAPI:
     def delete(self, integration_id: str):
         """Delete Published OAuth App Integration.
         
-        Delete an existing Published OAuth App Integration. You can retrieve the published oauth app
+        Delete an existing Published OAuth App Integration. You can retrieve the published OAuth app
         integration via :method:PublishedAppIntegration/get.
         
         :param integration_id: str
-          The oauth app integration ID.
         
         
         """
@@ -773,7 +839,6 @@ class PublishedAppIntegrationAPI:
         Gets the Published OAuth App Integration for the given integration id.
         
         :param integration_id: str
-          The oauth app integration ID.
         
         :returns: :class:`GetPublishedAppIntegrationOutput`
         """
@@ -786,32 +851,46 @@ class PublishedAppIntegrationAPI:
             headers=headers)
         return GetPublishedAppIntegrationOutput.from_dict(res)
 
-    def list(self) -> Iterator[GetPublishedAppIntegrationOutput]:
+    def list(self,
+             *,
+             page_size: Optional[int] = None,
+             page_token: Optional[str] = None) -> Iterator[GetPublishedAppIntegrationOutput]:
         """Get published oauth app integrations.
         
-        Get the list of published oauth app integrations for the specified Databricks account
+        Get the list of published OAuth app integrations for the specified Databricks account
+        
+        :param page_size: int (optional)
+        :param page_token: str (optional)
         
         :returns: Iterator over :class:`GetPublishedAppIntegrationOutput`
         """
 
+        query = {}
+        if page_size is not None: query['page_size'] = page_size
+        if page_token is not None: query['page_token'] = page_token
         headers = {'Accept': 'application/json', }
 
-        json = self._api.do('GET',
-                            f'/api/2.0/accounts/{self._api.account_id}/oauth2/published-app-integrations',
-                            headers=headers)
-        parsed = GetPublishedAppIntegrationsOutput.from_dict(json).apps
-        return parsed if parsed is not None else []
+        while True:
+            json = self._api.do('GET',
+                                f'/api/2.0/accounts/{self._api.account_id}/oauth2/published-app-integrations',
+                                query=query,
+                                headers=headers)
+            if 'apps' in json:
+                for v in json['apps']:
+                    yield GetPublishedAppIntegrationOutput.from_dict(v)
+            if 'next_page_token' not in json or not json['next_page_token']:
+                return
+            query['page_token'] = json['next_page_token']
 
     def update(self, integration_id: str, *, token_access_policy: Optional[TokenAccessPolicy] = None):
         """Updates Published OAuth App Integration.
         
-        Updates an existing published OAuth App Integration. You can retrieve the published oauth app
+        Updates an existing published OAuth App Integration. You can retrieve the published OAuth app
         integration via :method:PublishedAppIntegration/get.
         
         :param integration_id: str
-          The oauth app integration ID.
         :param token_access_policy: :class:`TokenAccessPolicy` (optional)
-          Token access policy to be updated in the published oauth app integration
+          Token access policy to be updated in the published OAuth app integration
         
         
         """