perceptic-core-client 0.6.1__py3-none-any.whl → 0.6.3__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.

Potentially problematic release.


This version of perceptic-core-client might be problematic. Click here for more details.

Files changed (75) hide show
  1. perceptic_core_client-0.6.3.dist-info/METADATA +93 -0
  2. {perceptic_core_client-0.6.1.dist-info → perceptic_core_client-0.6.3.dist-info}/RECORD +4 -74
  3. perceptic_core_client/perceptic_core_client/docs/ActionType.md +0 -14
  4. perceptic_core_client/perceptic_core_client/docs/AzureBlobConnectionSettingsApiDto.md +0 -33
  5. perceptic_core_client/perceptic_core_client/docs/AzureBlobFileSystemRootMetadataApiDto.md +0 -30
  6. perceptic_core_client/perceptic_core_client/docs/ConnectionApiDto.md +0 -33
  7. perceptic_core_client/perceptic_core_client/docs/ConnectionResourceApi.md +0 -144
  8. perceptic_core_client/perceptic_core_client/docs/ConnectionSettingsApiDto.md +0 -36
  9. perceptic_core_client/perceptic_core_client/docs/CreateConnectionRequest.md +0 -31
  10. perceptic_core_client/perceptic_core_client/docs/CreateConnectionResponse.md +0 -29
  11. perceptic_core_client/perceptic_core_client/docs/CreateFileSystemResponse.md +0 -29
  12. perceptic_core_client/perceptic_core_client/docs/CreateFolderRequest.md +0 -29
  13. perceptic_core_client/perceptic_core_client/docs/CreateFolderResponse.md +0 -29
  14. perceptic_core_client/perceptic_core_client/docs/CreateIndexingTaskRequest.md +0 -33
  15. perceptic_core_client/perceptic_core_client/docs/CreateIndexingTaskResponse.md +0 -31
  16. perceptic_core_client/perceptic_core_client/docs/CreateManagedFileSystemRequest.md +0 -30
  17. perceptic_core_client/perceptic_core_client/docs/CreateRemoteFileSystemRequest.md +0 -32
  18. perceptic_core_client/perceptic_core_client/docs/FileSystemApiDto.md +0 -34
  19. perceptic_core_client/perceptic_core_client/docs/FileSystemContentsResourceApi.md +0 -573
  20. perceptic_core_client/perceptic_core_client/docs/FileSystemResourceApi.md +0 -276
  21. perceptic_core_client/perceptic_core_client/docs/FileSystemRootMetadataApiDto.md +0 -31
  22. perceptic_core_client/perceptic_core_client/docs/GetConnectionResponse.md +0 -29
  23. perceptic_core_client/perceptic_core_client/docs/GetIndexerResponse.md +0 -29
  24. perceptic_core_client/perceptic_core_client/docs/GetIndexingTaskResponse.md +0 -29
  25. perceptic_core_client/perceptic_core_client/docs/GetMetadataResponse.md +0 -29
  26. perceptic_core_client/perceptic_core_client/docs/GetParentResponse.md +0 -29
  27. perceptic_core_client/perceptic_core_client/docs/GetParentUriResponse.md +0 -29
  28. perceptic_core_client/perceptic_core_client/docs/GetSignedUrlResponse.md +0 -29
  29. perceptic_core_client/perceptic_core_client/docs/GetWorkerEventsResponse.md +0 -29
  30. perceptic_core_client/perceptic_core_client/docs/GetWorkerMetadataResponse.md +0 -29
  31. perceptic_core_client/perceptic_core_client/docs/GetWorkerStatusResponse.md +0 -29
  32. perceptic_core_client/perceptic_core_client/docs/GetWorkersResponse.md +0 -29
  33. perceptic_core_client/perceptic_core_client/docs/IndexerDto.md +0 -32
  34. perceptic_core_client/perceptic_core_client/docs/IndexerResourceApi.md +0 -138
  35. perceptic_core_client/perceptic_core_client/docs/IndexingActionDto.md +0 -35
  36. perceptic_core_client/perceptic_core_client/docs/IndexingActionStatus.md +0 -16
  37. perceptic_core_client/perceptic_core_client/docs/IndexingTaskDto.md +0 -36
  38. perceptic_core_client/perceptic_core_client/docs/IndexingTaskResourceApi.md +0 -289
  39. perceptic_core_client/perceptic_core_client/docs/IndexingTaskStatus.md +0 -29
  40. perceptic_core_client/perceptic_core_client/docs/InfoEvent.md +0 -31
  41. perceptic_core_client/perceptic_core_client/docs/JsonNode.md +0 -50
  42. perceptic_core_client/perceptic_core_client/docs/JsonNodeType.md +0 -26
  43. perceptic_core_client/perceptic_core_client/docs/ListAllFileSystemsResponse.md +0 -29
  44. perceptic_core_client/perceptic_core_client/docs/ListFileSystemResponse.md +0 -29
  45. perceptic_core_client/perceptic_core_client/docs/ListIndexersResponse.md +0 -29
  46. perceptic_core_client/perceptic_core_client/docs/ListIndexingActionsResponse.md +0 -37
  47. perceptic_core_client/perceptic_core_client/docs/ManagedFileSystemApiDto.md +0 -32
  48. perceptic_core_client/perceptic_core_client/docs/MeResponse.md +0 -33
  49. perceptic_core_client/perceptic_core_client/docs/ModelSchema.md +0 -38
  50. perceptic_core_client/perceptic_core_client/docs/PagedListFileSystemResponse.md +0 -30
  51. perceptic_core_client/perceptic_core_client/docs/PostWorkerRunRequest.md +0 -29
  52. perceptic_core_client/perceptic_core_client/docs/PostWorkerRunResponse.md +0 -29
  53. perceptic_core_client/perceptic_core_client/docs/ProgressEvent.md +0 -31
  54. perceptic_core_client/perceptic_core_client/docs/RemoteFileSystemApiDto.md +0 -34
  55. perceptic_core_client/perceptic_core_client/docs/RequestForInputEvent.md +0 -32
  56. perceptic_core_client/perceptic_core_client/docs/ResourceEntryDto.md +0 -30
  57. perceptic_core_client/perceptic_core_client/docs/ResourceId.md +0 -29
  58. perceptic_core_client/perceptic_core_client/docs/ResourceIdentifier.md +0 -36
  59. perceptic_core_client/perceptic_core_client/docs/ResourceMetadataDto.md +0 -38
  60. perceptic_core_client/perceptic_core_client/docs/ResourceTypeDto.md +0 -12
  61. perceptic_core_client/perceptic_core_client/docs/RunStatusDto.md +0 -26
  62. perceptic_core_client/perceptic_core_client/docs/S3ConnectionSettingsApiDto.md +0 -33
  63. perceptic_core_client/perceptic_core_client/docs/S3FileSystemRootMetadataApiDto.md +0 -30
  64. perceptic_core_client/perceptic_core_client/docs/SchemaLocation.md +0 -30
  65. perceptic_core_client/perceptic_core_client/docs/StartExecutionResponse.md +0 -29
  66. perceptic_core_client/perceptic_core_client/docs/UploadFileToManagedFileSystemResponse.md +0 -29
  67. perceptic_core_client/perceptic_core_client/docs/UriResourceApi.md +0 -413
  68. perceptic_core_client/perceptic_core_client/docs/UserResourceApi.md +0 -71
  69. perceptic_core_client/perceptic_core_client/docs/WorkerEvent.md +0 -34
  70. perceptic_core_client/perceptic_core_client/docs/WorkerMetadataDto.md +0 -32
  71. perceptic_core_client/perceptic_core_client/docs/WorkerResourceApi.md +0 -427
  72. perceptic_core_client/perceptic_core_client_README.md +0 -181
  73. perceptic_core_client-0.6.1.dist-info/METADATA +0 -179
  74. {perceptic_core_client-0.6.1.dist-info → perceptic_core_client-0.6.3.dist-info}/WHEEL +0 -0
  75. {perceptic_core_client-0.6.1.dist-info → perceptic_core_client-0.6.3.dist-info}/top_level.txt +0 -0
@@ -1,427 +0,0 @@
1
- # perceptic_core_client.WorkerResourceApi
2
-
3
- All URIs are relative to *http://localhost*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**api_v1_workers_get**](WorkerResourceApi.md#api_v1_workers_get) | **GET** /api/v1/workers | Get Workers
8
- [**api_v1_workers_worker_id_get**](WorkerResourceApi.md#api_v1_workers_worker_id_get) | **GET** /api/v1/workers/{workerId} | Get Worker Metadata
9
- [**api_v1_workers_worker_id_runs_post**](WorkerResourceApi.md#api_v1_workers_worker_id_runs_post) | **POST** /api/v1/workers/{workerId}/runs | Post Worker Run
10
- [**api_v1_workers_worker_id_runs_run_rid_events_get**](WorkerResourceApi.md#api_v1_workers_worker_id_runs_run_rid_events_get) | **GET** /api/v1/workers/{workerId}/runs/{runRid}/events | Get Worker Run Events
11
- [**api_v1_workers_worker_id_runs_run_rid_resume_post**](WorkerResourceApi.md#api_v1_workers_worker_id_runs_run_rid_resume_post) | **POST** /api/v1/workers/{workerId}/runs/{runRid}/resume | Post Resume Run
12
- [**api_v1_workers_worker_id_runs_run_rid_status_get**](WorkerResourceApi.md#api_v1_workers_worker_id_runs_run_rid_status_get) | **GET** /api/v1/workers/{workerId}/runs/{runRid}/status | Get Worker Run Status
13
-
14
-
15
- # **api_v1_workers_get**
16
- > GetWorkersResponse api_v1_workers_get()
17
-
18
- Get Workers
19
-
20
- ### Example
21
-
22
-
23
- ```python
24
- import perceptic_core_client
25
- from perceptic_core_client.models.get_workers_response import GetWorkersResponse
26
- from perceptic_core_client.rest import ApiException
27
- from pprint import pprint
28
-
29
- # Defining the host is optional and defaults to http://localhost
30
- # See configuration.py for a list of all supported configuration parameters.
31
- configuration = perceptic_core_client.Configuration(
32
- host = "http://localhost"
33
- )
34
-
35
-
36
- # Enter a context with an instance of the API client
37
- with perceptic_core_client.ApiClient(configuration) as api_client:
38
- # Create an instance of the API class
39
- api_instance = perceptic_core_client.WorkerResourceApi(api_client)
40
-
41
- try:
42
- # Get Workers
43
- api_response = api_instance.api_v1_workers_get()
44
- print("The response of WorkerResourceApi->api_v1_workers_get:\n")
45
- pprint(api_response)
46
- except Exception as e:
47
- print("Exception when calling WorkerResourceApi->api_v1_workers_get: %s\n" % e)
48
- ```
49
-
50
-
51
-
52
- ### Parameters
53
-
54
- This endpoint does not need any parameter.
55
-
56
- ### Return type
57
-
58
- [**GetWorkersResponse**](GetWorkersResponse.md)
59
-
60
- ### Authorization
61
-
62
- No authorization required
63
-
64
- ### HTTP request headers
65
-
66
- - **Content-Type**: Not defined
67
- - **Accept**: application/json
68
-
69
- ### HTTP response details
70
-
71
- | Status code | Description | Response headers |
72
- |-------------|-------------|------------------|
73
- **200** | OK | - |
74
-
75
- [[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)
76
-
77
- # **api_v1_workers_worker_id_get**
78
- > GetWorkerMetadataResponse api_v1_workers_worker_id_get(worker_id, version=version)
79
-
80
- Get Worker Metadata
81
-
82
- ### Example
83
-
84
-
85
- ```python
86
- import perceptic_core_client
87
- from perceptic_core_client.models.get_worker_metadata_response import GetWorkerMetadataResponse
88
- from perceptic_core_client.rest import ApiException
89
- from pprint import pprint
90
-
91
- # Defining the host is optional and defaults to http://localhost
92
- # See configuration.py for a list of all supported configuration parameters.
93
- configuration = perceptic_core_client.Configuration(
94
- host = "http://localhost"
95
- )
96
-
97
-
98
- # Enter a context with an instance of the API client
99
- with perceptic_core_client.ApiClient(configuration) as api_client:
100
- # Create an instance of the API class
101
- api_instance = perceptic_core_client.WorkerResourceApi(api_client)
102
- worker_id = 'worker_id_example' # str |
103
- version = 'version_example' # str | (optional)
104
-
105
- try:
106
- # Get Worker Metadata
107
- api_response = api_instance.api_v1_workers_worker_id_get(worker_id, version=version)
108
- print("The response of WorkerResourceApi->api_v1_workers_worker_id_get:\n")
109
- pprint(api_response)
110
- except Exception as e:
111
- print("Exception when calling WorkerResourceApi->api_v1_workers_worker_id_get: %s\n" % e)
112
- ```
113
-
114
-
115
-
116
- ### Parameters
117
-
118
-
119
- Name | Type | Description | Notes
120
- ------------- | ------------- | ------------- | -------------
121
- **worker_id** | **str**| |
122
- **version** | **str**| | [optional]
123
-
124
- ### Return type
125
-
126
- [**GetWorkerMetadataResponse**](GetWorkerMetadataResponse.md)
127
-
128
- ### Authorization
129
-
130
- No authorization required
131
-
132
- ### HTTP request headers
133
-
134
- - **Content-Type**: Not defined
135
- - **Accept**: application/json
136
-
137
- ### HTTP response details
138
-
139
- | Status code | Description | Response headers |
140
- |-------------|-------------|------------------|
141
- **200** | OK | - |
142
-
143
- [[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)
144
-
145
- # **api_v1_workers_worker_id_runs_post**
146
- > PostWorkerRunResponse api_v1_workers_worker_id_runs_post(worker_id, post_worker_run_request, version=version)
147
-
148
- Post Worker Run
149
-
150
- ### Example
151
-
152
-
153
- ```python
154
- import perceptic_core_client
155
- from perceptic_core_client.models.post_worker_run_request import PostWorkerRunRequest
156
- from perceptic_core_client.models.post_worker_run_response import PostWorkerRunResponse
157
- from perceptic_core_client.rest import ApiException
158
- from pprint import pprint
159
-
160
- # Defining the host is optional and defaults to http://localhost
161
- # See configuration.py for a list of all supported configuration parameters.
162
- configuration = perceptic_core_client.Configuration(
163
- host = "http://localhost"
164
- )
165
-
166
-
167
- # Enter a context with an instance of the API client
168
- with perceptic_core_client.ApiClient(configuration) as api_client:
169
- # Create an instance of the API class
170
- api_instance = perceptic_core_client.WorkerResourceApi(api_client)
171
- worker_id = 'worker_id_example' # str |
172
- post_worker_run_request = perceptic_core_client.PostWorkerRunRequest() # PostWorkerRunRequest |
173
- version = 'version_example' # str | (optional)
174
-
175
- try:
176
- # Post Worker Run
177
- api_response = api_instance.api_v1_workers_worker_id_runs_post(worker_id, post_worker_run_request, version=version)
178
- print("The response of WorkerResourceApi->api_v1_workers_worker_id_runs_post:\n")
179
- pprint(api_response)
180
- except Exception as e:
181
- print("Exception when calling WorkerResourceApi->api_v1_workers_worker_id_runs_post: %s\n" % e)
182
- ```
183
-
184
-
185
-
186
- ### Parameters
187
-
188
-
189
- Name | Type | Description | Notes
190
- ------------- | ------------- | ------------- | -------------
191
- **worker_id** | **str**| |
192
- **post_worker_run_request** | [**PostWorkerRunRequest**](PostWorkerRunRequest.md)| |
193
- **version** | **str**| | [optional]
194
-
195
- ### Return type
196
-
197
- [**PostWorkerRunResponse**](PostWorkerRunResponse.md)
198
-
199
- ### Authorization
200
-
201
- No authorization required
202
-
203
- ### HTTP request headers
204
-
205
- - **Content-Type**: application/json
206
- - **Accept**: application/json
207
-
208
- ### HTTP response details
209
-
210
- | Status code | Description | Response headers |
211
- |-------------|-------------|------------------|
212
- **200** | OK | - |
213
- **400** | Bad Request | - |
214
-
215
- [[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)
216
-
217
- # **api_v1_workers_worker_id_runs_run_rid_events_get**
218
- > GetWorkerEventsResponse api_v1_workers_worker_id_runs_run_rid_events_get(run_rid, worker_id, limit=limit, offset=offset)
219
-
220
- Get Worker Run Events
221
-
222
- ### Example
223
-
224
-
225
- ```python
226
- import perceptic_core_client
227
- from perceptic_core_client.models.get_worker_events_response import GetWorkerEventsResponse
228
- from perceptic_core_client.rest import ApiException
229
- from pprint import pprint
230
-
231
- # Defining the host is optional and defaults to http://localhost
232
- # See configuration.py for a list of all supported configuration parameters.
233
- configuration = perceptic_core_client.Configuration(
234
- host = "http://localhost"
235
- )
236
-
237
-
238
- # Enter a context with an instance of the API client
239
- with perceptic_core_client.ApiClient(configuration) as api_client:
240
- # Create an instance of the API class
241
- api_instance = perceptic_core_client.WorkerResourceApi(api_client)
242
- run_rid = 'run_rid_example' # str |
243
- worker_id = 'worker_id_example' # str |
244
- limit = 50 # int | (optional) (default to 50)
245
- offset = 0 # int | (optional) (default to 0)
246
-
247
- try:
248
- # Get Worker Run Events
249
- api_response = api_instance.api_v1_workers_worker_id_runs_run_rid_events_get(run_rid, worker_id, limit=limit, offset=offset)
250
- print("The response of WorkerResourceApi->api_v1_workers_worker_id_runs_run_rid_events_get:\n")
251
- pprint(api_response)
252
- except Exception as e:
253
- print("Exception when calling WorkerResourceApi->api_v1_workers_worker_id_runs_run_rid_events_get: %s\n" % e)
254
- ```
255
-
256
-
257
-
258
- ### Parameters
259
-
260
-
261
- Name | Type | Description | Notes
262
- ------------- | ------------- | ------------- | -------------
263
- **run_rid** | **str**| |
264
- **worker_id** | **str**| |
265
- **limit** | **int**| | [optional] [default to 50]
266
- **offset** | **int**| | [optional] [default to 0]
267
-
268
- ### Return type
269
-
270
- [**GetWorkerEventsResponse**](GetWorkerEventsResponse.md)
271
-
272
- ### Authorization
273
-
274
- No authorization required
275
-
276
- ### HTTP request headers
277
-
278
- - **Content-Type**: Not defined
279
- - **Accept**: application/json
280
-
281
- ### HTTP response details
282
-
283
- | Status code | Description | Response headers |
284
- |-------------|-------------|------------------|
285
- **200** | OK | - |
286
-
287
- [[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)
288
-
289
- # **api_v1_workers_worker_id_runs_run_rid_resume_post**
290
- > object api_v1_workers_worker_id_runs_run_rid_resume_post(run_rid, worker_id, post_worker_run_request)
291
-
292
- Post Resume Run
293
-
294
- ### Example
295
-
296
-
297
- ```python
298
- import perceptic_core_client
299
- from perceptic_core_client.models.post_worker_run_request import PostWorkerRunRequest
300
- from perceptic_core_client.rest import ApiException
301
- from pprint import pprint
302
-
303
- # Defining the host is optional and defaults to http://localhost
304
- # See configuration.py for a list of all supported configuration parameters.
305
- configuration = perceptic_core_client.Configuration(
306
- host = "http://localhost"
307
- )
308
-
309
-
310
- # Enter a context with an instance of the API client
311
- with perceptic_core_client.ApiClient(configuration) as api_client:
312
- # Create an instance of the API class
313
- api_instance = perceptic_core_client.WorkerResourceApi(api_client)
314
- run_rid = 'run_rid_example' # str |
315
- worker_id = 'worker_id_example' # str |
316
- post_worker_run_request = perceptic_core_client.PostWorkerRunRequest() # PostWorkerRunRequest |
317
-
318
- try:
319
- # Post Resume Run
320
- api_response = api_instance.api_v1_workers_worker_id_runs_run_rid_resume_post(run_rid, worker_id, post_worker_run_request)
321
- print("The response of WorkerResourceApi->api_v1_workers_worker_id_runs_run_rid_resume_post:\n")
322
- pprint(api_response)
323
- except Exception as e:
324
- print("Exception when calling WorkerResourceApi->api_v1_workers_worker_id_runs_run_rid_resume_post: %s\n" % e)
325
- ```
326
-
327
-
328
-
329
- ### Parameters
330
-
331
-
332
- Name | Type | Description | Notes
333
- ------------- | ------------- | ------------- | -------------
334
- **run_rid** | **str**| |
335
- **worker_id** | **str**| |
336
- **post_worker_run_request** | [**PostWorkerRunRequest**](PostWorkerRunRequest.md)| |
337
-
338
- ### Return type
339
-
340
- **object**
341
-
342
- ### Authorization
343
-
344
- No authorization required
345
-
346
- ### HTTP request headers
347
-
348
- - **Content-Type**: application/json
349
- - **Accept**: application/json
350
-
351
- ### HTTP response details
352
-
353
- | Status code | Description | Response headers |
354
- |-------------|-------------|------------------|
355
- **200** | OK | - |
356
- **400** | Bad Request | - |
357
-
358
- [[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)
359
-
360
- # **api_v1_workers_worker_id_runs_run_rid_status_get**
361
- > GetWorkerStatusResponse api_v1_workers_worker_id_runs_run_rid_status_get(run_rid, worker_id)
362
-
363
- Get Worker Run Status
364
-
365
- ### Example
366
-
367
-
368
- ```python
369
- import perceptic_core_client
370
- from perceptic_core_client.models.get_worker_status_response import GetWorkerStatusResponse
371
- from perceptic_core_client.rest import ApiException
372
- from pprint import pprint
373
-
374
- # Defining the host is optional and defaults to http://localhost
375
- # See configuration.py for a list of all supported configuration parameters.
376
- configuration = perceptic_core_client.Configuration(
377
- host = "http://localhost"
378
- )
379
-
380
-
381
- # Enter a context with an instance of the API client
382
- with perceptic_core_client.ApiClient(configuration) as api_client:
383
- # Create an instance of the API class
384
- api_instance = perceptic_core_client.WorkerResourceApi(api_client)
385
- run_rid = 'run_rid_example' # str |
386
- worker_id = 'worker_id_example' # str |
387
-
388
- try:
389
- # Get Worker Run Status
390
- api_response = api_instance.api_v1_workers_worker_id_runs_run_rid_status_get(run_rid, worker_id)
391
- print("The response of WorkerResourceApi->api_v1_workers_worker_id_runs_run_rid_status_get:\n")
392
- pprint(api_response)
393
- except Exception as e:
394
- print("Exception when calling WorkerResourceApi->api_v1_workers_worker_id_runs_run_rid_status_get: %s\n" % e)
395
- ```
396
-
397
-
398
-
399
- ### Parameters
400
-
401
-
402
- Name | Type | Description | Notes
403
- ------------- | ------------- | ------------- | -------------
404
- **run_rid** | **str**| |
405
- **worker_id** | **str**| |
406
-
407
- ### Return type
408
-
409
- [**GetWorkerStatusResponse**](GetWorkerStatusResponse.md)
410
-
411
- ### Authorization
412
-
413
- No authorization required
414
-
415
- ### HTTP request headers
416
-
417
- - **Content-Type**: Not defined
418
- - **Accept**: application/json
419
-
420
- ### HTTP response details
421
-
422
- | Status code | Description | Response headers |
423
- |-------------|-------------|------------------|
424
- **200** | OK | - |
425
-
426
- [[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)
427
-
@@ -1,181 +0,0 @@
1
- # perceptic_core_client
2
- No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3
-
4
- The `perceptic_core_client` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
5
-
6
- - API version: 0.0.1-SNAPSHOT
7
- - Package version: 1.0.0
8
- - Generator version: 7.13.0
9
- - Build package: org.openapitools.codegen.languages.PythonClientCodegen
10
-
11
- ## Requirements.
12
-
13
- Python 3.9+
14
-
15
- ## Installation & Usage
16
-
17
- This python library package is generated without supporting files like setup.py or requirements files
18
-
19
- To be able to use it, you will need these dependencies in your own package that uses this library:
20
-
21
- * urllib3 >= 2.1.0, < 3.0.0
22
- * python-dateutil >= 2.8.2
23
- * pydantic >= 2
24
- * typing-extensions >= 4.7.1
25
-
26
- ## Getting Started
27
-
28
- In your own code, to use this library to connect and interact with perceptic_core_client,
29
- you can run the following:
30
-
31
- ```python
32
-
33
- import perceptic_core_client
34
- from perceptic_core_client.rest import ApiException
35
- from pprint import pprint
36
-
37
- # Defining the host is optional and defaults to http://localhost
38
- # See configuration.py for a list of all supported configuration parameters.
39
- configuration = perceptic_core_client.Configuration(
40
- host = "http://localhost"
41
- )
42
-
43
-
44
-
45
- # Enter a context with an instance of the API client
46
- with perceptic_core_client.ApiClient(configuration) as api_client:
47
- # Create an instance of the API class
48
- api_instance = perceptic_core_client.ConnectionResourceApi(api_client)
49
- connection_rid = 'connection_rid_example' # str |
50
-
51
- try:
52
- # Get Connection
53
- api_response = api_instance.api_v1_connections_connection_rid_get(connection_rid)
54
- print("The response of ConnectionResourceApi->api_v1_connections_connection_rid_get:\n")
55
- pprint(api_response)
56
- except ApiException as e:
57
- print("Exception when calling ConnectionResourceApi->api_v1_connections_connection_rid_get: %s\n" % e)
58
-
59
- ```
60
-
61
- ## Documentation for API Endpoints
62
-
63
- All URIs are relative to *http://localhost*
64
-
65
- Class | Method | HTTP request | Description
66
- ------------ | ------------- | ------------- | -------------
67
- *ConnectionResourceApi* | [**api_v1_connections_connection_rid_get**](perceptic_core_client/docs/ConnectionResourceApi.md#api_v1_connections_connection_rid_get) | **GET** /api/v1/connections/{connectionRid} | Get Connection
68
- *ConnectionResourceApi* | [**api_v1_connections_post**](perceptic_core_client/docs/ConnectionResourceApi.md#api_v1_connections_post) | **POST** /api/v1/connections | Create Connection
69
- *FileSystemContentsResourceApi* | [**api_v1_file_systems_file_system_rid_contents_download_get**](perceptic_core_client/docs/FileSystemContentsResourceApi.md#api_v1_file_systems_file_system_rid_contents_download_get) | **GET** /api/v1/file-systems/{fileSystemRid}/contents/download | Download
70
- *FileSystemContentsResourceApi* | [**api_v1_file_systems_file_system_rid_contents_files_get**](perceptic_core_client/docs/FileSystemContentsResourceApi.md#api_v1_file_systems_file_system_rid_contents_files_get) | **GET** /api/v1/file-systems/{fileSystemRid}/contents/files | List Files Flattened
71
- *FileSystemContentsResourceApi* | [**api_v1_file_systems_file_system_rid_contents_folders_post**](perceptic_core_client/docs/FileSystemContentsResourceApi.md#api_v1_file_systems_file_system_rid_contents_folders_post) | **POST** /api/v1/file-systems/{fileSystemRid}/contents/folders | Create Folder
72
- *FileSystemContentsResourceApi* | [**api_v1_file_systems_file_system_rid_contents_list_get**](perceptic_core_client/docs/FileSystemContentsResourceApi.md#api_v1_file_systems_file_system_rid_contents_list_get) | **GET** /api/v1/file-systems/{fileSystemRid}/contents/list | List
73
- *FileSystemContentsResourceApi* | [**api_v1_file_systems_file_system_rid_contents_metadata_get**](perceptic_core_client/docs/FileSystemContentsResourceApi.md#api_v1_file_systems_file_system_rid_contents_metadata_get) | **GET** /api/v1/file-systems/{fileSystemRid}/contents/metadata | Get Metadata
74
- *FileSystemContentsResourceApi* | [**api_v1_file_systems_file_system_rid_contents_parent_get**](perceptic_core_client/docs/FileSystemContentsResourceApi.md#api_v1_file_systems_file_system_rid_contents_parent_get) | **GET** /api/v1/file-systems/{fileSystemRid}/contents/parent | Get Parent
75
- *FileSystemContentsResourceApi* | [**api_v1_file_systems_file_system_rid_contents_signed_url_get**](perceptic_core_client/docs/FileSystemContentsResourceApi.md#api_v1_file_systems_file_system_rid_contents_signed_url_get) | **GET** /api/v1/file-systems/{fileSystemRid}/contents/signed-url | Signed Url
76
- *FileSystemContentsResourceApi* | [**api_v1_file_systems_file_system_rid_contents_upload_post**](perceptic_core_client/docs/FileSystemContentsResourceApi.md#api_v1_file_systems_file_system_rid_contents_upload_post) | **POST** /api/v1/file-systems/{fileSystemRid}/contents/upload | Upload File
77
- *FileSystemResourceApi* | [**api_v1_file_systems_file_system_rid_get**](perceptic_core_client/docs/FileSystemResourceApi.md#api_v1_file_systems_file_system_rid_get) | **GET** /api/v1/file-systems/{fileSystemRid} | Get File System
78
- *FileSystemResourceApi* | [**api_v1_file_systems_get**](perceptic_core_client/docs/FileSystemResourceApi.md#api_v1_file_systems_get) | **GET** /api/v1/file-systems | List All File Systems
79
- *FileSystemResourceApi* | [**api_v1_file_systems_managed_post**](perceptic_core_client/docs/FileSystemResourceApi.md#api_v1_file_systems_managed_post) | **POST** /api/v1/file-systems/managed | Create Managed File System
80
- *FileSystemResourceApi* | [**api_v1_file_systems_remote_post**](perceptic_core_client/docs/FileSystemResourceApi.md#api_v1_file_systems_remote_post) | **POST** /api/v1/file-systems/remote | Create Remote File System
81
- *IndexerResourceApi* | [**api_v1_indexing_indexers_get**](perceptic_core_client/docs/IndexerResourceApi.md#api_v1_indexing_indexers_get) | **GET** /api/v1/indexing/indexers | List Indexers
82
- *IndexerResourceApi* | [**api_v1_indexing_indexers_indexer_rid_get**](perceptic_core_client/docs/IndexerResourceApi.md#api_v1_indexing_indexers_indexer_rid_get) | **GET** /api/v1/indexing/indexers/{indexerRid} | Get Indexer
83
- *IndexingTaskResourceApi* | [**api_v1_indexing_tasks_post**](perceptic_core_client/docs/IndexingTaskResourceApi.md#api_v1_indexing_tasks_post) | **POST** /api/v1/indexing/tasks | Create Indexing Task
84
- *IndexingTaskResourceApi* | [**api_v1_indexing_tasks_task_rid_actions_get**](perceptic_core_client/docs/IndexingTaskResourceApi.md#api_v1_indexing_tasks_task_rid_actions_get) | **GET** /api/v1/indexing/tasks/{taskRid}/actions | List Indexing Actions
85
- *IndexingTaskResourceApi* | [**api_v1_indexing_tasks_task_rid_execute_post**](perceptic_core_client/docs/IndexingTaskResourceApi.md#api_v1_indexing_tasks_task_rid_execute_post) | **POST** /api/v1/indexing/tasks/{taskRid}/execute | Start Execution
86
- *IndexingTaskResourceApi* | [**api_v1_indexing_tasks_task_rid_get**](perceptic_core_client/docs/IndexingTaskResourceApi.md#api_v1_indexing_tasks_task_rid_get) | **GET** /api/v1/indexing/tasks/{taskRid} | Get Indexing Task
87
- *UriResourceApi* | [**api_v1_resources_download_get**](perceptic_core_client/docs/UriResourceApi.md#api_v1_resources_download_get) | **GET** /api/v1/resources/download | Download Resource
88
- *UriResourceApi* | [**api_v1_resources_files_get**](perceptic_core_client/docs/UriResourceApi.md#api_v1_resources_files_get) | **GET** /api/v1/resources/files | List Files
89
- *UriResourceApi* | [**api_v1_resources_list_get**](perceptic_core_client/docs/UriResourceApi.md#api_v1_resources_list_get) | **GET** /api/v1/resources/list | List Resources
90
- *UriResourceApi* | [**api_v1_resources_metadata_get**](perceptic_core_client/docs/UriResourceApi.md#api_v1_resources_metadata_get) | **GET** /api/v1/resources/metadata | Get Metadata
91
- *UriResourceApi* | [**api_v1_resources_parent_get**](perceptic_core_client/docs/UriResourceApi.md#api_v1_resources_parent_get) | **GET** /api/v1/resources/parent | Get Parent
92
- *UriResourceApi* | [**api_v1_resources_signed_url_get**](perceptic_core_client/docs/UriResourceApi.md#api_v1_resources_signed_url_get) | **GET** /api/v1/resources/signed-url | Get Signed Url
93
- *UserResourceApi* | [**api_v1_users_me_get**](perceptic_core_client/docs/UserResourceApi.md#api_v1_users_me_get) | **GET** /api/v1/users/me | Me
94
- *WorkerResourceApi* | [**api_v1_workers_get**](perceptic_core_client/docs/WorkerResourceApi.md#api_v1_workers_get) | **GET** /api/v1/workers | Get Workers
95
- *WorkerResourceApi* | [**api_v1_workers_worker_id_get**](perceptic_core_client/docs/WorkerResourceApi.md#api_v1_workers_worker_id_get) | **GET** /api/v1/workers/{workerId} | Get Worker Metadata
96
- *WorkerResourceApi* | [**api_v1_workers_worker_id_runs_post**](perceptic_core_client/docs/WorkerResourceApi.md#api_v1_workers_worker_id_runs_post) | **POST** /api/v1/workers/{workerId}/runs | Post Worker Run
97
- *WorkerResourceApi* | [**api_v1_workers_worker_id_runs_run_rid_events_get**](perceptic_core_client/docs/WorkerResourceApi.md#api_v1_workers_worker_id_runs_run_rid_events_get) | **GET** /api/v1/workers/{workerId}/runs/{runRid}/events | Get Worker Run Events
98
- *WorkerResourceApi* | [**api_v1_workers_worker_id_runs_run_rid_resume_post**](perceptic_core_client/docs/WorkerResourceApi.md#api_v1_workers_worker_id_runs_run_rid_resume_post) | **POST** /api/v1/workers/{workerId}/runs/{runRid}/resume | Post Resume Run
99
- *WorkerResourceApi* | [**api_v1_workers_worker_id_runs_run_rid_status_get**](perceptic_core_client/docs/WorkerResourceApi.md#api_v1_workers_worker_id_runs_run_rid_status_get) | **GET** /api/v1/workers/{workerId}/runs/{runRid}/status | Get Worker Run Status
100
-
101
-
102
- ## Documentation For Models
103
-
104
- - [ActionType](perceptic_core_client/docs/ActionType.md)
105
- - [AzureBlobConnectionSettingsApiDto](perceptic_core_client/docs/AzureBlobConnectionSettingsApiDto.md)
106
- - [AzureBlobFileSystemRootMetadataApiDto](perceptic_core_client/docs/AzureBlobFileSystemRootMetadataApiDto.md)
107
- - [ConnectionApiDto](perceptic_core_client/docs/ConnectionApiDto.md)
108
- - [ConnectionSettingsApiDto](perceptic_core_client/docs/ConnectionSettingsApiDto.md)
109
- - [CreateConnectionRequest](perceptic_core_client/docs/CreateConnectionRequest.md)
110
- - [CreateConnectionResponse](perceptic_core_client/docs/CreateConnectionResponse.md)
111
- - [CreateFileSystemResponse](perceptic_core_client/docs/CreateFileSystemResponse.md)
112
- - [CreateFolderRequest](perceptic_core_client/docs/CreateFolderRequest.md)
113
- - [CreateFolderResponse](perceptic_core_client/docs/CreateFolderResponse.md)
114
- - [CreateIndexingTaskRequest](perceptic_core_client/docs/CreateIndexingTaskRequest.md)
115
- - [CreateIndexingTaskResponse](perceptic_core_client/docs/CreateIndexingTaskResponse.md)
116
- - [CreateManagedFileSystemRequest](perceptic_core_client/docs/CreateManagedFileSystemRequest.md)
117
- - [CreateRemoteFileSystemRequest](perceptic_core_client/docs/CreateRemoteFileSystemRequest.md)
118
- - [FileSystemApiDto](perceptic_core_client/docs/FileSystemApiDto.md)
119
- - [FileSystemRootMetadataApiDto](perceptic_core_client/docs/FileSystemRootMetadataApiDto.md)
120
- - [GetConnectionResponse](perceptic_core_client/docs/GetConnectionResponse.md)
121
- - [GetIndexerResponse](perceptic_core_client/docs/GetIndexerResponse.md)
122
- - [GetIndexingTaskResponse](perceptic_core_client/docs/GetIndexingTaskResponse.md)
123
- - [GetMetadataResponse](perceptic_core_client/docs/GetMetadataResponse.md)
124
- - [GetParentResponse](perceptic_core_client/docs/GetParentResponse.md)
125
- - [GetParentUriResponse](perceptic_core_client/docs/GetParentUriResponse.md)
126
- - [GetSignedUrlResponse](perceptic_core_client/docs/GetSignedUrlResponse.md)
127
- - [GetWorkerEventsResponse](perceptic_core_client/docs/GetWorkerEventsResponse.md)
128
- - [GetWorkerMetadataResponse](perceptic_core_client/docs/GetWorkerMetadataResponse.md)
129
- - [GetWorkerStatusResponse](perceptic_core_client/docs/GetWorkerStatusResponse.md)
130
- - [GetWorkersResponse](perceptic_core_client/docs/GetWorkersResponse.md)
131
- - [IndexerDto](perceptic_core_client/docs/IndexerDto.md)
132
- - [IndexingActionDto](perceptic_core_client/docs/IndexingActionDto.md)
133
- - [IndexingActionStatus](perceptic_core_client/docs/IndexingActionStatus.md)
134
- - [IndexingTaskDto](perceptic_core_client/docs/IndexingTaskDto.md)
135
- - [IndexingTaskStatus](perceptic_core_client/docs/IndexingTaskStatus.md)
136
- - [InfoEvent](perceptic_core_client/docs/InfoEvent.md)
137
- - [JsonNode](perceptic_core_client/docs/JsonNode.md)
138
- - [JsonNodeType](perceptic_core_client/docs/JsonNodeType.md)
139
- - [ListAllFileSystemsResponse](perceptic_core_client/docs/ListAllFileSystemsResponse.md)
140
- - [ListFileSystemResponse](perceptic_core_client/docs/ListFileSystemResponse.md)
141
- - [ListIndexersResponse](perceptic_core_client/docs/ListIndexersResponse.md)
142
- - [ListIndexingActionsResponse](perceptic_core_client/docs/ListIndexingActionsResponse.md)
143
- - [ManagedFileSystemApiDto](perceptic_core_client/docs/ManagedFileSystemApiDto.md)
144
- - [MeResponse](perceptic_core_client/docs/MeResponse.md)
145
- - [ModelSchema](perceptic_core_client/docs/ModelSchema.md)
146
- - [PagedListFileSystemResponse](perceptic_core_client/docs/PagedListFileSystemResponse.md)
147
- - [PostWorkerRunRequest](perceptic_core_client/docs/PostWorkerRunRequest.md)
148
- - [PostWorkerRunResponse](perceptic_core_client/docs/PostWorkerRunResponse.md)
149
- - [ProgressEvent](perceptic_core_client/docs/ProgressEvent.md)
150
- - [RemoteFileSystemApiDto](perceptic_core_client/docs/RemoteFileSystemApiDto.md)
151
- - [RequestForInputEvent](perceptic_core_client/docs/RequestForInputEvent.md)
152
- - [ResourceEntryDto](perceptic_core_client/docs/ResourceEntryDto.md)
153
- - [ResourceId](perceptic_core_client/docs/ResourceId.md)
154
- - [ResourceIdentifier](perceptic_core_client/docs/ResourceIdentifier.md)
155
- - [ResourceMetadataDto](perceptic_core_client/docs/ResourceMetadataDto.md)
156
- - [ResourceTypeDto](perceptic_core_client/docs/ResourceTypeDto.md)
157
- - [RunStatusDto](perceptic_core_client/docs/RunStatusDto.md)
158
- - [S3ConnectionSettingsApiDto](perceptic_core_client/docs/S3ConnectionSettingsApiDto.md)
159
- - [S3FileSystemRootMetadataApiDto](perceptic_core_client/docs/S3FileSystemRootMetadataApiDto.md)
160
- - [SchemaLocation](perceptic_core_client/docs/SchemaLocation.md)
161
- - [StartExecutionResponse](perceptic_core_client/docs/StartExecutionResponse.md)
162
- - [UploadFileToManagedFileSystemResponse](perceptic_core_client/docs/UploadFileToManagedFileSystemResponse.md)
163
- - [WorkerEvent](perceptic_core_client/docs/WorkerEvent.md)
164
- - [WorkerMetadataDto](perceptic_core_client/docs/WorkerMetadataDto.md)
165
-
166
-
167
- <a id="documentation-for-authorization"></a>
168
- ## Documentation For Authorization
169
-
170
-
171
- Authentication schemes defined for the API:
172
- <a id="SecurityScheme"></a>
173
- ### SecurityScheme
174
-
175
-
176
-
177
- ## Author
178
-
179
-
180
-
181
-