databricks-sdk 0.0.7__py3-none-any.whl → 0.1.1__py3-none-any.whl

databricks/sdk/service/oauth2.py

@@ -2,7 +2,7 @@
 
 import logging
 from dataclasses import dataclass
-from typing import Any, Dict, Iterator, List
+from typing import Dict, Iterator, List
 
 from ._internal import _from_dict, _repeated
 
@@ -223,8 +223,8 @@ class OAuthEnrollmentStatus:
 
 @dataclass
 class TokenAccessPolicy:
-    access_token_ttl_in_minutes: Any = None
-    refresh_token_ttl_in_minutes: Any = None
+    access_token_ttl_in_minutes: int = None
+    refresh_token_ttl_in_minutes: int = None
 
     def as_dict(self) -> dict:
         body = {}

databricks/sdk/service/pipelines.py

@@ -13,9 +13,8 @@ from ._internal import Wait, _enum, _from_dict, _repeated
 
 _LOG = logging.getLogger('databricks.sdk')
 
-from .clusters import (AutoScale, AwsAttributes, AzureAttributes,
-                       ClusterLogConf, GcpAttributes)
-from .libraries import MavenLibrary
+from .compute import (AutoScale, AwsAttributes, AzureAttributes,
+                      ClusterLogConf, GcpAttributes, MavenLibrary)
 
 # all definitions in this file are in alphabetical order
 
@@ -133,7 +132,7 @@ class DataPlaneId:
 
 
 @dataclass
-class Delete:
+class DeletePipelineRequest:
     """Delete a pipeline"""
 
     pipeline_id: str
@@ -229,6 +228,20 @@ class EventLevel(Enum):
     WARN = 'WARN'
 
 
+@dataclass
+class FileLibrary:
+    path: str = None
+
+    def as_dict(self) -> dict:
+        body = {}
+        if self.path: body['path'] = self.path
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> 'FileLibrary':
+        return cls(path=d.get('path', None))
+
+
 @dataclass
 class Filters:
     exclude: 'List[str]' = None
@@ -246,7 +259,7 @@ class Filters:
 
 
 @dataclass
-class Get:
+class GetPipelineRequest:
     """Get a pipeline"""
 
     pipeline_id: str
@@ -304,7 +317,7 @@ class GetPipelineResponseHealth(Enum):
 
 
 @dataclass
-class GetUpdate:
+class GetUpdateRequest:
     """Get a pipeline update"""
 
     pipeline_id: str
@@ -326,7 +339,7 @@ class GetUpdateResponse:
 
 
 @dataclass
-class ListPipelineEvents:
+class ListPipelineEventsRequest:
     """List pipeline events"""
 
     pipeline_id: str
@@ -357,7 +370,7 @@ class ListPipelineEventsResponse:
 
 
 @dataclass
-class ListPipelines:
+class ListPipelinesRequest:
     """List pipelines"""
 
     filter: str = None
@@ -384,7 +397,7 @@ class ListPipelinesResponse:
 
 
 @dataclass
-class ListUpdates:
+class ListUpdatesRequest:
     """List pipeline updates"""
 
     pipeline_id: str
@@ -600,6 +613,7 @@ class PipelineEvent:
 
 @dataclass
 class PipelineLibrary:
+    file: 'FileLibrary' = None
     jar: str = None
     maven: 'MavenLibrary' = None
     notebook: 'NotebookLibrary' = None
@@ -607,6 +621,7 @@ class PipelineLibrary:
 
     def as_dict(self) -> dict:
         body = {}
+        if self.file: body['file'] = self.file.as_dict()
         if self.jar: body['jar'] = self.jar
         if self.maven: body['maven'] = self.maven.as_dict()
         if self.notebook: body['notebook'] = self.notebook.as_dict()
@@ -615,7 +630,8 @@ class PipelineLibrary:
 
     @classmethod
     def from_dict(cls, d: Dict[str, any]) -> 'PipelineLibrary':
-        return cls(jar=d.get('jar', None),
+        return cls(file=_from_dict(d, 'file', FileLibrary),
+                   jar=d.get('jar', None),
                    maven=_from_dict(d, 'maven', MavenLibrary),
                    notebook=_from_dict(d, 'notebook', NotebookLibrary),
                    whl=d.get('whl', None))
@@ -740,7 +756,7 @@ class PipelineTrigger:
 
 
 @dataclass
-class Reset:
+class ResetRequest:
     """Reset a pipeline"""
 
     pipeline_id: str
@@ -858,7 +874,7 @@ class StartUpdateResponse:
 
 
 @dataclass
-class Stop:
+class StopRequest:
     """Stop a pipeline"""
 
     pipeline_id: str
@@ -1098,7 +1114,7 @@ class PipelinesAPI:
         Deletes a pipeline."""
         request = kwargs.get('request', None)
         if not request: # request is not given through keyed args
-            request = Delete(pipeline_id=pipeline_id)
+            request = DeletePipelineRequest(pipeline_id=pipeline_id)
 
         self._api.do('DELETE', f'/api/2.0/pipelines/{request.pipeline_id}')
 
@@ -1106,7 +1122,7 @@ class PipelinesAPI:
         """Get a pipeline."""
         request = kwargs.get('request', None)
         if not request: # request is not given through keyed args
-            request = Get(pipeline_id=pipeline_id)
+            request = GetPipelineRequest(pipeline_id=pipeline_id)
 
         json = self._api.do('GET', f'/api/2.0/pipelines/{request.pipeline_id}')
         return GetPipelineResponse.from_dict(json)
@@ -1117,7 +1133,7 @@ class PipelinesAPI:
         Gets an update from an active pipeline."""
         request = kwargs.get('request', None)
         if not request: # request is not given through keyed args
-            request = GetUpdate(pipeline_id=pipeline_id, update_id=update_id)
+            request = GetUpdateRequest(pipeline_id=pipeline_id, update_id=update_id)
 
         json = self._api.do('GET', f'/api/2.0/pipelines/{request.pipeline_id}/updates/{request.update_id}')
         return GetUpdateResponse.from_dict(json)
@@ -1135,11 +1151,11 @@ class PipelinesAPI:
         Retrieves events for a pipeline."""
         request = kwargs.get('request', None)
         if not request: # request is not given through keyed args
-            request = ListPipelineEvents(filter=filter,
-                                         max_results=max_results,
-                                         order_by=order_by,
-                                         page_token=page_token,
-                                         pipeline_id=pipeline_id)
+            request = ListPipelineEventsRequest(filter=filter,
+                                                max_results=max_results,
+                                                order_by=order_by,
+                                                page_token=page_token,
+                                                pipeline_id=pipeline_id)
 
         query = {}
         if filter: query['filter'] = request.filter
@@ -1169,10 +1185,10 @@ class PipelinesAPI:
         Lists pipelines defined in the Delta Live Tables system."""
         request = kwargs.get('request', None)
         if not request: # request is not given through keyed args
-            request = ListPipelines(filter=filter,
-                                    max_results=max_results,
-                                    order_by=order_by,
-                                    page_token=page_token)
+            request = ListPipelinesRequest(filter=filter,
+                                           max_results=max_results,
+                                           order_by=order_by,
+                                           page_token=page_token)
 
         query = {}
         if filter: query['filter'] = request.filter
@@ -1202,10 +1218,10 @@ class PipelinesAPI:
         List updates for an active pipeline."""
         request = kwargs.get('request', None)
         if not request: # request is not given through keyed args
-            request = ListUpdates(max_results=max_results,
-                                  page_token=page_token,
-                                  pipeline_id=pipeline_id,
-                                  until_update_id=until_update_id)
+            request = ListUpdatesRequest(max_results=max_results,
+                                         page_token=page_token,
+                                         pipeline_id=pipeline_id,
+                                         until_update_id=until_update_id)
 
         query = {}
         if max_results: query['max_results'] = request.max_results
@@ -1221,7 +1237,7 @@ class PipelinesAPI:
         Resets a pipeline."""
         request = kwargs.get('request', None)
         if not request: # request is not given through keyed args
-            request = Reset(pipeline_id=pipeline_id)
+            request = ResetRequest(pipeline_id=pipeline_id)
 
         self._api.do('POST', f'/api/2.0/pipelines/{request.pipeline_id}/reset')
         return Wait(self.wait_get_pipeline_running, pipeline_id=request.pipeline_id)
@@ -1258,7 +1274,7 @@ class PipelinesAPI:
         Stops a pipeline."""
         request = kwargs.get('request', None)
         if not request: # request is not given through keyed args
-            request = Stop(pipeline_id=pipeline_id)
+            request = StopRequest(pipeline_id=pipeline_id)
 
         self._api.do('POST', f'/api/2.0/pipelines/{request.pipeline_id}/stop')
         return Wait(self.wait_get_pipeline_idle, pipeline_id=request.pipeline_id)

databricks/sdk/service/{deployment.py → provisioning.py}

@@ -203,12 +203,14 @@ class CreateStorageConfigurationRequest:
 @dataclass
 class CreateVpcEndpointRequest:
     vpc_endpoint_name: str
-    aws_vpc_endpoint_id: str
-    region: str
+    aws_vpc_endpoint_id: str = None
+    gcp_vpc_endpoint_info: 'GcpVpcEndpointInfo' = None
+    region: str = None
 
     def as_dict(self) -> dict:
         body = {}
         if self.aws_vpc_endpoint_id: body['aws_vpc_endpoint_id'] = self.aws_vpc_endpoint_id
+        if self.gcp_vpc_endpoint_info: body['gcp_vpc_endpoint_info'] = self.gcp_vpc_endpoint_info.as_dict()
         if self.region: body['region'] = self.region
         if self.vpc_endpoint_name: body['vpc_endpoint_name'] = self.vpc_endpoint_name
         return body
@@ -216,6 +218,7 @@ class CreateVpcEndpointRequest:
     @classmethod
     def from_dict(cls, d: Dict[str, any]) -> 'CreateVpcEndpointRequest':
         return cls(aws_vpc_endpoint_id=d.get('aws_vpc_endpoint_id', None),
+                   gcp_vpc_endpoint_info=_from_dict(d, 'gcp_vpc_endpoint_info', GcpVpcEndpointInfo),
                    region=d.get('region', None),
                    vpc_endpoint_name=d.get('vpc_endpoint_name', None))
 
@@ -396,14 +399,7 @@ class EndpointUseCase(Enum):
     """This enumeration represents the type of Databricks VPC [endpoint service] that was used when
     creating this VPC endpoint.
     
-    If the VPC endpoint connects to the Databricks control plane for either the front-end connection
-    or the back-end REST API connection, the value is `WORKSPACE_ACCESS`.
-    
-    If the VPC endpoint connects to the Databricks workspace for the back-end [secure cluster
-    connectivity] relay, the value is `DATAPLANE_RELAY_ACCESS`.
-    
-    [endpoint service]: https://docs.aws.amazon.com/vpc/latest/privatelink/endpoint-service.html
-    [secure cluster connectivity]: https://docs.databricks.com/security/secure-cluster-connectivity.html"""
+    [endpoint service]: https://docs.aws.amazon.com/vpc/latest/privatelink/endpoint-service.html"""
 
     DATAPLANE_RELAY_ACCESS = 'DATAPLANE_RELAY_ACCESS'
     WORKSPACE_ACCESS = 'WORKSPACE_ACCESS'
@@ -492,6 +488,34 @@ class GcpNetworkInfo:
                    vpc_id=d.get('vpc_id', None))
 
 
+@dataclass
+class GcpVpcEndpointInfo:
+    """The Google Cloud specific information for this Private Service Connect endpoint."""
+
+    project_id: str
+    psc_endpoint_name: str
+    endpoint_region: str
+    psc_connection_id: str = None
+    service_attachment_id: str = None
+
+    def as_dict(self) -> dict:
+        body = {}
+        if self.endpoint_region: body['endpoint_region'] = self.endpoint_region
+        if self.project_id: body['project_id'] = self.project_id
+        if self.psc_connection_id: body['psc_connection_id'] = self.psc_connection_id
+        if self.psc_endpoint_name: body['psc_endpoint_name'] = self.psc_endpoint_name
+        if self.service_attachment_id: body['service_attachment_id'] = self.service_attachment_id
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> 'GcpVpcEndpointInfo':
+        return cls(endpoint_region=d.get('endpoint_region', None),
+                   project_id=d.get('project_id', None),
+                   psc_connection_id=d.get('psc_connection_id', None),
+                   psc_endpoint_name=d.get('psc_endpoint_name', None),
+                   service_attachment_id=d.get('service_attachment_id', None))
+
+
 @dataclass
 class GetCredentialRequest:
     """Get credential configuration"""
@@ -875,6 +899,7 @@ class VpcEndpoint:
     aws_account_id: str = None
     aws_endpoint_service_id: str = None
     aws_vpc_endpoint_id: str = None
+    gcp_vpc_endpoint_info: 'GcpVpcEndpointInfo' = None
     region: str = None
     state: str = None
     use_case: 'EndpointUseCase' = None
@@ -887,6 +912,7 @@ class VpcEndpoint:
         if self.aws_account_id: body['aws_account_id'] = self.aws_account_id
         if self.aws_endpoint_service_id: body['aws_endpoint_service_id'] = self.aws_endpoint_service_id
         if self.aws_vpc_endpoint_id: body['aws_vpc_endpoint_id'] = self.aws_vpc_endpoint_id
+        if self.gcp_vpc_endpoint_info: body['gcp_vpc_endpoint_info'] = self.gcp_vpc_endpoint_info.as_dict()
         if self.region: body['region'] = self.region
         if self.state: body['state'] = self.state
         if self.use_case: body['use_case'] = self.use_case.value
@@ -900,6 +926,7 @@ class VpcEndpoint:
                    aws_account_id=d.get('aws_account_id', None),
                    aws_endpoint_service_id=d.get('aws_endpoint_service_id', None),
                    aws_vpc_endpoint_id=d.get('aws_vpc_endpoint_id', None),
+                   gcp_vpc_endpoint_info=_from_dict(d, 'gcp_vpc_endpoint_info', GcpVpcEndpointInfo),
                    region=d.get('region', None),
                    state=d.get('state', None),
                    use_case=_enum(d, 'use_case', EndpointUseCase),
@@ -1251,13 +1278,7 @@ class NetworksAPI:
 
 
 class PrivateAccessAPI:
-    """These APIs manage private access settings for this account. A private access settings object specifies how
-    your workspace is accessed using AWS PrivateLink. Each workspace that has any PrivateLink connections must
-    include the ID for a private access settings object is in its workspace configuration object. Your account
-    must be enabled for PrivateLink to use these APIs. Before configuring PrivateLink, it is important to read
-    the [Databricks article about PrivateLink].
-    
-    [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html"""
+    """These APIs manage private access settings for this account."""
 
     def __init__(self, api_client):
         self._api = api_client
@@ -1463,19 +1484,18 @@ class StorageAPI:
 
 
 class VpcEndpointsAPI:
-    """These APIs manage VPC endpoint configurations for this account. This object registers an AWS VPC endpoint
-    in your Databricks account so your workspace can use it with AWS PrivateLink. Your VPC endpoint connects
-    to one of two VPC endpoint services -- one for workspace (both for front-end connection and for back-end
-    connection to REST APIs) and one for the back-end secure cluster connectivity relay from the data plane.
-    Your account must be enabled for PrivateLink to use these APIs. Before configuring PrivateLink, it is
-    important to read the [Databricks article about PrivateLink].
-    
-    [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html"""
+    """These APIs manage VPC endpoint configurations for this account."""
 
     def __init__(self, api_client):
         self._api = api_client
 
-    def create(self, vpc_endpoint_name: str, aws_vpc_endpoint_id: str, region: str, **kwargs) -> VpcEndpoint:
+    def create(self,
+               vpc_endpoint_name: str,
+               *,
+               aws_vpc_endpoint_id: str = None,
+               gcp_vpc_endpoint_info: GcpVpcEndpointInfo = None,
+               region: str = None,
+               **kwargs) -> VpcEndpoint:
         """Create VPC endpoint configuration.
         
         Creates a VPC endpoint configuration, which represents a [VPC endpoint] object in AWS used to
@@ -1493,6 +1513,7 @@ class VpcEndpointsAPI:
         request = kwargs.get('request', None)
         if not request: # request is not given through keyed args
             request = CreateVpcEndpointRequest(aws_vpc_endpoint_id=aws_vpc_endpoint_id,
+                                               gcp_vpc_endpoint_info=gcp_vpc_endpoint_info,
                                                region=region,
                                                vpc_endpoint_name=vpc_endpoint_name)
         body = request.as_dict()
@@ -1506,9 +1527,6 @@ class VpcEndpointsAPI:
         Deletes a VPC endpoint configuration, which represents an [AWS VPC endpoint] that can communicate
         privately with Databricks over [AWS PrivateLink].
         
-        Upon deleting a VPC endpoint configuration, the VPC endpoint in AWS changes its state from `accepted`
-        to `rejected`, which means that it is no longer usable from your VPC.
-        
         Before configuring PrivateLink, read the [Databricks article about PrivateLink].
         
         [AWS PrivateLink]: https://aws.amazon.com/privatelink