arthur-client 1.4.1243__py3-none-any.whl → 1.4.1245__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1944,6 +1944,464 @@ class DatasetsV1Api:
1944
1944
 
1945
1945
 
1946
1946
 
1947
+ @validate_call
1948
+ def get_datasets_in_workspace(
1949
+ self,
1950
+ workspace_id: StrictStr,
1951
+ sort: Annotated[Optional[DatasetsSort], Field(description="Override the field used for sorting the returned list. Optional.")] = None,
1952
+ order: Annotated[Optional[SortOrder], Field(description="Override the sort order used. Optional.")] = None,
1953
+ model_ids: Annotated[Optional[List[StrictStr]], Field(description="Filter the results for datasets that are used by these models. Optional.")] = None,
1954
+ search: Annotated[Optional[StrictStr], Field(description="Search for datasets by connector name or dataset name.")] = None,
1955
+ connector_type: Annotated[Optional[ConnectorType], Field(description="Filter datasets by connector type.")] = None,
1956
+ connector_name: Annotated[Optional[StrictStr], Field(description="Filter datasets by connector name.")] = None,
1957
+ dataset_name: Annotated[Optional[StrictStr], Field(description="Filter datasets by dataset name.")] = None,
1958
+ joined_datasets: Annotated[Optional[StrictBool], Field(description="Filter for joined datasets. Only returns joined datasets if True. Only returns non-joined datasets if False. Not applied if None.")] = None,
1959
+ data_plane_id: Annotated[Optional[StrictStr], Field(description="Filter datasets by the data plane (engine) that backs them.")] = None,
1960
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The page to return starting from 1 up to total_pages.")] = None,
1961
+ page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="The number of records per page. The max is 1000.")] = None,
1962
+ _request_timeout: Union[
1963
+ None,
1964
+ Annotated[StrictFloat, Field(gt=0)],
1965
+ Tuple[
1966
+ Annotated[StrictFloat, Field(gt=0)],
1967
+ Annotated[StrictFloat, Field(gt=0)]
1968
+ ]
1969
+ ] = None,
1970
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1971
+ _content_type: Optional[StrictStr] = None,
1972
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1973
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1974
+ ) -> ResourceListDataset:
1975
+ """Get Workspace Datasets.
1976
+
1977
+ Endpoint requires workspace_list_datasets permission. It will only include datasets the user has additional dataset_read permissions on in the response.
1978
+
1979
+ :param workspace_id: (required)
1980
+ :type workspace_id: str
1981
+ :param sort: Override the field used for sorting the returned list. Optional.
1982
+ :type sort: DatasetsSort
1983
+ :param order: Override the sort order used. Optional.
1984
+ :type order: SortOrder
1985
+ :param model_ids: Filter the results for datasets that are used by these models. Optional.
1986
+ :type model_ids: List[str]
1987
+ :param search: Search for datasets by connector name or dataset name.
1988
+ :type search: str
1989
+ :param connector_type: Filter datasets by connector type.
1990
+ :type connector_type: ConnectorType
1991
+ :param connector_name: Filter datasets by connector name.
1992
+ :type connector_name: str
1993
+ :param dataset_name: Filter datasets by dataset name.
1994
+ :type dataset_name: str
1995
+ :param joined_datasets: Filter for joined datasets. Only returns joined datasets if True. Only returns non-joined datasets if False. Not applied if None.
1996
+ :type joined_datasets: bool
1997
+ :param data_plane_id: Filter datasets by the data plane (engine) that backs them.
1998
+ :type data_plane_id: str
1999
+ :param page: The page to return starting from 1 up to total_pages.
2000
+ :type page: int
2001
+ :param page_size: The number of records per page. The max is 1000.
2002
+ :type page_size: int
2003
+ :param _request_timeout: timeout setting for this request. If one
2004
+ number provided, it will be total request
2005
+ timeout. It can also be a pair (tuple) of
2006
+ (connection, read) timeouts.
2007
+ :type _request_timeout: int, tuple(int, int), optional
2008
+ :param _request_auth: set to override the auth_settings for an a single
2009
+ request; this effectively ignores the
2010
+ authentication in the spec for a single request.
2011
+ :type _request_auth: dict, optional
2012
+ :param _content_type: force content-type for the request.
2013
+ :type _content_type: str, Optional
2014
+ :param _headers: set to override the headers for a single
2015
+ request; this effectively ignores the headers
2016
+ in the spec for a single request.
2017
+ :type _headers: dict, optional
2018
+ :param _host_index: set to override the host_index for a single
2019
+ request; this effectively ignores the host_index
2020
+ in the spec for a single request.
2021
+ :type _host_index: int, optional
2022
+ :return: Returns the result object.
2023
+ """ # noqa: E501
2024
+
2025
+ _param = self._get_datasets_in_workspace_serialize(
2026
+ workspace_id=workspace_id,
2027
+ sort=sort,
2028
+ order=order,
2029
+ model_ids=model_ids,
2030
+ search=search,
2031
+ connector_type=connector_type,
2032
+ connector_name=connector_name,
2033
+ dataset_name=dataset_name,
2034
+ joined_datasets=joined_datasets,
2035
+ data_plane_id=data_plane_id,
2036
+ page=page,
2037
+ page_size=page_size,
2038
+ _request_auth=_request_auth,
2039
+ _content_type=_content_type,
2040
+ _headers=_headers,
2041
+ _host_index=_host_index
2042
+ )
2043
+
2044
+ _response_types_map: Dict[str, Optional[str]] = {
2045
+ '200': "ResourceListDataset",
2046
+ '500': "InternalServerError",
2047
+ '404': "NotFoundError",
2048
+ '422': "HTTPValidationError",
2049
+ }
2050
+ response_data = self.api_client.call_api(
2051
+ *_param,
2052
+ _request_timeout=_request_timeout
2053
+ )
2054
+ response_data.read()
2055
+ return self.api_client.response_deserialize(
2056
+ response_data=response_data,
2057
+ response_types_map=_response_types_map,
2058
+ ).data
2059
+
2060
+
2061
+ @validate_call
2062
+ def get_datasets_in_workspace_with_http_info(
2063
+ self,
2064
+ workspace_id: StrictStr,
2065
+ sort: Annotated[Optional[DatasetsSort], Field(description="Override the field used for sorting the returned list. Optional.")] = None,
2066
+ order: Annotated[Optional[SortOrder], Field(description="Override the sort order used. Optional.")] = None,
2067
+ model_ids: Annotated[Optional[List[StrictStr]], Field(description="Filter the results for datasets that are used by these models. Optional.")] = None,
2068
+ search: Annotated[Optional[StrictStr], Field(description="Search for datasets by connector name or dataset name.")] = None,
2069
+ connector_type: Annotated[Optional[ConnectorType], Field(description="Filter datasets by connector type.")] = None,
2070
+ connector_name: Annotated[Optional[StrictStr], Field(description="Filter datasets by connector name.")] = None,
2071
+ dataset_name: Annotated[Optional[StrictStr], Field(description="Filter datasets by dataset name.")] = None,
2072
+ joined_datasets: Annotated[Optional[StrictBool], Field(description="Filter for joined datasets. Only returns joined datasets if True. Only returns non-joined datasets if False. Not applied if None.")] = None,
2073
+ data_plane_id: Annotated[Optional[StrictStr], Field(description="Filter datasets by the data plane (engine) that backs them.")] = None,
2074
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The page to return starting from 1 up to total_pages.")] = None,
2075
+ page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="The number of records per page. The max is 1000.")] = None,
2076
+ _request_timeout: Union[
2077
+ None,
2078
+ Annotated[StrictFloat, Field(gt=0)],
2079
+ Tuple[
2080
+ Annotated[StrictFloat, Field(gt=0)],
2081
+ Annotated[StrictFloat, Field(gt=0)]
2082
+ ]
2083
+ ] = None,
2084
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2085
+ _content_type: Optional[StrictStr] = None,
2086
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2087
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2088
+ ) -> ApiResponse[ResourceListDataset]:
2089
+ """Get Workspace Datasets.
2090
+
2091
+ Endpoint requires workspace_list_datasets permission. It will only include datasets the user has additional dataset_read permissions on in the response.
2092
+
2093
+ :param workspace_id: (required)
2094
+ :type workspace_id: str
2095
+ :param sort: Override the field used for sorting the returned list. Optional.
2096
+ :type sort: DatasetsSort
2097
+ :param order: Override the sort order used. Optional.
2098
+ :type order: SortOrder
2099
+ :param model_ids: Filter the results for datasets that are used by these models. Optional.
2100
+ :type model_ids: List[str]
2101
+ :param search: Search for datasets by connector name or dataset name.
2102
+ :type search: str
2103
+ :param connector_type: Filter datasets by connector type.
2104
+ :type connector_type: ConnectorType
2105
+ :param connector_name: Filter datasets by connector name.
2106
+ :type connector_name: str
2107
+ :param dataset_name: Filter datasets by dataset name.
2108
+ :type dataset_name: str
2109
+ :param joined_datasets: Filter for joined datasets. Only returns joined datasets if True. Only returns non-joined datasets if False. Not applied if None.
2110
+ :type joined_datasets: bool
2111
+ :param data_plane_id: Filter datasets by the data plane (engine) that backs them.
2112
+ :type data_plane_id: str
2113
+ :param page: The page to return starting from 1 up to total_pages.
2114
+ :type page: int
2115
+ :param page_size: The number of records per page. The max is 1000.
2116
+ :type page_size: int
2117
+ :param _request_timeout: timeout setting for this request. If one
2118
+ number provided, it will be total request
2119
+ timeout. It can also be a pair (tuple) of
2120
+ (connection, read) timeouts.
2121
+ :type _request_timeout: int, tuple(int, int), optional
2122
+ :param _request_auth: set to override the auth_settings for an a single
2123
+ request; this effectively ignores the
2124
+ authentication in the spec for a single request.
2125
+ :type _request_auth: dict, optional
2126
+ :param _content_type: force content-type for the request.
2127
+ :type _content_type: str, Optional
2128
+ :param _headers: set to override the headers for a single
2129
+ request; this effectively ignores the headers
2130
+ in the spec for a single request.
2131
+ :type _headers: dict, optional
2132
+ :param _host_index: set to override the host_index for a single
2133
+ request; this effectively ignores the host_index
2134
+ in the spec for a single request.
2135
+ :type _host_index: int, optional
2136
+ :return: Returns the result object.
2137
+ """ # noqa: E501
2138
+
2139
+ _param = self._get_datasets_in_workspace_serialize(
2140
+ workspace_id=workspace_id,
2141
+ sort=sort,
2142
+ order=order,
2143
+ model_ids=model_ids,
2144
+ search=search,
2145
+ connector_type=connector_type,
2146
+ connector_name=connector_name,
2147
+ dataset_name=dataset_name,
2148
+ joined_datasets=joined_datasets,
2149
+ data_plane_id=data_plane_id,
2150
+ page=page,
2151
+ page_size=page_size,
2152
+ _request_auth=_request_auth,
2153
+ _content_type=_content_type,
2154
+ _headers=_headers,
2155
+ _host_index=_host_index
2156
+ )
2157
+
2158
+ _response_types_map: Dict[str, Optional[str]] = {
2159
+ '200': "ResourceListDataset",
2160
+ '500': "InternalServerError",
2161
+ '404': "NotFoundError",
2162
+ '422': "HTTPValidationError",
2163
+ }
2164
+ response_data = self.api_client.call_api(
2165
+ *_param,
2166
+ _request_timeout=_request_timeout
2167
+ )
2168
+ response_data.read()
2169
+ return self.api_client.response_deserialize(
2170
+ response_data=response_data,
2171
+ response_types_map=_response_types_map,
2172
+ )
2173
+
2174
+
2175
+ @validate_call
2176
+ def get_datasets_in_workspace_without_preload_content(
2177
+ self,
2178
+ workspace_id: StrictStr,
2179
+ sort: Annotated[Optional[DatasetsSort], Field(description="Override the field used for sorting the returned list. Optional.")] = None,
2180
+ order: Annotated[Optional[SortOrder], Field(description="Override the sort order used. Optional.")] = None,
2181
+ model_ids: Annotated[Optional[List[StrictStr]], Field(description="Filter the results for datasets that are used by these models. Optional.")] = None,
2182
+ search: Annotated[Optional[StrictStr], Field(description="Search for datasets by connector name or dataset name.")] = None,
2183
+ connector_type: Annotated[Optional[ConnectorType], Field(description="Filter datasets by connector type.")] = None,
2184
+ connector_name: Annotated[Optional[StrictStr], Field(description="Filter datasets by connector name.")] = None,
2185
+ dataset_name: Annotated[Optional[StrictStr], Field(description="Filter datasets by dataset name.")] = None,
2186
+ joined_datasets: Annotated[Optional[StrictBool], Field(description="Filter for joined datasets. Only returns joined datasets if True. Only returns non-joined datasets if False. Not applied if None.")] = None,
2187
+ data_plane_id: Annotated[Optional[StrictStr], Field(description="Filter datasets by the data plane (engine) that backs them.")] = None,
2188
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The page to return starting from 1 up to total_pages.")] = None,
2189
+ page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="The number of records per page. The max is 1000.")] = None,
2190
+ _request_timeout: Union[
2191
+ None,
2192
+ Annotated[StrictFloat, Field(gt=0)],
2193
+ Tuple[
2194
+ Annotated[StrictFloat, Field(gt=0)],
2195
+ Annotated[StrictFloat, Field(gt=0)]
2196
+ ]
2197
+ ] = None,
2198
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2199
+ _content_type: Optional[StrictStr] = None,
2200
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2201
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2202
+ ) -> RESTResponseType:
2203
+ """Get Workspace Datasets.
2204
+
2205
+ Endpoint requires workspace_list_datasets permission. It will only include datasets the user has additional dataset_read permissions on in the response.
2206
+
2207
+ :param workspace_id: (required)
2208
+ :type workspace_id: str
2209
+ :param sort: Override the field used for sorting the returned list. Optional.
2210
+ :type sort: DatasetsSort
2211
+ :param order: Override the sort order used. Optional.
2212
+ :type order: SortOrder
2213
+ :param model_ids: Filter the results for datasets that are used by these models. Optional.
2214
+ :type model_ids: List[str]
2215
+ :param search: Search for datasets by connector name or dataset name.
2216
+ :type search: str
2217
+ :param connector_type: Filter datasets by connector type.
2218
+ :type connector_type: ConnectorType
2219
+ :param connector_name: Filter datasets by connector name.
2220
+ :type connector_name: str
2221
+ :param dataset_name: Filter datasets by dataset name.
2222
+ :type dataset_name: str
2223
+ :param joined_datasets: Filter for joined datasets. Only returns joined datasets if True. Only returns non-joined datasets if False. Not applied if None.
2224
+ :type joined_datasets: bool
2225
+ :param data_plane_id: Filter datasets by the data plane (engine) that backs them.
2226
+ :type data_plane_id: str
2227
+ :param page: The page to return starting from 1 up to total_pages.
2228
+ :type page: int
2229
+ :param page_size: The number of records per page. The max is 1000.
2230
+ :type page_size: int
2231
+ :param _request_timeout: timeout setting for this request. If one
2232
+ number provided, it will be total request
2233
+ timeout. It can also be a pair (tuple) of
2234
+ (connection, read) timeouts.
2235
+ :type _request_timeout: int, tuple(int, int), optional
2236
+ :param _request_auth: set to override the auth_settings for an a single
2237
+ request; this effectively ignores the
2238
+ authentication in the spec for a single request.
2239
+ :type _request_auth: dict, optional
2240
+ :param _content_type: force content-type for the request.
2241
+ :type _content_type: str, Optional
2242
+ :param _headers: set to override the headers for a single
2243
+ request; this effectively ignores the headers
2244
+ in the spec for a single request.
2245
+ :type _headers: dict, optional
2246
+ :param _host_index: set to override the host_index for a single
2247
+ request; this effectively ignores the host_index
2248
+ in the spec for a single request.
2249
+ :type _host_index: int, optional
2250
+ :return: Returns the result object.
2251
+ """ # noqa: E501
2252
+
2253
+ _param = self._get_datasets_in_workspace_serialize(
2254
+ workspace_id=workspace_id,
2255
+ sort=sort,
2256
+ order=order,
2257
+ model_ids=model_ids,
2258
+ search=search,
2259
+ connector_type=connector_type,
2260
+ connector_name=connector_name,
2261
+ dataset_name=dataset_name,
2262
+ joined_datasets=joined_datasets,
2263
+ data_plane_id=data_plane_id,
2264
+ page=page,
2265
+ page_size=page_size,
2266
+ _request_auth=_request_auth,
2267
+ _content_type=_content_type,
2268
+ _headers=_headers,
2269
+ _host_index=_host_index
2270
+ )
2271
+
2272
+ _response_types_map: Dict[str, Optional[str]] = {
2273
+ '200': "ResourceListDataset",
2274
+ '500': "InternalServerError",
2275
+ '404': "NotFoundError",
2276
+ '422': "HTTPValidationError",
2277
+ }
2278
+ response_data = self.api_client.call_api(
2279
+ *_param,
2280
+ _request_timeout=_request_timeout
2281
+ )
2282
+ return response_data.response
2283
+
2284
+
2285
+ def _get_datasets_in_workspace_serialize(
2286
+ self,
2287
+ workspace_id,
2288
+ sort,
2289
+ order,
2290
+ model_ids,
2291
+ search,
2292
+ connector_type,
2293
+ connector_name,
2294
+ dataset_name,
2295
+ joined_datasets,
2296
+ data_plane_id,
2297
+ page,
2298
+ page_size,
2299
+ _request_auth,
2300
+ _content_type,
2301
+ _headers,
2302
+ _host_index,
2303
+ ) -> RequestSerialized:
2304
+
2305
+ _host = None
2306
+
2307
+ _collection_formats: Dict[str, str] = {
2308
+ 'model_ids': 'multi',
2309
+ }
2310
+
2311
+ _path_params: Dict[str, str] = {}
2312
+ _query_params: List[Tuple[str, str]] = []
2313
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2314
+ _form_params: List[Tuple[str, str]] = []
2315
+ _files: Dict[
2316
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2317
+ ] = {}
2318
+ _body_params: Optional[bytes] = None
2319
+
2320
+ # process the path parameters
2321
+ if workspace_id is not None:
2322
+ _path_params['workspace_id'] = workspace_id
2323
+ # process the query parameters
2324
+ if sort is not None:
2325
+
2326
+ _query_params.append(('sort', sort.value))
2327
+
2328
+ if order is not None:
2329
+
2330
+ _query_params.append(('order', order.value))
2331
+
2332
+ if model_ids is not None:
2333
+
2334
+ _query_params.append(('model_ids', model_ids))
2335
+
2336
+ if search is not None:
2337
+
2338
+ _query_params.append(('search', search))
2339
+
2340
+ if connector_type is not None:
2341
+
2342
+ _query_params.append(('connector_type', connector_type.value))
2343
+
2344
+ if connector_name is not None:
2345
+
2346
+ _query_params.append(('connector_name', connector_name))
2347
+
2348
+ if dataset_name is not None:
2349
+
2350
+ _query_params.append(('dataset_name', dataset_name))
2351
+
2352
+ if joined_datasets is not None:
2353
+
2354
+ _query_params.append(('joined_datasets', joined_datasets))
2355
+
2356
+ if data_plane_id is not None:
2357
+
2358
+ _query_params.append(('data_plane_id', data_plane_id))
2359
+
2360
+ if page is not None:
2361
+
2362
+ _query_params.append(('page', page))
2363
+
2364
+ if page_size is not None:
2365
+
2366
+ _query_params.append(('page_size', page_size))
2367
+
2368
+ # process the header parameters
2369
+ # process the form parameters
2370
+ # process the body parameter
2371
+
2372
+
2373
+ # set the HTTP header `Accept`
2374
+ if 'Accept' not in _header_params:
2375
+ _header_params['Accept'] = self.api_client.select_header_accept(
2376
+ [
2377
+ 'application/json'
2378
+ ]
2379
+ )
2380
+
2381
+
2382
+ # authentication setting
2383
+ _auth_settings: List[str] = [
2384
+ 'OAuth2AuthorizationCode'
2385
+ ]
2386
+
2387
+ return self.api_client.param_serialize(
2388
+ method='GET',
2389
+ resource_path='/api/v1/workspaces/{workspace_id}/datasets',
2390
+ path_params=_path_params,
2391
+ query_params=_query_params,
2392
+ header_params=_header_params,
2393
+ body=_body_params,
2394
+ post_params=_form_params,
2395
+ files=_files,
2396
+ auth_settings=_auth_settings,
2397
+ collection_formats=_collection_formats,
2398
+ _host=_host,
2399
+ _request_auth=_request_auth
2400
+ )
2401
+
2402
+
2403
+
2404
+
1947
2405
  @validate_call
1948
2406
  def patch_dataset(
1949
2407
  self,
@@ -10,6 +10,7 @@ Method | HTTP request | Description
10
10
  [**get_connector_datasets**](DatasetsV1Api.md#get_connector_datasets) | **GET** /api/v1/connectors/{connector_id}/datasets | Get Datasets By Connector Id
11
11
  [**get_dataset**](DatasetsV1Api.md#get_dataset) | **GET** /api/v1/datasets/{dataset_id} | Get Dataset By Id
12
12
  [**get_datasets**](DatasetsV1Api.md#get_datasets) | **GET** /api/v1/projects/{project_id}/datasets | Get Datasets
13
+ [**get_datasets_in_workspace**](DatasetsV1Api.md#get_datasets_in_workspace) | **GET** /api/v1/workspaces/{workspace_id}/datasets | Get Workspace Datasets.
13
14
  [**patch_dataset**](DatasetsV1Api.md#patch_dataset) | **PATCH** /api/v1/datasets/{dataset_id} | Update Dataset
14
15
  [**post_available_dataset**](DatasetsV1Api.md#post_available_dataset) | **POST** /api/v1/connectors/{connector_id}/available_datasets | Create Single Available Dataset
15
16
  [**post_connector_dataset**](DatasetsV1Api.md#post_connector_dataset) | **POST** /api/v1/connectors/{connector_id}/datasets | Create Connector Dataset
@@ -522,6 +523,109 @@ Name | Type | Description | Notes
522
523
 
523
524
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
524
525
 
526
+ # **get_datasets_in_workspace**
527
+ > ResourceListDataset get_datasets_in_workspace(workspace_id, sort=sort, order=order, model_ids=model_ids, search=search, connector_type=connector_type, connector_name=connector_name, dataset_name=dataset_name, joined_datasets=joined_datasets, data_plane_id=data_plane_id, page=page, page_size=page_size)
528
+
529
+ Get Workspace Datasets.
530
+
531
+ Endpoint requires workspace_list_datasets permission. It will only include datasets the user has additional dataset_read permissions on in the response.
532
+
533
+ ### Example
534
+
535
+ * OAuth Authentication (OAuth2AuthorizationCode):
536
+
537
+ ```python
538
+ import arthur_client.api_bindings
539
+ from arthur_client.api_bindings.models.connector_type import ConnectorType
540
+ from arthur_client.api_bindings.models.datasets_sort import DatasetsSort
541
+ from arthur_client.api_bindings.models.resource_list_dataset import ResourceListDataset
542
+ from arthur_client.api_bindings.models.sort_order import SortOrder
543
+ from arthur_client.api_bindings.rest import ApiException
544
+ from pprint import pprint
545
+
546
+ # Defining the host is optional and defaults to http://localhost
547
+ # See configuration.py for a list of all supported configuration parameters.
548
+ configuration = arthur_client.api_bindings.Configuration(
549
+ host = "http://localhost"
550
+ )
551
+
552
+ # The client must configure the authentication and authorization parameters
553
+ # in accordance with the API server security policy.
554
+ # Examples for each auth method are provided below, use the example that
555
+ # satisfies your auth use case.
556
+
557
+ configuration.access_token = os.environ["ACCESS_TOKEN"]
558
+
559
+ # Enter a context with an instance of the API client
560
+ with arthur_client.api_bindings.ApiClient(configuration) as api_client:
561
+ # Create an instance of the API class
562
+ api_instance = arthur_client.api_bindings.DatasetsV1Api(api_client)
563
+ workspace_id = 'workspace_id_example' # str |
564
+ sort = arthur_client.api_bindings.DatasetsSort() # DatasetsSort | Override the field used for sorting the returned list. Optional. (optional)
565
+ order = arthur_client.api_bindings.SortOrder() # SortOrder | Override the sort order used. Optional. (optional)
566
+ model_ids = ['model_ids_example'] # List[str] | Filter the results for datasets that are used by these models. Optional. (optional)
567
+ search = 'search_example' # str | Search for datasets by connector name or dataset name. (optional)
568
+ connector_type = arthur_client.api_bindings.ConnectorType() # ConnectorType | Filter datasets by connector type. (optional)
569
+ connector_name = 'connector_name_example' # str | Filter datasets by connector name. (optional)
570
+ dataset_name = 'dataset_name_example' # str | Filter datasets by dataset name. (optional)
571
+ joined_datasets = True # bool | Filter for joined datasets. Only returns joined datasets if True. Only returns non-joined datasets if False. Not applied if None. (optional)
572
+ data_plane_id = 'data_plane_id_example' # str | Filter datasets by the data plane (engine) that backs them. (optional)
573
+ page = 1 # int | The page to return starting from 1 up to total_pages. (optional) (default to 1)
574
+ page_size = 20 # int | The number of records per page. The max is 1000. (optional) (default to 20)
575
+
576
+ try:
577
+ # Get Workspace Datasets.
578
+ api_response = api_instance.get_datasets_in_workspace(workspace_id, sort=sort, order=order, model_ids=model_ids, search=search, connector_type=connector_type, connector_name=connector_name, dataset_name=dataset_name, joined_datasets=joined_datasets, data_plane_id=data_plane_id, page=page, page_size=page_size)
579
+ print("The response of DatasetsV1Api->get_datasets_in_workspace:\n")
580
+ pprint(api_response)
581
+ except Exception as e:
582
+ print("Exception when calling DatasetsV1Api->get_datasets_in_workspace: %s\n" % e)
583
+ ```
584
+
585
+
586
+
587
+ ### Parameters
588
+
589
+
590
+ Name | Type | Description | Notes
591
+ ------------- | ------------- | ------------- | -------------
592
+ **workspace_id** | **str**| |
593
+ **sort** | [**DatasetsSort**](.md)| Override the field used for sorting the returned list. Optional. | [optional]
594
+ **order** | [**SortOrder**](.md)| Override the sort order used. Optional. | [optional]
595
+ **model_ids** | [**List[str]**](str.md)| Filter the results for datasets that are used by these models. Optional. | [optional]
596
+ **search** | **str**| Search for datasets by connector name or dataset name. | [optional]
597
+ **connector_type** | [**ConnectorType**](.md)| Filter datasets by connector type. | [optional]
598
+ **connector_name** | **str**| Filter datasets by connector name. | [optional]
599
+ **dataset_name** | **str**| Filter datasets by dataset name. | [optional]
600
+ **joined_datasets** | **bool**| Filter for joined datasets. Only returns joined datasets if True. Only returns non-joined datasets if False. Not applied if None. | [optional]
601
+ **data_plane_id** | **str**| Filter datasets by the data plane (engine) that backs them. | [optional]
602
+ **page** | **int**| The page to return starting from 1 up to total_pages. | [optional] [default to 1]
603
+ **page_size** | **int**| The number of records per page. The max is 1000. | [optional] [default to 20]
604
+
605
+ ### Return type
606
+
607
+ [**ResourceListDataset**](ResourceListDataset.md)
608
+
609
+ ### Authorization
610
+
611
+ [OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
612
+
613
+ ### HTTP request headers
614
+
615
+ - **Content-Type**: Not defined
616
+ - **Accept**: application/json
617
+
618
+ ### HTTP response details
619
+
620
+ | Status code | Description | Response headers |
621
+ |-------------|-------------|------------------|
622
+ **200** | Successful Response | - |
623
+ **500** | Internal Server Error | - |
624
+ **404** | Not Found | - |
625
+ **422** | Validation Error | - |
626
+
627
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
628
+
525
629
  # **patch_dataset**
526
630
  > Dataset patch_dataset(dataset_id, patch_dataset)
527
631
 
@@ -91,6 +91,8 @@
91
91
 
92
92
  * `WORKSPACE_VALIDATE_CUSTOM_AGGREGATION` (value: `'workspace_validate_custom_aggregation'`)
93
93
 
94
+ * `WORKSPACE_LIST_DATASETS` (value: `'workspace_list_datasets'`)
95
+
94
96
  * `PROJECT_READ` (value: `'project_read'`)
95
97
 
96
98
  * `PROJECT_UPDATE` (value: `'project_update'`)
@@ -70,6 +70,7 @@ class PermissionName(str, Enum):
70
70
  WORKSPACE_TEST_WEBHOOK = 'workspace_test_webhook'
71
71
  WORKSPACE_CREATE_CUSTOM_AGGREGATION = 'workspace_create_custom_aggregation'
72
72
  WORKSPACE_VALIDATE_CUSTOM_AGGREGATION = 'workspace_validate_custom_aggregation'
73
+ WORKSPACE_LIST_DATASETS = 'workspace_list_datasets'
73
74
  PROJECT_READ = 'project_read'
74
75
  PROJECT_UPDATE = 'project_update'
75
76
  PROJECT_DELETE = 'project_delete'
@@ -68,6 +68,13 @@ class TestDatasetsV1Api(unittest.TestCase):
68
68
  """
69
69
  pass
70
70
 
71
+ def test_get_datasets_in_workspace(self) -> None:
72
+ """Test case for get_datasets_in_workspace
73
+
74
+ Get Workspace Datasets.
75
+ """
76
+ pass
77
+
71
78
  def test_patch_dataset(self) -> None:
72
79
  """Test case for patch_dataset
73
80
 
@@ -128,6 +128,7 @@ Class | Method | HTTP request | Description
128
128
  *DatasetsV1Api* | [**get_connector_datasets**](arthur_client/api_bindings/docs/DatasetsV1Api.md#get_connector_datasets) | **GET** /api/v1/connectors/{connector_id}/datasets | Get Datasets By Connector Id
129
129
  *DatasetsV1Api* | [**get_dataset**](arthur_client/api_bindings/docs/DatasetsV1Api.md#get_dataset) | **GET** /api/v1/datasets/{dataset_id} | Get Dataset By Id
130
130
  *DatasetsV1Api* | [**get_datasets**](arthur_client/api_bindings/docs/DatasetsV1Api.md#get_datasets) | **GET** /api/v1/projects/{project_id}/datasets | Get Datasets
131
+ *DatasetsV1Api* | [**get_datasets_in_workspace**](arthur_client/api_bindings/docs/DatasetsV1Api.md#get_datasets_in_workspace) | **GET** /api/v1/workspaces/{workspace_id}/datasets | Get Workspace Datasets.
131
132
  *DatasetsV1Api* | [**patch_dataset**](arthur_client/api_bindings/docs/DatasetsV1Api.md#patch_dataset) | **PATCH** /api/v1/datasets/{dataset_id} | Update Dataset
132
133
  *DatasetsV1Api* | [**post_available_dataset**](arthur_client/api_bindings/docs/DatasetsV1Api.md#post_available_dataset) | **POST** /api/v1/connectors/{connector_id}/available_datasets | Create Single Available Dataset
133
134
  *DatasetsV1Api* | [**post_connector_dataset**](arthur_client/api_bindings/docs/DatasetsV1Api.md#post_connector_dataset) | **POST** /api/v1/connectors/{connector_id}/datasets | Create Connector Dataset
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: arthur-client
3
- Version: 1.4.1243
3
+ Version: 1.4.1245
4
4
  Summary: Arthur Python API Client Library
5
5
  License: MIT
6
6
  Keywords: api arthur client ArthurAI sdk ml model monitoring
@@ -11,7 +11,7 @@ arthur_client/api_bindings/api/custom_aggregations_v1_api.py,sha256=tDsJ27hsdFkP
11
11
  arthur_client/api_bindings/api/data_plane_associations_v1_api.py,sha256=16sLHbpsgOO2TtUqLpXsHO5dbLkjHw8R0p6zir-61z0,72612
12
12
  arthur_client/api_bindings/api/data_planes_v1_api.py,sha256=v-1GgCyTa3r1ns3l-vWN1eoVzueOdZOQRfaca0BY9WI,72069
13
13
  arthur_client/api_bindings/api/data_retrieval_v1_api.py,sha256=jzxN8pcdtbgJN9SnwhCCmGhN4FOlkCdmFmW1WLkv0R8,97319
14
- arthur_client/api_bindings/api/datasets_v1_api.py,sha256=Cv6viMcsDkS1JNVUqYCVNk_mxzcwsgnKQ5SKlOC3_EA,173856
14
+ arthur_client/api_bindings/api/datasets_v1_api.py,sha256=Kdo-MQWhM5q2wGODkXSwxIec8Fm4624X5ryzM5lNR-M,195904
15
15
  arthur_client/api_bindings/api/default_api.py,sha256=PQLPiheDpRr7veZzHlwPvJX1me5QwZZpXZsgyZPoXuw,10592
16
16
  arthur_client/api_bindings/api/feature_flags_v1_api.py,sha256=PRotgww8FLORomBQGj-v2bqvfMwfHoW48mlPP9zj7HQ,10550
17
17
  arthur_client/api_bindings/api/groups_v1_api.py,sha256=vCIf6HnslrTocrP1L8FhLwiAZGmx2J7Wi5IC3wVZNjQ,111703
@@ -116,7 +116,7 @@ arthur_client/api_bindings/docs/DatasetReference.md,sha256=yx1QssxQRjVfuoaxsbai2
116
116
  arthur_client/api_bindings/docs/DatasetScalarType.md,sha256=4Rd2vV9Wku1xvD2EJnnUMafGJMs_NssWDMEZXE1RsmE,1148
117
117
  arthur_client/api_bindings/docs/DatasetSchema.md,sha256=dMkTO-S2hr5sEgHkraBsLLoOt_-ZiDBlb1KikLJqlIA,1013
118
118
  arthur_client/api_bindings/docs/DatasetsSort.md,sha256=wVePgYxyAJwUYb61_qqGgwohBapA_WYgwD8Ez55OoWQ,270
119
- arthur_client/api_bindings/docs/DatasetsV1Api.md,sha256=hxgS6Y4j8yJXE6v-Ec8zULlw4Vl91gq51AWObBG_oSw,43002
119
+ arthur_client/api_bindings/docs/DatasetsV1Api.md,sha256=tmB7UEpAN6F3WBQIUXbjzrAX0qoN8u0L_4c6Aii-4sY,48914
120
120
  arthur_client/api_bindings/docs/DefaultApi.md,sha256=ZdNg7QYC28cMm7AHg0Qj6S4X0jzlcXshs5vvAnP8nAs,2074
121
121
  arthur_client/api_bindings/docs/Definition.md,sha256=_2iFOJbfKMQH4cGX5zeCYSs6OAMSHOsbM8En74M3bh4,1149
122
122
  arthur_client/api_bindings/docs/DeleteGroupMembership.md,sha256=iVpp-NX2n7BiJHYVTpKpo9xREN83t5YuEkDe0FmnZdI,1041
@@ -213,7 +213,7 @@ arthur_client/api_bindings/docs/PatchUser.md,sha256=Fcd1053Y23aSfdqZED6IyRnU9ANE
213
213
  arthur_client/api_bindings/docs/PatchWebhook.md,sha256=jHwNOM3SJiLhhbytRcaoEe3jPoMlBRPBxztE3IVQHfI,1002
214
214
  arthur_client/api_bindings/docs/PatchWorkspace.md,sha256=eE29MZcSAT7B-uaqTI0G5J7AWAifqSxAgtOVOd8rVAY,912
215
215
  arthur_client/api_bindings/docs/Permission.md,sha256=EiAeK7f_rgOlGja6RJ4iRtxh9ayDKMWkoU3Pho_GJBo,1070
216
- arthur_client/api_bindings/docs/PermissionName.md,sha256=VfX0dszKfq6QjjXCHiFIZhLiw5HDAWCp3cEpp5Jot_s,9268
216
+ arthur_client/api_bindings/docs/PermissionName.md,sha256=Mk8wYVECL02f1Yo3X2HRpsTQjHm9e2kpuM1agR7PDrI,9334
217
217
  arthur_client/api_bindings/docs/PermissionRequestItem.md,sha256=CAxi_zbsM7R9aEEQUOULS4xAnTouK4-bTzD1zu_WDdg,1230
218
218
  arthur_client/api_bindings/docs/PermissionResponseItem.md,sha256=yCRdqfZWrwO7GmmgwCHJmefNTTXWgAVyJhsFI8vUoSE,1332
219
219
  arthur_client/api_bindings/docs/PermissionsRequest.md,sha256=kLsczcoS-LvL3N55hx7mYUkt26Djyo_sI5vymKG7Nco,1119
@@ -510,7 +510,7 @@ arthur_client/api_bindings/models/patch_user.py,sha256=Q_RqYiqCFjWsHfTWK0RqpdKpJ
510
510
  arthur_client/api_bindings/models/patch_webhook.py,sha256=Nck18gezSVXn3Tsn2FgbmaVWvlajrm_rRY1Lt7XKRtU,3571
511
511
  arthur_client/api_bindings/models/patch_workspace.py,sha256=oX4U-aAgTlCZr5Xor8tyZWBZBll5BwgCeqNXyfC4rAc,2530
512
512
  arthur_client/api_bindings/models/permission.py,sha256=w-7TJQxENx0-ydmU_0ur9cP0WcF4hBqggRKbGSlSM-U,3004
513
- arthur_client/api_bindings/models/permission_name.py,sha256=heLQAxBdf0LO6Lzkccd1UkdhRryDfkvw3MjxzMf1iak,8422
513
+ arthur_client/api_bindings/models/permission_name.py,sha256=eTFTFGQcb0qdgGp24jHHoXoiX-FXXpxOYm2HRVMSlFs,8478
514
514
  arthur_client/api_bindings/models/permission_request_item.py,sha256=eDI23WHf9UHR0MO-Zharyz-nF7M37SxYsHB1vkaQzdI,3086
515
515
  arthur_client/api_bindings/models/permission_response_item.py,sha256=kMBj_O-lse6TUPmjHOiBNX8S9cTSuZrzk24a42Nh4RU,3264
516
516
  arthur_client/api_bindings/models/permissions_request.py,sha256=RNtY39w0PapomLkkoHBLgNWGtgvgV8dodjCFmHqq28Q,3312
@@ -723,7 +723,7 @@ arthur_client/api_bindings/test/test_dataset_reference.py,sha256=DpUIEG4YPxCu81I
723
723
  arthur_client/api_bindings/test/test_dataset_scalar_type.py,sha256=LuuwsBV7dfWJKVRTn8JgYCBIDNxt7u0gGbBClwAPsS4,1627
724
724
  arthur_client/api_bindings/test/test_dataset_schema.py,sha256=6zopy0muXNlEoj7AeRZDEC0tLnKYHhuZ4mrq6sWo0oY,2217
725
725
  arthur_client/api_bindings/test/test_datasets_sort.py,sha256=nebPChnVOfreS8pFQBj27bKFxeSb_oaTM8pXW_dVRos,714
726
- arthur_client/api_bindings/test/test_datasets_v1_api.py,sha256=VP_0dFSEgU3otW4LQyBNKoNeVyk8GZ_tcTTgUf4QUJ0,2876
726
+ arthur_client/api_bindings/test/test_datasets_v1_api.py,sha256=_JZAZMk4eS5d0W4IZc8TQnge2f6kWdO-kjes19PboHA,3040
727
727
  arthur_client/api_bindings/test/test_default_api.py,sha256=GqoajNSt0RUDE-aIOJaXVZzNI1k2MYfhqlCHaB_sEwQ,800
728
728
  arthur_client/api_bindings/test/test_definition.py,sha256=6bi89ZELM4htGGda7Ivu95wOwN-1a7S4P7u7-BUvEHU,1767
729
729
  arthur_client/api_bindings/test/test_delete_group_membership.py,sha256=91fQ963Xqoh87Gq8qGC3Wm2PAJ-VFvVYX8LR3ib-Pe4,1606
@@ -954,13 +954,13 @@ arthur_client/api_bindings/test/test_webhooks_v1_api.py,sha256=7x3pb2tZdXbnSAI-w
954
954
  arthur_client/api_bindings/test/test_workspace.py,sha256=hDjh6CQ8oHTVk_X3fb_wKVPp_cY9bQFAGmNh7qMKpIw,1918
955
955
  arthur_client/api_bindings/test/test_workspace_sort.py,sha256=PDxv__jzX9VXu54ExqHJTLHRn9XKwGVwYjZ4OdFBmLk,721
956
956
  arthur_client/api_bindings/test/test_workspaces_v1_api.py,sha256=_EdT96HqIQWQ64Oy11CEP4LqcJhZPB_EYzCYbhceJG0,1345
957
- arthur_client/api_bindings_README.md,sha256=FIOJVWTQ5eQkxmwe-nZJ7SVlC7l_QZ8UIZxovy1c9xg,53113
957
+ arthur_client/api_bindings_README.md,sha256=2rBseffP12b2VJ1SOuLwnGZu2V1GXPL9GElAO77ol8c,53318
958
958
  arthur_client/auth/__init__.py,sha256=f4XqpGe9d1V0xlocq2JlNtd8l_GUoUOy6_1yTMCBsc0,210
959
959
  arthur_client/auth/constants.py,sha256=lIEdf1UujvAZhueQ8WZGjd3ErcJlCmrXRxjRhTRNb18,38
960
960
  arthur_client/auth/device_authorizer.py,sha256=bJMIZRjkwQwoSWTLEp7OoXM2MytO3ADSD97Qlc1accA,2598
961
961
  arthur_client/auth/discovery.py,sha256=hR0MglzRWHdwyi72If5hTnjO50fDJhquP_DD7OzjIQQ,1188
962
962
  arthur_client/auth/oauth_api_config.py,sha256=MB-bwm6Qo_USZD_4KVId6d_v5OtLBphwBjMjslVjTlo,1348
963
963
  arthur_client/auth/session.py,sha256=wCriib5ajfm1e1WTL_QXVCJmEOrGwQg_0v91e5qrC6g,2649
964
- arthur_client-1.4.1243.dist-info/METADATA,sha256=Nmxb33GAf1n0dIJ0L80K4B5buh60leMkTgd7E-9_2Vo,1730
965
- arthur_client-1.4.1243.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
966
- arthur_client-1.4.1243.dist-info/RECORD,,
964
+ arthur_client-1.4.1245.dist-info/METADATA,sha256=V76sDuG3M_w8yJQO-XL9nMUinVuwpLz-SbBDfUsT2nU,1730
965
+ arthur_client-1.4.1245.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
966
+ arthur_client-1.4.1245.dist-info/RECORD,,