databricks-sdk 0.19.1__py3-none-any.whl → 0.20.0__py3-none-any.whl

databricks/sdk/service/sql.py

@@ -346,7 +346,6 @@ class ChannelInfo:
 
 
 class ChannelName(Enum):
-    """Name of the channel"""
 
     CHANNEL_NAME_CURRENT = 'CHANNEL_NAME_CURRENT'
     CHANNEL_NAME_CUSTOM = 'CHANNEL_NAME_CUSTOM'
@@ -2008,6 +2007,36 @@ class ListWarehousesResponse:
         return cls(warehouses=_repeated_dict(d, 'warehouses', EndpointInfo))
 
 
+@dataclass
+class MultiValuesOptions:
+    """If specified, allows multiple values to be selected for this parameter. Only applies to dropdown
+    list and query-based dropdown list parameters."""
+
+    prefix: Optional[str] = None
+    """Character that prefixes each selected parameter value."""
+
+    separator: Optional[str] = None
+    """Character that separates each selected parameter value. Defaults to a comma."""
+
+    suffix: Optional[str] = None
+    """Character that suffixes each selected parameter value."""
+
+    def as_dict(self) -> dict:
+        """Serializes the MultiValuesOptions into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.prefix is not None: body['prefix'] = self.prefix
+        if self.separator is not None: body['separator'] = self.separator
+        if self.suffix is not None: body['suffix'] = self.suffix
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> MultiValuesOptions:
+        """Deserializes the MultiValuesOptions from a dictionary."""
+        return cls(prefix=d.get('prefix', None),
+                   separator=d.get('separator', None),
+                   suffix=d.get('suffix', None))
+
+
 class ObjectType(Enum):
     """A singular noun object type."""
 
@@ -2064,9 +2093,20 @@ class OwnableObjectType(Enum):
 
 @dataclass
 class Parameter:
+    enum_options: Optional[str] = None
+    """List of valid parameter values, newline delimited. Only applies for dropdown list parameters."""
+
+    multi_values_options: Optional[MultiValuesOptions] = None
+    """If specified, allows multiple values to be selected for this parameter. Only applies to dropdown
+    list and query-based dropdown list parameters."""
+
     name: Optional[str] = None
     """The literal parameter marker that appears between double curly braces in the query text."""
 
+    query_id: Optional[str] = None
+    """The UUID of the query that provides the parameter values. Only applies for query-based dropdown
+    list parameters."""
+
     title: Optional[str] = None
     """The text displayed in a parameter picking widget."""
 
@@ -2079,7 +2119,10 @@ class Parameter:
     def as_dict(self) -> dict:
         """Serializes the Parameter into a dictionary suitable for use as a JSON request body."""
         body = {}
+        if self.enum_options is not None: body['enumOptions'] = self.enum_options
+        if self.multi_values_options: body['multiValuesOptions'] = self.multi_values_options.as_dict()
         if self.name is not None: body['name'] = self.name
+        if self.query_id is not None: body['queryId'] = self.query_id
         if self.title is not None: body['title'] = self.title
         if self.type is not None: body['type'] = self.type.value
         if self.value: body['value'] = self.value
@@ -2088,7 +2131,10 @@ class Parameter:
     @classmethod
     def from_dict(cls, d: Dict[str, any]) -> Parameter:
         """Deserializes the Parameter from a dictionary."""
-        return cls(name=d.get('name', None),
+        return cls(enum_options=d.get('enumOptions', None),
+                   multi_values_options=_from_dict(d, 'multiValuesOptions', MultiValuesOptions),
+                   name=d.get('name', None),
+                   query_id=d.get('queryId', None),
                    title=d.get('title', None),
                    type=_enum(d, 'type', ParameterType),
                    value=d.get('value', None))
@@ -2098,7 +2144,9 @@ class ParameterType(Enum):
     """Parameters can have several different types."""
 
     DATETIME = 'datetime'
+    ENUM = 'enum'
     NUMBER = 'number'
+    QUERY = 'query'
     TEXT = 'text'
 
 
@@ -3802,6 +3850,7 @@ class AlertsAPI:
         if query_id is not None: body['query_id'] = query_id
         if rearm is not None: body['rearm'] = rearm
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST', '/api/2.0/preview/sql/alerts', body=body, headers=headers)
         return Alert.from_dict(res)
 
@@ -3817,6 +3866,7 @@ class AlertsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('DELETE', f'/api/2.0/preview/sql/alerts/{alert_id}', headers=headers)
 
     def get(self, alert_id: str) -> Alert:
@@ -3830,6 +3880,7 @@ class AlertsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', f'/api/2.0/preview/sql/alerts/{alert_id}', headers=headers)
         return Alert.from_dict(res)
 
@@ -3842,6 +3893,7 @@ class AlertsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', '/api/2.0/preview/sql/alerts', headers=headers)
         return [Alert.from_dict(v) for v in res]
 
@@ -3875,6 +3927,7 @@ class AlertsAPI:
         if query_id is not None: body['query_id'] = query_id
         if rearm is not None: body['rearm'] = rearm
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         self._api.do('PUT', f'/api/2.0/preview/sql/alerts/{alert_id}', body=body, headers=headers)
 
 
@@ -3914,6 +3967,7 @@ class DashboardWidgetsAPI:
         if visualization_id is not None: body['visualization_id'] = visualization_id
         if width is not None: body['width'] = width
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST', '/api/2.0/preview/sql/widgets', body=body, headers=headers)
         return Widget.from_dict(res)
 
@@ -3927,6 +3981,7 @@ class DashboardWidgetsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('DELETE', f'/api/2.0/preview/sql/widgets/{id}', headers=headers)
 
     def update(self,
@@ -3961,6 +4016,7 @@ class DashboardWidgetsAPI:
         if visualization_id is not None: body['visualization_id'] = visualization_id
         if width is not None: body['width'] = width
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST', f'/api/2.0/preview/sql/widgets/{id}', body=body, headers=headers)
         return Widget.from_dict(res)
 
@@ -4009,6 +4065,7 @@ class DashboardsAPI:
         if run_as_role is not None: body['run_as_role'] = run_as_role.value
         if tags is not None: body['tags'] = [v for v in tags]
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST', '/api/2.0/preview/sql/dashboards', body=body, headers=headers)
         return Dashboard.from_dict(res)
 
@@ -4024,6 +4081,7 @@ class DashboardsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('DELETE', f'/api/2.0/preview/sql/dashboards/{dashboard_id}', headers=headers)
 
     def get(self, dashboard_id: str) -> Dashboard:
@@ -4037,6 +4095,7 @@ class DashboardsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', f'/api/2.0/preview/sql/dashboards/{dashboard_id}', headers=headers)
         return Dashboard.from_dict(res)
 
@@ -4099,6 +4158,7 @@ class DashboardsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('POST', f'/api/2.0/preview/sql/dashboards/trash/{dashboard_id}', headers=headers)
 
     def update(self,
@@ -4126,6 +4186,7 @@ class DashboardsAPI:
         if name is not None: body['name'] = name
         if run_as_role is not None: body['run_as_role'] = run_as_role.value
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST',
                            f'/api/2.0/preview/sql/dashboards/{dashboard_id}',
                            body=body,
@@ -4156,6 +4217,7 @@ class DataSourcesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', '/api/2.0/preview/sql/data_sources', headers=headers)
         return [DataSource.from_dict(v) for v in res]
 
@@ -4190,6 +4252,7 @@ class DbsqlPermissionsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET',
                            f'/api/2.0/preview/sql/permissions/{object_type.value}/{object_id}',
                            headers=headers)
@@ -4217,6 +4280,7 @@ class DbsqlPermissionsAPI:
         if access_control_list is not None:
             body['access_control_list'] = [v.as_dict() for v in access_control_list]
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST',
                            f'/api/2.0/preview/sql/permissions/{object_type.value}/{object_id}',
                            body=body,
@@ -4244,6 +4308,7 @@ class DbsqlPermissionsAPI:
         body = {}
         if new_owner is not None: body['new_owner'] = new_owner
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST',
                            f'/api/2.0/preview/sql/permissions/{object_type.value}/{object_id}/transfer',
                            body=body,
@@ -4311,6 +4376,7 @@ class QueriesAPI:
         if query is not None: body['query'] = query
         if run_as_role is not None: body['run_as_role'] = run_as_role.value
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST', '/api/2.0/preview/sql/queries', body=body, headers=headers)
         return Query.from_dict(res)
 
@@ -4326,6 +4392,7 @@ class QueriesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('DELETE', f'/api/2.0/preview/sql/queries/{query_id}', headers=headers)
 
     def get(self, query_id: str) -> Query:
@@ -4340,6 +4407,7 @@ class QueriesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', f'/api/2.0/preview/sql/queries/{query_id}', headers=headers)
         return Query.from_dict(res)
 
@@ -4415,6 +4483,7 @@ class QueriesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('POST', f'/api/2.0/preview/sql/queries/trash/{query_id}', headers=headers)
 
     def update(self,
@@ -4462,6 +4531,7 @@ class QueriesAPI:
         if query is not None: body['query'] = query
         if run_as_role is not None: body['run_as_role'] = run_as_role.value
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST', f'/api/2.0/preview/sql/queries/{query_id}', body=body, headers=headers)
         return Query.from_dict(res)
 
@@ -4552,6 +4622,7 @@ class QueryVisualizationsAPI:
         if query_id is not None: body['query_id'] = query_id
         if type is not None: body['type'] = type
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST', '/api/2.0/preview/sql/visualizations', body=body, headers=headers)
         return Visualization.from_dict(res)
 
@@ -4565,6 +4636,7 @@ class QueryVisualizationsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('DELETE', f'/api/2.0/preview/sql/visualizations/{id}', headers=headers)
 
     def update(self,
@@ -4602,6 +4674,7 @@ class QueryVisualizationsAPI:
         if type is not None: body['type'] = type
         if updated_at is not None: body['updated_at'] = updated_at
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST', f'/api/2.0/preview/sql/visualizations/{id}', body=body, headers=headers)
         return Visualization.from_dict(res)
 
@@ -4707,6 +4780,7 @@ class StatementExecutionAPI:
         """
 
         headers = {}
+
         self._api.do('POST', f'/api/2.0/sql/statements/{statement_id}/cancel', headers=headers)
 
     def execute_statement(self,
@@ -4862,6 +4936,7 @@ class StatementExecutionAPI:
         if wait_timeout is not None: body['wait_timeout'] = wait_timeout
         if warehouse_id is not None: body['warehouse_id'] = warehouse_id
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST', '/api/2.0/sql/statements/', body=body, headers=headers)
         return ExecuteStatementResponse.from_dict(res)
 
@@ -4884,6 +4959,7 @@ class StatementExecutionAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', f'/api/2.0/sql/statements/{statement_id}', headers=headers)
         return GetStatementResponse.from_dict(res)
 
@@ -4906,6 +4982,7 @@ class StatementExecutionAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET',
                            f'/api/2.0/sql/statements/{statement_id}/result/chunks/{chunk_index}',
                            headers=headers)
@@ -5077,6 +5154,7 @@ class WarehousesAPI:
         if tags is not None: body['tags'] = tags.as_dict()
         if warehouse_type is not None: body['warehouse_type'] = warehouse_type.value
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         op_response = self._api.do('POST', '/api/2.0/sql/warehouses', body=body, headers=headers)
         return Wait(self.wait_get_warehouse_running,
                     response=CreateWarehouseResponse.from_dict(op_response),
@@ -5126,6 +5204,7 @@ class WarehousesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('DELETE', f'/api/2.0/sql/warehouses/{id}', headers=headers)
 
     def edit(
@@ -5226,6 +5305,7 @@ class WarehousesAPI:
         if tags is not None: body['tags'] = tags.as_dict()
         if warehouse_type is not None: body['warehouse_type'] = warehouse_type.value
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         self._api.do('POST', f'/api/2.0/sql/warehouses/{id}/edit', body=body, headers=headers)
         return Wait(self.wait_get_warehouse_running, id=id)
 
@@ -5275,6 +5355,7 @@ class WarehousesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', f'/api/2.0/sql/warehouses/{id}', headers=headers)
         return GetWarehouseResponse.from_dict(res)
 
@@ -5290,6 +5371,7 @@ class WarehousesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET',
                            f'/api/2.0/permissions/warehouses/{warehouse_id}/permissionLevels',
                            headers=headers)
@@ -5308,6 +5390,7 @@ class WarehousesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', f'/api/2.0/permissions/warehouses/{warehouse_id}', headers=headers)
         return WarehousePermissions.from_dict(res)
 
@@ -5320,6 +5403,7 @@ class WarehousesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', '/api/2.0/sql/config/warehouses', headers=headers)
         return GetWorkspaceWarehouseConfigResponse.from_dict(res)
 
@@ -5338,6 +5422,7 @@ class WarehousesAPI:
         query = {}
         if run_as_user_id is not None: query['run_as_user_id'] = run_as_user_id
         headers = {'Accept': 'application/json', }
+
         json = self._api.do('GET', '/api/2.0/sql/warehouses', query=query, headers=headers)
         parsed = ListWarehousesResponse.from_dict(json).warehouses
         return parsed if parsed is not None else []
@@ -5361,6 +5446,7 @@ class WarehousesAPI:
         if access_control_list is not None:
             body['access_control_list'] = [v.as_dict() for v in access_control_list]
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('PUT',
                            f'/api/2.0/permissions/warehouses/{warehouse_id}',
                            body=body,
@@ -5422,6 +5508,7 @@ class WarehousesAPI:
         if sql_configuration_parameters is not None:
             body['sql_configuration_parameters'] = sql_configuration_parameters.as_dict()
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         self._api.do('PUT', '/api/2.0/sql/config/warehouses', body=body, headers=headers)
 
     def start(self, id: str) -> Wait[GetWarehouseResponse]:
@@ -5438,6 +5525,7 @@ class WarehousesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('POST', f'/api/2.0/sql/warehouses/{id}/start', headers=headers)
         return Wait(self.wait_get_warehouse_running, id=id)
 
@@ -5458,6 +5546,7 @@ class WarehousesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         self._api.do('POST', f'/api/2.0/sql/warehouses/{id}/stop', headers=headers)
         return Wait(self.wait_get_warehouse_stopped, id=id)
 
@@ -5484,6 +5573,7 @@ class WarehousesAPI:
         if access_control_list is not None:
             body['access_control_list'] = [v.as_dict() for v in access_control_list]
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('PATCH',
                            f'/api/2.0/permissions/warehouses/{warehouse_id}',
                            body=body,

databricks/sdk/service/vectorsearch.py

@@ -926,6 +926,7 @@ class VectorSearchEndpointsAPI:
         if endpoint_type is not None: body['endpoint_type'] = endpoint_type.value
         if name is not None: body['name'] = name
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         op_response = self._api.do('POST', '/api/2.0/vector-search/endpoints', body=body, headers=headers)
         return Wait(self.wait_get_endpoint_vector_search_endpoint_online,
                     response=EndpointInfo.from_dict(op_response),
@@ -947,6 +948,7 @@ class VectorSearchEndpointsAPI:
         """
 
         headers = {}
+
         self._api.do('DELETE', f'/api/2.0/vector-search/endpoints/{endpoint_name}', headers=headers)
 
     def get_endpoint(self, endpoint_name: str) -> EndpointInfo:
@@ -959,6 +961,7 @@ class VectorSearchEndpointsAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', f'/api/2.0/vector-search/endpoints/{endpoint_name}', headers=headers)
         return EndpointInfo.from_dict(res)
 
@@ -1038,6 +1041,7 @@ class VectorSearchIndexesAPI:
         if name is not None: body['name'] = name
         if primary_key is not None: body['primary_key'] = primary_key
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST', '/api/2.0/vector-search/indexes', body=body, headers=headers)
         return CreateVectorIndexResponse.from_dict(res)
 
@@ -1056,6 +1060,7 @@ class VectorSearchIndexesAPI:
         body = {}
         if primary_keys is not None: body['primary_keys'] = [v for v in primary_keys]
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST',
                            f'/api/2.0/vector-search/indexes/{name}/delete-data',
                            body=body,
@@ -1074,6 +1079,7 @@ class VectorSearchIndexesAPI:
         """
 
         headers = {}
+
         self._api.do('DELETE', f'/api/2.0/vector-search/indexes/{index_name}', headers=headers)
 
     def get_index(self, index_name: str) -> VectorIndex:
@@ -1088,6 +1094,7 @@ class VectorSearchIndexesAPI:
         """
 
         headers = {'Accept': 'application/json', }
+
         res = self._api.do('GET', f'/api/2.0/vector-search/indexes/{index_name}', headers=headers)
         return VectorIndex.from_dict(res)
 
@@ -1160,6 +1167,7 @@ class VectorSearchIndexesAPI:
         if query_text is not None: body['query_text'] = query_text
         if query_vector is not None: body['query_vector'] = [v for v in query_vector]
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST',
                            f'/api/2.0/vector-search/indexes/{index_name}/query',
                            body=body,
@@ -1178,6 +1186,7 @@ class VectorSearchIndexesAPI:
         """
 
         headers = {}
+
         self._api.do('POST', f'/api/2.0/vector-search/indexes/{index_name}/sync', headers=headers)
 
     def upsert_data_vector_index(self, name: str, inputs_json: str) -> UpsertDataVectorIndexResponse:
@@ -1195,6 +1204,7 @@ class VectorSearchIndexesAPI:
         body = {}
         if inputs_json is not None: body['inputs_json'] = inputs_json
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
         res = self._api.do('POST',
                            f'/api/2.0/vector-search/indexes/{name}/upsert-data',
                            body=body,