perceptic-core-client 0.13.0__py3-none-any.whl → 0.14.0__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 (37) hide show
  1. perceptic_core_client/__init__.py +15 -0
  2. perceptic_core_client/api/__init__.py +1 -0
  3. perceptic_core_client/api/indexing_schedule_resource_api.py +2243 -0
  4. perceptic_core_client/models/__init__.py +14 -0
  5. perceptic_core_client/models/create_indexing_schedule_request.py +122 -0
  6. perceptic_core_client/models/create_indexing_schedule_response.py +93 -0
  7. perceptic_core_client/models/cron_trigger.py +106 -0
  8. perceptic_core_client/models/execution_trigger_reason.py +37 -0
  9. perceptic_core_client/models/get_indexing_schedule_response.py +91 -0
  10. perceptic_core_client/models/indexing_schedule_dto.py +118 -0
  11. perceptic_core_client/models/interval_trigger.py +92 -0
  12. perceptic_core_client/models/list_indexing_schedules_response.py +104 -0
  13. perceptic_core_client/models/list_schedule_executions_response.py +104 -0
  14. perceptic_core_client/models/on_upload_trigger.py +87 -0
  15. perceptic_core_client/models/schedule_execution_dto.py +104 -0
  16. perceptic_core_client/models/schedule_trigger.py +189 -0
  17. perceptic_core_client/models/update_indexing_schedule_request.py +127 -0
  18. perceptic_core_client/models/update_indexing_schedule_response.py +91 -0
  19. perceptic_core_client/test/test_create_indexing_schedule_request.py +66 -0
  20. perceptic_core_client/test/test_create_indexing_schedule_response.py +68 -0
  21. perceptic_core_client/test/test_cron_trigger.py +55 -0
  22. perceptic_core_client/test/test_execution_trigger_reason.py +33 -0
  23. perceptic_core_client/test/test_get_indexing_schedule_response.py +67 -0
  24. perceptic_core_client/test/test_indexing_schedule_dto.py +66 -0
  25. perceptic_core_client/test/test_indexing_schedule_resource_api.py +87 -0
  26. perceptic_core_client/test/test_interval_trigger.py +54 -0
  27. perceptic_core_client/test/test_list_indexing_schedules_response.py +71 -0
  28. perceptic_core_client/test/test_list_schedule_executions_response.py +61 -0
  29. perceptic_core_client/test/test_on_upload_trigger.py +51 -0
  30. perceptic_core_client/test/test_schedule_execution_dto.py +56 -0
  31. perceptic_core_client/test/test_schedule_trigger.py +58 -0
  32. perceptic_core_client/test/test_update_indexing_schedule_request.py +58 -0
  33. perceptic_core_client/test/test_update_indexing_schedule_response.py +67 -0
  34. {perceptic_core_client-0.13.0.dist-info → perceptic_core_client-0.14.0.dist-info}/METADATA +1 -1
  35. {perceptic_core_client-0.13.0.dist-info → perceptic_core_client-0.14.0.dist-info}/RECORD +37 -7
  36. {perceptic_core_client-0.13.0.dist-info → perceptic_core_client-0.14.0.dist-info}/WHEEL +0 -0
  37. {perceptic_core_client-0.13.0.dist-info → perceptic_core_client-0.14.0.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,2243 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ perceptic-core-server API
5
+
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+
8
+ The version of the OpenAPI document: 0.0.1-SNAPSHOT
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import StrictBool, StrictInt, StrictStr
20
+ from typing import Optional
21
+ from perceptic_core_client.models.create_indexing_schedule_request import CreateIndexingScheduleRequest
22
+ from perceptic_core_client.models.create_indexing_schedule_response import CreateIndexingScheduleResponse
23
+ from perceptic_core_client.models.get_indexing_schedule_response import GetIndexingScheduleResponse
24
+ from perceptic_core_client.models.list_indexing_schedules_response import ListIndexingSchedulesResponse
25
+ from perceptic_core_client.models.list_schedule_executions_response import ListScheduleExecutionsResponse
26
+ from perceptic_core_client.models.update_indexing_schedule_request import UpdateIndexingScheduleRequest
27
+ from perceptic_core_client.models.update_indexing_schedule_response import UpdateIndexingScheduleResponse
28
+
29
+ from perceptic_core_client.api_client import ApiClient, RequestSerialized
30
+ from perceptic_core_client.api_response import ApiResponse
31
+ from perceptic_core_client.rest import RESTResponseType
32
+
33
+
34
+ class IndexingScheduleResourceApi:
35
+ """NOTE: This class is auto generated by OpenAPI Generator
36
+ Ref: https://openapi-generator.tech
37
+
38
+ Do not edit the class manually.
39
+ """
40
+
41
+ def __init__(self, api_client=None) -> None:
42
+ if api_client is None:
43
+ api_client = ApiClient.get_default()
44
+ self.api_client = api_client
45
+
46
+
47
+ @validate_call
48
+ def create_indexing_schedule(
49
+ self,
50
+ create_indexing_schedule_request: CreateIndexingScheduleRequest,
51
+ _request_timeout: Union[
52
+ None,
53
+ Annotated[StrictFloat, Field(gt=0)],
54
+ Tuple[
55
+ Annotated[StrictFloat, Field(gt=0)],
56
+ Annotated[StrictFloat, Field(gt=0)]
57
+ ]
58
+ ] = None,
59
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
60
+ _content_type: Optional[StrictStr] = None,
61
+ _headers: Optional[Dict[StrictStr, Any]] = None,
62
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
63
+ ) -> CreateIndexingScheduleResponse:
64
+ """Create an indexing schedule
65
+
66
+ Creates a new schedule for automatic indexing. Only one schedule is allowed per filesystem hierarchy.
67
+
68
+ :param create_indexing_schedule_request: (required)
69
+ :type create_indexing_schedule_request: CreateIndexingScheduleRequest
70
+ :param _request_timeout: timeout setting for this request. If one
71
+ number provided, it will be total request
72
+ timeout. It can also be a pair (tuple) of
73
+ (connection, read) timeouts.
74
+ :type _request_timeout: int, tuple(int, int), optional
75
+ :param _request_auth: set to override the auth_settings for an a single
76
+ request; this effectively ignores the
77
+ authentication in the spec for a single request.
78
+ :type _request_auth: dict, optional
79
+ :param _content_type: force content-type for the request.
80
+ :type _content_type: str, Optional
81
+ :param _headers: set to override the headers for a single
82
+ request; this effectively ignores the headers
83
+ in the spec for a single request.
84
+ :type _headers: dict, optional
85
+ :param _host_index: set to override the host_index for a single
86
+ request; this effectively ignores the host_index
87
+ in the spec for a single request.
88
+ :type _host_index: int, optional
89
+ :return: Returns the result object.
90
+ """ # noqa: E501
91
+
92
+ _param = self._create_indexing_schedule_serialize(
93
+ create_indexing_schedule_request=create_indexing_schedule_request,
94
+ _request_auth=_request_auth,
95
+ _content_type=_content_type,
96
+ _headers=_headers,
97
+ _host_index=_host_index
98
+ )
99
+
100
+ _response_types_map: Dict[str, Optional[str]] = {
101
+ '201': "CreateIndexingScheduleResponse",
102
+ '400': None,
103
+ '409': None,
104
+ }
105
+ response_data = self.api_client.call_api(
106
+ *_param,
107
+ _request_timeout=_request_timeout
108
+ )
109
+ response_data.read()
110
+ return self.api_client.response_deserialize(
111
+ response_data=response_data,
112
+ response_types_map=_response_types_map,
113
+ ).data
114
+
115
+
116
+ @validate_call
117
+ def create_indexing_schedule_with_http_info(
118
+ self,
119
+ create_indexing_schedule_request: CreateIndexingScheduleRequest,
120
+ _request_timeout: Union[
121
+ None,
122
+ Annotated[StrictFloat, Field(gt=0)],
123
+ Tuple[
124
+ Annotated[StrictFloat, Field(gt=0)],
125
+ Annotated[StrictFloat, Field(gt=0)]
126
+ ]
127
+ ] = None,
128
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
129
+ _content_type: Optional[StrictStr] = None,
130
+ _headers: Optional[Dict[StrictStr, Any]] = None,
131
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
132
+ ) -> ApiResponse[CreateIndexingScheduleResponse]:
133
+ """Create an indexing schedule
134
+
135
+ Creates a new schedule for automatic indexing. Only one schedule is allowed per filesystem hierarchy.
136
+
137
+ :param create_indexing_schedule_request: (required)
138
+ :type create_indexing_schedule_request: CreateIndexingScheduleRequest
139
+ :param _request_timeout: timeout setting for this request. If one
140
+ number provided, it will be total request
141
+ timeout. It can also be a pair (tuple) of
142
+ (connection, read) timeouts.
143
+ :type _request_timeout: int, tuple(int, int), optional
144
+ :param _request_auth: set to override the auth_settings for an a single
145
+ request; this effectively ignores the
146
+ authentication in the spec for a single request.
147
+ :type _request_auth: dict, optional
148
+ :param _content_type: force content-type for the request.
149
+ :type _content_type: str, Optional
150
+ :param _headers: set to override the headers for a single
151
+ request; this effectively ignores the headers
152
+ in the spec for a single request.
153
+ :type _headers: dict, optional
154
+ :param _host_index: set to override the host_index for a single
155
+ request; this effectively ignores the host_index
156
+ in the spec for a single request.
157
+ :type _host_index: int, optional
158
+ :return: Returns the result object.
159
+ """ # noqa: E501
160
+
161
+ _param = self._create_indexing_schedule_serialize(
162
+ create_indexing_schedule_request=create_indexing_schedule_request,
163
+ _request_auth=_request_auth,
164
+ _content_type=_content_type,
165
+ _headers=_headers,
166
+ _host_index=_host_index
167
+ )
168
+
169
+ _response_types_map: Dict[str, Optional[str]] = {
170
+ '201': "CreateIndexingScheduleResponse",
171
+ '400': None,
172
+ '409': None,
173
+ }
174
+ response_data = self.api_client.call_api(
175
+ *_param,
176
+ _request_timeout=_request_timeout
177
+ )
178
+ response_data.read()
179
+ return self.api_client.response_deserialize(
180
+ response_data=response_data,
181
+ response_types_map=_response_types_map,
182
+ )
183
+
184
+
185
+ @validate_call
186
+ def create_indexing_schedule_without_preload_content(
187
+ self,
188
+ create_indexing_schedule_request: CreateIndexingScheduleRequest,
189
+ _request_timeout: Union[
190
+ None,
191
+ Annotated[StrictFloat, Field(gt=0)],
192
+ Tuple[
193
+ Annotated[StrictFloat, Field(gt=0)],
194
+ Annotated[StrictFloat, Field(gt=0)]
195
+ ]
196
+ ] = None,
197
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
198
+ _content_type: Optional[StrictStr] = None,
199
+ _headers: Optional[Dict[StrictStr, Any]] = None,
200
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
201
+ ) -> RESTResponseType:
202
+ """Create an indexing schedule
203
+
204
+ Creates a new schedule for automatic indexing. Only one schedule is allowed per filesystem hierarchy.
205
+
206
+ :param create_indexing_schedule_request: (required)
207
+ :type create_indexing_schedule_request: CreateIndexingScheduleRequest
208
+ :param _request_timeout: timeout setting for this request. If one
209
+ number provided, it will be total request
210
+ timeout. It can also be a pair (tuple) of
211
+ (connection, read) timeouts.
212
+ :type _request_timeout: int, tuple(int, int), optional
213
+ :param _request_auth: set to override the auth_settings for an a single
214
+ request; this effectively ignores the
215
+ authentication in the spec for a single request.
216
+ :type _request_auth: dict, optional
217
+ :param _content_type: force content-type for the request.
218
+ :type _content_type: str, Optional
219
+ :param _headers: set to override the headers for a single
220
+ request; this effectively ignores the headers
221
+ in the spec for a single request.
222
+ :type _headers: dict, optional
223
+ :param _host_index: set to override the host_index for a single
224
+ request; this effectively ignores the host_index
225
+ in the spec for a single request.
226
+ :type _host_index: int, optional
227
+ :return: Returns the result object.
228
+ """ # noqa: E501
229
+
230
+ _param = self._create_indexing_schedule_serialize(
231
+ create_indexing_schedule_request=create_indexing_schedule_request,
232
+ _request_auth=_request_auth,
233
+ _content_type=_content_type,
234
+ _headers=_headers,
235
+ _host_index=_host_index
236
+ )
237
+
238
+ _response_types_map: Dict[str, Optional[str]] = {
239
+ '201': "CreateIndexingScheduleResponse",
240
+ '400': None,
241
+ '409': None,
242
+ }
243
+ response_data = self.api_client.call_api(
244
+ *_param,
245
+ _request_timeout=_request_timeout
246
+ )
247
+ return response_data.response
248
+
249
+
250
+ def _create_indexing_schedule_serialize(
251
+ self,
252
+ create_indexing_schedule_request,
253
+ _request_auth,
254
+ _content_type,
255
+ _headers,
256
+ _host_index,
257
+ ) -> RequestSerialized:
258
+
259
+ _host = None
260
+
261
+ _collection_formats: Dict[str, str] = {
262
+ }
263
+
264
+ _path_params: Dict[str, str] = {}
265
+ _query_params: List[Tuple[str, str]] = []
266
+ _header_params: Dict[str, Optional[str]] = _headers or {}
267
+ _form_params: List[Tuple[str, str]] = []
268
+ _files: Dict[
269
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
270
+ ] = {}
271
+ _body_params: Optional[bytes] = None
272
+
273
+ # process the path parameters
274
+ # process the query parameters
275
+ # process the header parameters
276
+ # process the form parameters
277
+ # process the body parameter
278
+ if create_indexing_schedule_request is not None:
279
+ _body_params = create_indexing_schedule_request
280
+
281
+
282
+ # set the HTTP header `Accept`
283
+ if 'Accept' not in _header_params:
284
+ _header_params['Accept'] = self.api_client.select_header_accept(
285
+ [
286
+ 'application/json'
287
+ ]
288
+ )
289
+
290
+ # set the HTTP header `Content-Type`
291
+ if _content_type:
292
+ _header_params['Content-Type'] = _content_type
293
+ else:
294
+ _default_content_type = (
295
+ self.api_client.select_header_content_type(
296
+ [
297
+ 'application/json'
298
+ ]
299
+ )
300
+ )
301
+ if _default_content_type is not None:
302
+ _header_params['Content-Type'] = _default_content_type
303
+
304
+ # authentication setting
305
+ _auth_settings: List[str] = [
306
+ ]
307
+
308
+ return self.api_client.param_serialize(
309
+ method='POST',
310
+ resource_path='/api/v1/indexing/schedules',
311
+ path_params=_path_params,
312
+ query_params=_query_params,
313
+ header_params=_header_params,
314
+ body=_body_params,
315
+ post_params=_form_params,
316
+ files=_files,
317
+ auth_settings=_auth_settings,
318
+ collection_formats=_collection_formats,
319
+ _host=_host,
320
+ _request_auth=_request_auth
321
+ )
322
+
323
+
324
+
325
+
326
+ @validate_call
327
+ def delete_indexing_schedule(
328
+ self,
329
+ schedule_rid: StrictStr,
330
+ _request_timeout: Union[
331
+ None,
332
+ Annotated[StrictFloat, Field(gt=0)],
333
+ Tuple[
334
+ Annotated[StrictFloat, Field(gt=0)],
335
+ Annotated[StrictFloat, Field(gt=0)]
336
+ ]
337
+ ] = None,
338
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
339
+ _content_type: Optional[StrictStr] = None,
340
+ _headers: Optional[Dict[StrictStr, Any]] = None,
341
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
342
+ ) -> None:
343
+ """Delete an indexing schedule
344
+
345
+
346
+ :param schedule_rid: (required)
347
+ :type schedule_rid: str
348
+ :param _request_timeout: timeout setting for this request. If one
349
+ number provided, it will be total request
350
+ timeout. It can also be a pair (tuple) of
351
+ (connection, read) timeouts.
352
+ :type _request_timeout: int, tuple(int, int), optional
353
+ :param _request_auth: set to override the auth_settings for an a single
354
+ request; this effectively ignores the
355
+ authentication in the spec for a single request.
356
+ :type _request_auth: dict, optional
357
+ :param _content_type: force content-type for the request.
358
+ :type _content_type: str, Optional
359
+ :param _headers: set to override the headers for a single
360
+ request; this effectively ignores the headers
361
+ in the spec for a single request.
362
+ :type _headers: dict, optional
363
+ :param _host_index: set to override the host_index for a single
364
+ request; this effectively ignores the host_index
365
+ in the spec for a single request.
366
+ :type _host_index: int, optional
367
+ :return: Returns the result object.
368
+ """ # noqa: E501
369
+
370
+ _param = self._delete_indexing_schedule_serialize(
371
+ schedule_rid=schedule_rid,
372
+ _request_auth=_request_auth,
373
+ _content_type=_content_type,
374
+ _headers=_headers,
375
+ _host_index=_host_index
376
+ )
377
+
378
+ _response_types_map: Dict[str, Optional[str]] = {
379
+ '200': None,
380
+ '404': None,
381
+ }
382
+ response_data = self.api_client.call_api(
383
+ *_param,
384
+ _request_timeout=_request_timeout
385
+ )
386
+ response_data.read()
387
+ return self.api_client.response_deserialize(
388
+ response_data=response_data,
389
+ response_types_map=_response_types_map,
390
+ ).data
391
+
392
+
393
+ @validate_call
394
+ def delete_indexing_schedule_with_http_info(
395
+ self,
396
+ schedule_rid: StrictStr,
397
+ _request_timeout: Union[
398
+ None,
399
+ Annotated[StrictFloat, Field(gt=0)],
400
+ Tuple[
401
+ Annotated[StrictFloat, Field(gt=0)],
402
+ Annotated[StrictFloat, Field(gt=0)]
403
+ ]
404
+ ] = None,
405
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
406
+ _content_type: Optional[StrictStr] = None,
407
+ _headers: Optional[Dict[StrictStr, Any]] = None,
408
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
409
+ ) -> ApiResponse[None]:
410
+ """Delete an indexing schedule
411
+
412
+
413
+ :param schedule_rid: (required)
414
+ :type schedule_rid: str
415
+ :param _request_timeout: timeout setting for this request. If one
416
+ number provided, it will be total request
417
+ timeout. It can also be a pair (tuple) of
418
+ (connection, read) timeouts.
419
+ :type _request_timeout: int, tuple(int, int), optional
420
+ :param _request_auth: set to override the auth_settings for an a single
421
+ request; this effectively ignores the
422
+ authentication in the spec for a single request.
423
+ :type _request_auth: dict, optional
424
+ :param _content_type: force content-type for the request.
425
+ :type _content_type: str, Optional
426
+ :param _headers: set to override the headers for a single
427
+ request; this effectively ignores the headers
428
+ in the spec for a single request.
429
+ :type _headers: dict, optional
430
+ :param _host_index: set to override the host_index for a single
431
+ request; this effectively ignores the host_index
432
+ in the spec for a single request.
433
+ :type _host_index: int, optional
434
+ :return: Returns the result object.
435
+ """ # noqa: E501
436
+
437
+ _param = self._delete_indexing_schedule_serialize(
438
+ schedule_rid=schedule_rid,
439
+ _request_auth=_request_auth,
440
+ _content_type=_content_type,
441
+ _headers=_headers,
442
+ _host_index=_host_index
443
+ )
444
+
445
+ _response_types_map: Dict[str, Optional[str]] = {
446
+ '200': None,
447
+ '404': None,
448
+ }
449
+ response_data = self.api_client.call_api(
450
+ *_param,
451
+ _request_timeout=_request_timeout
452
+ )
453
+ response_data.read()
454
+ return self.api_client.response_deserialize(
455
+ response_data=response_data,
456
+ response_types_map=_response_types_map,
457
+ )
458
+
459
+
460
+ @validate_call
461
+ def delete_indexing_schedule_without_preload_content(
462
+ self,
463
+ schedule_rid: StrictStr,
464
+ _request_timeout: Union[
465
+ None,
466
+ Annotated[StrictFloat, Field(gt=0)],
467
+ Tuple[
468
+ Annotated[StrictFloat, Field(gt=0)],
469
+ Annotated[StrictFloat, Field(gt=0)]
470
+ ]
471
+ ] = None,
472
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
473
+ _content_type: Optional[StrictStr] = None,
474
+ _headers: Optional[Dict[StrictStr, Any]] = None,
475
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
476
+ ) -> RESTResponseType:
477
+ """Delete an indexing schedule
478
+
479
+
480
+ :param schedule_rid: (required)
481
+ :type schedule_rid: str
482
+ :param _request_timeout: timeout setting for this request. If one
483
+ number provided, it will be total request
484
+ timeout. It can also be a pair (tuple) of
485
+ (connection, read) timeouts.
486
+ :type _request_timeout: int, tuple(int, int), optional
487
+ :param _request_auth: set to override the auth_settings for an a single
488
+ request; this effectively ignores the
489
+ authentication in the spec for a single request.
490
+ :type _request_auth: dict, optional
491
+ :param _content_type: force content-type for the request.
492
+ :type _content_type: str, Optional
493
+ :param _headers: set to override the headers for a single
494
+ request; this effectively ignores the headers
495
+ in the spec for a single request.
496
+ :type _headers: dict, optional
497
+ :param _host_index: set to override the host_index for a single
498
+ request; this effectively ignores the host_index
499
+ in the spec for a single request.
500
+ :type _host_index: int, optional
501
+ :return: Returns the result object.
502
+ """ # noqa: E501
503
+
504
+ _param = self._delete_indexing_schedule_serialize(
505
+ schedule_rid=schedule_rid,
506
+ _request_auth=_request_auth,
507
+ _content_type=_content_type,
508
+ _headers=_headers,
509
+ _host_index=_host_index
510
+ )
511
+
512
+ _response_types_map: Dict[str, Optional[str]] = {
513
+ '200': None,
514
+ '404': None,
515
+ }
516
+ response_data = self.api_client.call_api(
517
+ *_param,
518
+ _request_timeout=_request_timeout
519
+ )
520
+ return response_data.response
521
+
522
+
523
+ def _delete_indexing_schedule_serialize(
524
+ self,
525
+ schedule_rid,
526
+ _request_auth,
527
+ _content_type,
528
+ _headers,
529
+ _host_index,
530
+ ) -> RequestSerialized:
531
+
532
+ _host = None
533
+
534
+ _collection_formats: Dict[str, str] = {
535
+ }
536
+
537
+ _path_params: Dict[str, str] = {}
538
+ _query_params: List[Tuple[str, str]] = []
539
+ _header_params: Dict[str, Optional[str]] = _headers or {}
540
+ _form_params: List[Tuple[str, str]] = []
541
+ _files: Dict[
542
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
543
+ ] = {}
544
+ _body_params: Optional[bytes] = None
545
+
546
+ # process the path parameters
547
+ if schedule_rid is not None:
548
+ _path_params['scheduleRid'] = schedule_rid
549
+ # process the query parameters
550
+ # process the header parameters
551
+ # process the form parameters
552
+ # process the body parameter
553
+
554
+
555
+
556
+
557
+ # authentication setting
558
+ _auth_settings: List[str] = [
559
+ ]
560
+
561
+ return self.api_client.param_serialize(
562
+ method='DELETE',
563
+ resource_path='/api/v1/indexing/schedules/{scheduleRid}',
564
+ path_params=_path_params,
565
+ query_params=_query_params,
566
+ header_params=_header_params,
567
+ body=_body_params,
568
+ post_params=_form_params,
569
+ files=_files,
570
+ auth_settings=_auth_settings,
571
+ collection_formats=_collection_formats,
572
+ _host=_host,
573
+ _request_auth=_request_auth
574
+ )
575
+
576
+
577
+
578
+
579
+ @validate_call
580
+ def disable_indexing_schedule(
581
+ self,
582
+ schedule_rid: StrictStr,
583
+ _request_timeout: Union[
584
+ None,
585
+ Annotated[StrictFloat, Field(gt=0)],
586
+ Tuple[
587
+ Annotated[StrictFloat, Field(gt=0)],
588
+ Annotated[StrictFloat, Field(gt=0)]
589
+ ]
590
+ ] = None,
591
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
592
+ _content_type: Optional[StrictStr] = None,
593
+ _headers: Optional[Dict[StrictStr, Any]] = None,
594
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
595
+ ) -> None:
596
+ """Disable an indexing schedule
597
+
598
+
599
+ :param schedule_rid: (required)
600
+ :type schedule_rid: str
601
+ :param _request_timeout: timeout setting for this request. If one
602
+ number provided, it will be total request
603
+ timeout. It can also be a pair (tuple) of
604
+ (connection, read) timeouts.
605
+ :type _request_timeout: int, tuple(int, int), optional
606
+ :param _request_auth: set to override the auth_settings for an a single
607
+ request; this effectively ignores the
608
+ authentication in the spec for a single request.
609
+ :type _request_auth: dict, optional
610
+ :param _content_type: force content-type for the request.
611
+ :type _content_type: str, Optional
612
+ :param _headers: set to override the headers for a single
613
+ request; this effectively ignores the headers
614
+ in the spec for a single request.
615
+ :type _headers: dict, optional
616
+ :param _host_index: set to override the host_index for a single
617
+ request; this effectively ignores the host_index
618
+ in the spec for a single request.
619
+ :type _host_index: int, optional
620
+ :return: Returns the result object.
621
+ """ # noqa: E501
622
+
623
+ _param = self._disable_indexing_schedule_serialize(
624
+ schedule_rid=schedule_rid,
625
+ _request_auth=_request_auth,
626
+ _content_type=_content_type,
627
+ _headers=_headers,
628
+ _host_index=_host_index
629
+ )
630
+
631
+ _response_types_map: Dict[str, Optional[str]] = {
632
+ '200': None,
633
+ '404': None,
634
+ }
635
+ response_data = self.api_client.call_api(
636
+ *_param,
637
+ _request_timeout=_request_timeout
638
+ )
639
+ response_data.read()
640
+ return self.api_client.response_deserialize(
641
+ response_data=response_data,
642
+ response_types_map=_response_types_map,
643
+ ).data
644
+
645
+
646
+ @validate_call
647
+ def disable_indexing_schedule_with_http_info(
648
+ self,
649
+ schedule_rid: StrictStr,
650
+ _request_timeout: Union[
651
+ None,
652
+ Annotated[StrictFloat, Field(gt=0)],
653
+ Tuple[
654
+ Annotated[StrictFloat, Field(gt=0)],
655
+ Annotated[StrictFloat, Field(gt=0)]
656
+ ]
657
+ ] = None,
658
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
659
+ _content_type: Optional[StrictStr] = None,
660
+ _headers: Optional[Dict[StrictStr, Any]] = None,
661
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
662
+ ) -> ApiResponse[None]:
663
+ """Disable an indexing schedule
664
+
665
+
666
+ :param schedule_rid: (required)
667
+ :type schedule_rid: str
668
+ :param _request_timeout: timeout setting for this request. If one
669
+ number provided, it will be total request
670
+ timeout. It can also be a pair (tuple) of
671
+ (connection, read) timeouts.
672
+ :type _request_timeout: int, tuple(int, int), optional
673
+ :param _request_auth: set to override the auth_settings for an a single
674
+ request; this effectively ignores the
675
+ authentication in the spec for a single request.
676
+ :type _request_auth: dict, optional
677
+ :param _content_type: force content-type for the request.
678
+ :type _content_type: str, Optional
679
+ :param _headers: set to override the headers for a single
680
+ request; this effectively ignores the headers
681
+ in the spec for a single request.
682
+ :type _headers: dict, optional
683
+ :param _host_index: set to override the host_index for a single
684
+ request; this effectively ignores the host_index
685
+ in the spec for a single request.
686
+ :type _host_index: int, optional
687
+ :return: Returns the result object.
688
+ """ # noqa: E501
689
+
690
+ _param = self._disable_indexing_schedule_serialize(
691
+ schedule_rid=schedule_rid,
692
+ _request_auth=_request_auth,
693
+ _content_type=_content_type,
694
+ _headers=_headers,
695
+ _host_index=_host_index
696
+ )
697
+
698
+ _response_types_map: Dict[str, Optional[str]] = {
699
+ '200': None,
700
+ '404': None,
701
+ }
702
+ response_data = self.api_client.call_api(
703
+ *_param,
704
+ _request_timeout=_request_timeout
705
+ )
706
+ response_data.read()
707
+ return self.api_client.response_deserialize(
708
+ response_data=response_data,
709
+ response_types_map=_response_types_map,
710
+ )
711
+
712
+
713
+ @validate_call
714
+ def disable_indexing_schedule_without_preload_content(
715
+ self,
716
+ schedule_rid: StrictStr,
717
+ _request_timeout: Union[
718
+ None,
719
+ Annotated[StrictFloat, Field(gt=0)],
720
+ Tuple[
721
+ Annotated[StrictFloat, Field(gt=0)],
722
+ Annotated[StrictFloat, Field(gt=0)]
723
+ ]
724
+ ] = None,
725
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
726
+ _content_type: Optional[StrictStr] = None,
727
+ _headers: Optional[Dict[StrictStr, Any]] = None,
728
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
729
+ ) -> RESTResponseType:
730
+ """Disable an indexing schedule
731
+
732
+
733
+ :param schedule_rid: (required)
734
+ :type schedule_rid: str
735
+ :param _request_timeout: timeout setting for this request. If one
736
+ number provided, it will be total request
737
+ timeout. It can also be a pair (tuple) of
738
+ (connection, read) timeouts.
739
+ :type _request_timeout: int, tuple(int, int), optional
740
+ :param _request_auth: set to override the auth_settings for an a single
741
+ request; this effectively ignores the
742
+ authentication in the spec for a single request.
743
+ :type _request_auth: dict, optional
744
+ :param _content_type: force content-type for the request.
745
+ :type _content_type: str, Optional
746
+ :param _headers: set to override the headers for a single
747
+ request; this effectively ignores the headers
748
+ in the spec for a single request.
749
+ :type _headers: dict, optional
750
+ :param _host_index: set to override the host_index for a single
751
+ request; this effectively ignores the host_index
752
+ in the spec for a single request.
753
+ :type _host_index: int, optional
754
+ :return: Returns the result object.
755
+ """ # noqa: E501
756
+
757
+ _param = self._disable_indexing_schedule_serialize(
758
+ schedule_rid=schedule_rid,
759
+ _request_auth=_request_auth,
760
+ _content_type=_content_type,
761
+ _headers=_headers,
762
+ _host_index=_host_index
763
+ )
764
+
765
+ _response_types_map: Dict[str, Optional[str]] = {
766
+ '200': None,
767
+ '404': None,
768
+ }
769
+ response_data = self.api_client.call_api(
770
+ *_param,
771
+ _request_timeout=_request_timeout
772
+ )
773
+ return response_data.response
774
+
775
+
776
+ def _disable_indexing_schedule_serialize(
777
+ self,
778
+ schedule_rid,
779
+ _request_auth,
780
+ _content_type,
781
+ _headers,
782
+ _host_index,
783
+ ) -> RequestSerialized:
784
+
785
+ _host = None
786
+
787
+ _collection_formats: Dict[str, str] = {
788
+ }
789
+
790
+ _path_params: Dict[str, str] = {}
791
+ _query_params: List[Tuple[str, str]] = []
792
+ _header_params: Dict[str, Optional[str]] = _headers or {}
793
+ _form_params: List[Tuple[str, str]] = []
794
+ _files: Dict[
795
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
796
+ ] = {}
797
+ _body_params: Optional[bytes] = None
798
+
799
+ # process the path parameters
800
+ if schedule_rid is not None:
801
+ _path_params['scheduleRid'] = schedule_rid
802
+ # process the query parameters
803
+ # process the header parameters
804
+ # process the form parameters
805
+ # process the body parameter
806
+
807
+
808
+
809
+
810
+ # authentication setting
811
+ _auth_settings: List[str] = [
812
+ ]
813
+
814
+ return self.api_client.param_serialize(
815
+ method='POST',
816
+ resource_path='/api/v1/indexing/schedules/{scheduleRid}/disable',
817
+ path_params=_path_params,
818
+ query_params=_query_params,
819
+ header_params=_header_params,
820
+ body=_body_params,
821
+ post_params=_form_params,
822
+ files=_files,
823
+ auth_settings=_auth_settings,
824
+ collection_formats=_collection_formats,
825
+ _host=_host,
826
+ _request_auth=_request_auth
827
+ )
828
+
829
+
830
+
831
+
832
+ @validate_call
833
+ def enable_indexing_schedule(
834
+ self,
835
+ schedule_rid: StrictStr,
836
+ _request_timeout: Union[
837
+ None,
838
+ Annotated[StrictFloat, Field(gt=0)],
839
+ Tuple[
840
+ Annotated[StrictFloat, Field(gt=0)],
841
+ Annotated[StrictFloat, Field(gt=0)]
842
+ ]
843
+ ] = None,
844
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
845
+ _content_type: Optional[StrictStr] = None,
846
+ _headers: Optional[Dict[StrictStr, Any]] = None,
847
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
848
+ ) -> None:
849
+ """Enable an indexing schedule
850
+
851
+
852
+ :param schedule_rid: (required)
853
+ :type schedule_rid: str
854
+ :param _request_timeout: timeout setting for this request. If one
855
+ number provided, it will be total request
856
+ timeout. It can also be a pair (tuple) of
857
+ (connection, read) timeouts.
858
+ :type _request_timeout: int, tuple(int, int), optional
859
+ :param _request_auth: set to override the auth_settings for an a single
860
+ request; this effectively ignores the
861
+ authentication in the spec for a single request.
862
+ :type _request_auth: dict, optional
863
+ :param _content_type: force content-type for the request.
864
+ :type _content_type: str, Optional
865
+ :param _headers: set to override the headers for a single
866
+ request; this effectively ignores the headers
867
+ in the spec for a single request.
868
+ :type _headers: dict, optional
869
+ :param _host_index: set to override the host_index for a single
870
+ request; this effectively ignores the host_index
871
+ in the spec for a single request.
872
+ :type _host_index: int, optional
873
+ :return: Returns the result object.
874
+ """ # noqa: E501
875
+
876
+ _param = self._enable_indexing_schedule_serialize(
877
+ schedule_rid=schedule_rid,
878
+ _request_auth=_request_auth,
879
+ _content_type=_content_type,
880
+ _headers=_headers,
881
+ _host_index=_host_index
882
+ )
883
+
884
+ _response_types_map: Dict[str, Optional[str]] = {
885
+ '200': None,
886
+ '404': None,
887
+ }
888
+ response_data = self.api_client.call_api(
889
+ *_param,
890
+ _request_timeout=_request_timeout
891
+ )
892
+ response_data.read()
893
+ return self.api_client.response_deserialize(
894
+ response_data=response_data,
895
+ response_types_map=_response_types_map,
896
+ ).data
897
+
898
+
899
+ @validate_call
900
+ def enable_indexing_schedule_with_http_info(
901
+ self,
902
+ schedule_rid: StrictStr,
903
+ _request_timeout: Union[
904
+ None,
905
+ Annotated[StrictFloat, Field(gt=0)],
906
+ Tuple[
907
+ Annotated[StrictFloat, Field(gt=0)],
908
+ Annotated[StrictFloat, Field(gt=0)]
909
+ ]
910
+ ] = None,
911
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
912
+ _content_type: Optional[StrictStr] = None,
913
+ _headers: Optional[Dict[StrictStr, Any]] = None,
914
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
915
+ ) -> ApiResponse[None]:
916
+ """Enable an indexing schedule
917
+
918
+
919
+ :param schedule_rid: (required)
920
+ :type schedule_rid: str
921
+ :param _request_timeout: timeout setting for this request. If one
922
+ number provided, it will be total request
923
+ timeout. It can also be a pair (tuple) of
924
+ (connection, read) timeouts.
925
+ :type _request_timeout: int, tuple(int, int), optional
926
+ :param _request_auth: set to override the auth_settings for an a single
927
+ request; this effectively ignores the
928
+ authentication in the spec for a single request.
929
+ :type _request_auth: dict, optional
930
+ :param _content_type: force content-type for the request.
931
+ :type _content_type: str, Optional
932
+ :param _headers: set to override the headers for a single
933
+ request; this effectively ignores the headers
934
+ in the spec for a single request.
935
+ :type _headers: dict, optional
936
+ :param _host_index: set to override the host_index for a single
937
+ request; this effectively ignores the host_index
938
+ in the spec for a single request.
939
+ :type _host_index: int, optional
940
+ :return: Returns the result object.
941
+ """ # noqa: E501
942
+
943
+ _param = self._enable_indexing_schedule_serialize(
944
+ schedule_rid=schedule_rid,
945
+ _request_auth=_request_auth,
946
+ _content_type=_content_type,
947
+ _headers=_headers,
948
+ _host_index=_host_index
949
+ )
950
+
951
+ _response_types_map: Dict[str, Optional[str]] = {
952
+ '200': None,
953
+ '404': None,
954
+ }
955
+ response_data = self.api_client.call_api(
956
+ *_param,
957
+ _request_timeout=_request_timeout
958
+ )
959
+ response_data.read()
960
+ return self.api_client.response_deserialize(
961
+ response_data=response_data,
962
+ response_types_map=_response_types_map,
963
+ )
964
+
965
+
966
+ @validate_call
967
+ def enable_indexing_schedule_without_preload_content(
968
+ self,
969
+ schedule_rid: StrictStr,
970
+ _request_timeout: Union[
971
+ None,
972
+ Annotated[StrictFloat, Field(gt=0)],
973
+ Tuple[
974
+ Annotated[StrictFloat, Field(gt=0)],
975
+ Annotated[StrictFloat, Field(gt=0)]
976
+ ]
977
+ ] = None,
978
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
979
+ _content_type: Optional[StrictStr] = None,
980
+ _headers: Optional[Dict[StrictStr, Any]] = None,
981
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
982
+ ) -> RESTResponseType:
983
+ """Enable an indexing schedule
984
+
985
+
986
+ :param schedule_rid: (required)
987
+ :type schedule_rid: str
988
+ :param _request_timeout: timeout setting for this request. If one
989
+ number provided, it will be total request
990
+ timeout. It can also be a pair (tuple) of
991
+ (connection, read) timeouts.
992
+ :type _request_timeout: int, tuple(int, int), optional
993
+ :param _request_auth: set to override the auth_settings for an a single
994
+ request; this effectively ignores the
995
+ authentication in the spec for a single request.
996
+ :type _request_auth: dict, optional
997
+ :param _content_type: force content-type for the request.
998
+ :type _content_type: str, Optional
999
+ :param _headers: set to override the headers for a single
1000
+ request; this effectively ignores the headers
1001
+ in the spec for a single request.
1002
+ :type _headers: dict, optional
1003
+ :param _host_index: set to override the host_index for a single
1004
+ request; this effectively ignores the host_index
1005
+ in the spec for a single request.
1006
+ :type _host_index: int, optional
1007
+ :return: Returns the result object.
1008
+ """ # noqa: E501
1009
+
1010
+ _param = self._enable_indexing_schedule_serialize(
1011
+ schedule_rid=schedule_rid,
1012
+ _request_auth=_request_auth,
1013
+ _content_type=_content_type,
1014
+ _headers=_headers,
1015
+ _host_index=_host_index
1016
+ )
1017
+
1018
+ _response_types_map: Dict[str, Optional[str]] = {
1019
+ '200': None,
1020
+ '404': None,
1021
+ }
1022
+ response_data = self.api_client.call_api(
1023
+ *_param,
1024
+ _request_timeout=_request_timeout
1025
+ )
1026
+ return response_data.response
1027
+
1028
+
1029
+ def _enable_indexing_schedule_serialize(
1030
+ self,
1031
+ schedule_rid,
1032
+ _request_auth,
1033
+ _content_type,
1034
+ _headers,
1035
+ _host_index,
1036
+ ) -> RequestSerialized:
1037
+
1038
+ _host = None
1039
+
1040
+ _collection_formats: Dict[str, str] = {
1041
+ }
1042
+
1043
+ _path_params: Dict[str, str] = {}
1044
+ _query_params: List[Tuple[str, str]] = []
1045
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1046
+ _form_params: List[Tuple[str, str]] = []
1047
+ _files: Dict[
1048
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1049
+ ] = {}
1050
+ _body_params: Optional[bytes] = None
1051
+
1052
+ # process the path parameters
1053
+ if schedule_rid is not None:
1054
+ _path_params['scheduleRid'] = schedule_rid
1055
+ # process the query parameters
1056
+ # process the header parameters
1057
+ # process the form parameters
1058
+ # process the body parameter
1059
+
1060
+
1061
+
1062
+
1063
+ # authentication setting
1064
+ _auth_settings: List[str] = [
1065
+ ]
1066
+
1067
+ return self.api_client.param_serialize(
1068
+ method='POST',
1069
+ resource_path='/api/v1/indexing/schedules/{scheduleRid}/enable',
1070
+ path_params=_path_params,
1071
+ query_params=_query_params,
1072
+ header_params=_header_params,
1073
+ body=_body_params,
1074
+ post_params=_form_params,
1075
+ files=_files,
1076
+ auth_settings=_auth_settings,
1077
+ collection_formats=_collection_formats,
1078
+ _host=_host,
1079
+ _request_auth=_request_auth
1080
+ )
1081
+
1082
+
1083
+
1084
+
1085
+ @validate_call
1086
+ def get_indexing_schedule(
1087
+ self,
1088
+ schedule_rid: StrictStr,
1089
+ _request_timeout: Union[
1090
+ None,
1091
+ Annotated[StrictFloat, Field(gt=0)],
1092
+ Tuple[
1093
+ Annotated[StrictFloat, Field(gt=0)],
1094
+ Annotated[StrictFloat, Field(gt=0)]
1095
+ ]
1096
+ ] = None,
1097
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1098
+ _content_type: Optional[StrictStr] = None,
1099
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1100
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1101
+ ) -> GetIndexingScheduleResponse:
1102
+ """Get an indexing schedule
1103
+
1104
+
1105
+ :param schedule_rid: (required)
1106
+ :type schedule_rid: str
1107
+ :param _request_timeout: timeout setting for this request. If one
1108
+ number provided, it will be total request
1109
+ timeout. It can also be a pair (tuple) of
1110
+ (connection, read) timeouts.
1111
+ :type _request_timeout: int, tuple(int, int), optional
1112
+ :param _request_auth: set to override the auth_settings for an a single
1113
+ request; this effectively ignores the
1114
+ authentication in the spec for a single request.
1115
+ :type _request_auth: dict, optional
1116
+ :param _content_type: force content-type for the request.
1117
+ :type _content_type: str, Optional
1118
+ :param _headers: set to override the headers for a single
1119
+ request; this effectively ignores the headers
1120
+ in the spec for a single request.
1121
+ :type _headers: dict, optional
1122
+ :param _host_index: set to override the host_index for a single
1123
+ request; this effectively ignores the host_index
1124
+ in the spec for a single request.
1125
+ :type _host_index: int, optional
1126
+ :return: Returns the result object.
1127
+ """ # noqa: E501
1128
+
1129
+ _param = self._get_indexing_schedule_serialize(
1130
+ schedule_rid=schedule_rid,
1131
+ _request_auth=_request_auth,
1132
+ _content_type=_content_type,
1133
+ _headers=_headers,
1134
+ _host_index=_host_index
1135
+ )
1136
+
1137
+ _response_types_map: Dict[str, Optional[str]] = {
1138
+ '200': "GetIndexingScheduleResponse",
1139
+ '404': None,
1140
+ }
1141
+ response_data = self.api_client.call_api(
1142
+ *_param,
1143
+ _request_timeout=_request_timeout
1144
+ )
1145
+ response_data.read()
1146
+ return self.api_client.response_deserialize(
1147
+ response_data=response_data,
1148
+ response_types_map=_response_types_map,
1149
+ ).data
1150
+
1151
+
1152
+ @validate_call
1153
+ def get_indexing_schedule_with_http_info(
1154
+ self,
1155
+ schedule_rid: StrictStr,
1156
+ _request_timeout: Union[
1157
+ None,
1158
+ Annotated[StrictFloat, Field(gt=0)],
1159
+ Tuple[
1160
+ Annotated[StrictFloat, Field(gt=0)],
1161
+ Annotated[StrictFloat, Field(gt=0)]
1162
+ ]
1163
+ ] = None,
1164
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1165
+ _content_type: Optional[StrictStr] = None,
1166
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1167
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1168
+ ) -> ApiResponse[GetIndexingScheduleResponse]:
1169
+ """Get an indexing schedule
1170
+
1171
+
1172
+ :param schedule_rid: (required)
1173
+ :type schedule_rid: str
1174
+ :param _request_timeout: timeout setting for this request. If one
1175
+ number provided, it will be total request
1176
+ timeout. It can also be a pair (tuple) of
1177
+ (connection, read) timeouts.
1178
+ :type _request_timeout: int, tuple(int, int), optional
1179
+ :param _request_auth: set to override the auth_settings for an a single
1180
+ request; this effectively ignores the
1181
+ authentication in the spec for a single request.
1182
+ :type _request_auth: dict, optional
1183
+ :param _content_type: force content-type for the request.
1184
+ :type _content_type: str, Optional
1185
+ :param _headers: set to override the headers for a single
1186
+ request; this effectively ignores the headers
1187
+ in the spec for a single request.
1188
+ :type _headers: dict, optional
1189
+ :param _host_index: set to override the host_index for a single
1190
+ request; this effectively ignores the host_index
1191
+ in the spec for a single request.
1192
+ :type _host_index: int, optional
1193
+ :return: Returns the result object.
1194
+ """ # noqa: E501
1195
+
1196
+ _param = self._get_indexing_schedule_serialize(
1197
+ schedule_rid=schedule_rid,
1198
+ _request_auth=_request_auth,
1199
+ _content_type=_content_type,
1200
+ _headers=_headers,
1201
+ _host_index=_host_index
1202
+ )
1203
+
1204
+ _response_types_map: Dict[str, Optional[str]] = {
1205
+ '200': "GetIndexingScheduleResponse",
1206
+ '404': None,
1207
+ }
1208
+ response_data = self.api_client.call_api(
1209
+ *_param,
1210
+ _request_timeout=_request_timeout
1211
+ )
1212
+ response_data.read()
1213
+ return self.api_client.response_deserialize(
1214
+ response_data=response_data,
1215
+ response_types_map=_response_types_map,
1216
+ )
1217
+
1218
+
1219
+ @validate_call
1220
+ def get_indexing_schedule_without_preload_content(
1221
+ self,
1222
+ schedule_rid: StrictStr,
1223
+ _request_timeout: Union[
1224
+ None,
1225
+ Annotated[StrictFloat, Field(gt=0)],
1226
+ Tuple[
1227
+ Annotated[StrictFloat, Field(gt=0)],
1228
+ Annotated[StrictFloat, Field(gt=0)]
1229
+ ]
1230
+ ] = None,
1231
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1232
+ _content_type: Optional[StrictStr] = None,
1233
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1234
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1235
+ ) -> RESTResponseType:
1236
+ """Get an indexing schedule
1237
+
1238
+
1239
+ :param schedule_rid: (required)
1240
+ :type schedule_rid: str
1241
+ :param _request_timeout: timeout setting for this request. If one
1242
+ number provided, it will be total request
1243
+ timeout. It can also be a pair (tuple) of
1244
+ (connection, read) timeouts.
1245
+ :type _request_timeout: int, tuple(int, int), optional
1246
+ :param _request_auth: set to override the auth_settings for an a single
1247
+ request; this effectively ignores the
1248
+ authentication in the spec for a single request.
1249
+ :type _request_auth: dict, optional
1250
+ :param _content_type: force content-type for the request.
1251
+ :type _content_type: str, Optional
1252
+ :param _headers: set to override the headers for a single
1253
+ request; this effectively ignores the headers
1254
+ in the spec for a single request.
1255
+ :type _headers: dict, optional
1256
+ :param _host_index: set to override the host_index for a single
1257
+ request; this effectively ignores the host_index
1258
+ in the spec for a single request.
1259
+ :type _host_index: int, optional
1260
+ :return: Returns the result object.
1261
+ """ # noqa: E501
1262
+
1263
+ _param = self._get_indexing_schedule_serialize(
1264
+ schedule_rid=schedule_rid,
1265
+ _request_auth=_request_auth,
1266
+ _content_type=_content_type,
1267
+ _headers=_headers,
1268
+ _host_index=_host_index
1269
+ )
1270
+
1271
+ _response_types_map: Dict[str, Optional[str]] = {
1272
+ '200': "GetIndexingScheduleResponse",
1273
+ '404': None,
1274
+ }
1275
+ response_data = self.api_client.call_api(
1276
+ *_param,
1277
+ _request_timeout=_request_timeout
1278
+ )
1279
+ return response_data.response
1280
+
1281
+
1282
+ def _get_indexing_schedule_serialize(
1283
+ self,
1284
+ schedule_rid,
1285
+ _request_auth,
1286
+ _content_type,
1287
+ _headers,
1288
+ _host_index,
1289
+ ) -> RequestSerialized:
1290
+
1291
+ _host = None
1292
+
1293
+ _collection_formats: Dict[str, str] = {
1294
+ }
1295
+
1296
+ _path_params: Dict[str, str] = {}
1297
+ _query_params: List[Tuple[str, str]] = []
1298
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1299
+ _form_params: List[Tuple[str, str]] = []
1300
+ _files: Dict[
1301
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1302
+ ] = {}
1303
+ _body_params: Optional[bytes] = None
1304
+
1305
+ # process the path parameters
1306
+ if schedule_rid is not None:
1307
+ _path_params['scheduleRid'] = schedule_rid
1308
+ # process the query parameters
1309
+ # process the header parameters
1310
+ # process the form parameters
1311
+ # process the body parameter
1312
+
1313
+
1314
+ # set the HTTP header `Accept`
1315
+ if 'Accept' not in _header_params:
1316
+ _header_params['Accept'] = self.api_client.select_header_accept(
1317
+ [
1318
+ 'application/json'
1319
+ ]
1320
+ )
1321
+
1322
+
1323
+ # authentication setting
1324
+ _auth_settings: List[str] = [
1325
+ ]
1326
+
1327
+ return self.api_client.param_serialize(
1328
+ method='GET',
1329
+ resource_path='/api/v1/indexing/schedules/{scheduleRid}',
1330
+ path_params=_path_params,
1331
+ query_params=_query_params,
1332
+ header_params=_header_params,
1333
+ body=_body_params,
1334
+ post_params=_form_params,
1335
+ files=_files,
1336
+ auth_settings=_auth_settings,
1337
+ collection_formats=_collection_formats,
1338
+ _host=_host,
1339
+ _request_auth=_request_auth
1340
+ )
1341
+
1342
+
1343
+
1344
+
1345
+ @validate_call
1346
+ def list_indexing_schedules(
1347
+ self,
1348
+ enabled: Optional[StrictBool] = None,
1349
+ file_system_rid: Optional[StrictStr] = None,
1350
+ limit: Optional[StrictInt] = None,
1351
+ offset: Optional[StrictInt] = None,
1352
+ _request_timeout: Union[
1353
+ None,
1354
+ Annotated[StrictFloat, Field(gt=0)],
1355
+ Tuple[
1356
+ Annotated[StrictFloat, Field(gt=0)],
1357
+ Annotated[StrictFloat, Field(gt=0)]
1358
+ ]
1359
+ ] = None,
1360
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1361
+ _content_type: Optional[StrictStr] = None,
1362
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1363
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1364
+ ) -> ListIndexingSchedulesResponse:
1365
+ """List indexing schedules
1366
+
1367
+
1368
+ :param enabled:
1369
+ :type enabled: bool
1370
+ :param file_system_rid:
1371
+ :type file_system_rid: str
1372
+ :param limit:
1373
+ :type limit: int
1374
+ :param offset:
1375
+ :type offset: int
1376
+ :param _request_timeout: timeout setting for this request. If one
1377
+ number provided, it will be total request
1378
+ timeout. It can also be a pair (tuple) of
1379
+ (connection, read) timeouts.
1380
+ :type _request_timeout: int, tuple(int, int), optional
1381
+ :param _request_auth: set to override the auth_settings for an a single
1382
+ request; this effectively ignores the
1383
+ authentication in the spec for a single request.
1384
+ :type _request_auth: dict, optional
1385
+ :param _content_type: force content-type for the request.
1386
+ :type _content_type: str, Optional
1387
+ :param _headers: set to override the headers for a single
1388
+ request; this effectively ignores the headers
1389
+ in the spec for a single request.
1390
+ :type _headers: dict, optional
1391
+ :param _host_index: set to override the host_index for a single
1392
+ request; this effectively ignores the host_index
1393
+ in the spec for a single request.
1394
+ :type _host_index: int, optional
1395
+ :return: Returns the result object.
1396
+ """ # noqa: E501
1397
+
1398
+ _param = self._list_indexing_schedules_serialize(
1399
+ enabled=enabled,
1400
+ file_system_rid=file_system_rid,
1401
+ limit=limit,
1402
+ offset=offset,
1403
+ _request_auth=_request_auth,
1404
+ _content_type=_content_type,
1405
+ _headers=_headers,
1406
+ _host_index=_host_index
1407
+ )
1408
+
1409
+ _response_types_map: Dict[str, Optional[str]] = {
1410
+ '200': "ListIndexingSchedulesResponse",
1411
+ }
1412
+ response_data = self.api_client.call_api(
1413
+ *_param,
1414
+ _request_timeout=_request_timeout
1415
+ )
1416
+ response_data.read()
1417
+ return self.api_client.response_deserialize(
1418
+ response_data=response_data,
1419
+ response_types_map=_response_types_map,
1420
+ ).data
1421
+
1422
+
1423
+ @validate_call
1424
+ def list_indexing_schedules_with_http_info(
1425
+ self,
1426
+ enabled: Optional[StrictBool] = None,
1427
+ file_system_rid: Optional[StrictStr] = None,
1428
+ limit: Optional[StrictInt] = None,
1429
+ offset: Optional[StrictInt] = None,
1430
+ _request_timeout: Union[
1431
+ None,
1432
+ Annotated[StrictFloat, Field(gt=0)],
1433
+ Tuple[
1434
+ Annotated[StrictFloat, Field(gt=0)],
1435
+ Annotated[StrictFloat, Field(gt=0)]
1436
+ ]
1437
+ ] = None,
1438
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1439
+ _content_type: Optional[StrictStr] = None,
1440
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1441
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1442
+ ) -> ApiResponse[ListIndexingSchedulesResponse]:
1443
+ """List indexing schedules
1444
+
1445
+
1446
+ :param enabled:
1447
+ :type enabled: bool
1448
+ :param file_system_rid:
1449
+ :type file_system_rid: str
1450
+ :param limit:
1451
+ :type limit: int
1452
+ :param offset:
1453
+ :type offset: int
1454
+ :param _request_timeout: timeout setting for this request. If one
1455
+ number provided, it will be total request
1456
+ timeout. It can also be a pair (tuple) of
1457
+ (connection, read) timeouts.
1458
+ :type _request_timeout: int, tuple(int, int), optional
1459
+ :param _request_auth: set to override the auth_settings for an a single
1460
+ request; this effectively ignores the
1461
+ authentication in the spec for a single request.
1462
+ :type _request_auth: dict, optional
1463
+ :param _content_type: force content-type for the request.
1464
+ :type _content_type: str, Optional
1465
+ :param _headers: set to override the headers for a single
1466
+ request; this effectively ignores the headers
1467
+ in the spec for a single request.
1468
+ :type _headers: dict, optional
1469
+ :param _host_index: set to override the host_index for a single
1470
+ request; this effectively ignores the host_index
1471
+ in the spec for a single request.
1472
+ :type _host_index: int, optional
1473
+ :return: Returns the result object.
1474
+ """ # noqa: E501
1475
+
1476
+ _param = self._list_indexing_schedules_serialize(
1477
+ enabled=enabled,
1478
+ file_system_rid=file_system_rid,
1479
+ limit=limit,
1480
+ offset=offset,
1481
+ _request_auth=_request_auth,
1482
+ _content_type=_content_type,
1483
+ _headers=_headers,
1484
+ _host_index=_host_index
1485
+ )
1486
+
1487
+ _response_types_map: Dict[str, Optional[str]] = {
1488
+ '200': "ListIndexingSchedulesResponse",
1489
+ }
1490
+ response_data = self.api_client.call_api(
1491
+ *_param,
1492
+ _request_timeout=_request_timeout
1493
+ )
1494
+ response_data.read()
1495
+ return self.api_client.response_deserialize(
1496
+ response_data=response_data,
1497
+ response_types_map=_response_types_map,
1498
+ )
1499
+
1500
+
1501
+ @validate_call
1502
+ def list_indexing_schedules_without_preload_content(
1503
+ self,
1504
+ enabled: Optional[StrictBool] = None,
1505
+ file_system_rid: Optional[StrictStr] = None,
1506
+ limit: Optional[StrictInt] = None,
1507
+ offset: Optional[StrictInt] = None,
1508
+ _request_timeout: Union[
1509
+ None,
1510
+ Annotated[StrictFloat, Field(gt=0)],
1511
+ Tuple[
1512
+ Annotated[StrictFloat, Field(gt=0)],
1513
+ Annotated[StrictFloat, Field(gt=0)]
1514
+ ]
1515
+ ] = None,
1516
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1517
+ _content_type: Optional[StrictStr] = None,
1518
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1519
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1520
+ ) -> RESTResponseType:
1521
+ """List indexing schedules
1522
+
1523
+
1524
+ :param enabled:
1525
+ :type enabled: bool
1526
+ :param file_system_rid:
1527
+ :type file_system_rid: str
1528
+ :param limit:
1529
+ :type limit: int
1530
+ :param offset:
1531
+ :type offset: int
1532
+ :param _request_timeout: timeout setting for this request. If one
1533
+ number provided, it will be total request
1534
+ timeout. It can also be a pair (tuple) of
1535
+ (connection, read) timeouts.
1536
+ :type _request_timeout: int, tuple(int, int), optional
1537
+ :param _request_auth: set to override the auth_settings for an a single
1538
+ request; this effectively ignores the
1539
+ authentication in the spec for a single request.
1540
+ :type _request_auth: dict, optional
1541
+ :param _content_type: force content-type for the request.
1542
+ :type _content_type: str, Optional
1543
+ :param _headers: set to override the headers for a single
1544
+ request; this effectively ignores the headers
1545
+ in the spec for a single request.
1546
+ :type _headers: dict, optional
1547
+ :param _host_index: set to override the host_index for a single
1548
+ request; this effectively ignores the host_index
1549
+ in the spec for a single request.
1550
+ :type _host_index: int, optional
1551
+ :return: Returns the result object.
1552
+ """ # noqa: E501
1553
+
1554
+ _param = self._list_indexing_schedules_serialize(
1555
+ enabled=enabled,
1556
+ file_system_rid=file_system_rid,
1557
+ limit=limit,
1558
+ offset=offset,
1559
+ _request_auth=_request_auth,
1560
+ _content_type=_content_type,
1561
+ _headers=_headers,
1562
+ _host_index=_host_index
1563
+ )
1564
+
1565
+ _response_types_map: Dict[str, Optional[str]] = {
1566
+ '200': "ListIndexingSchedulesResponse",
1567
+ }
1568
+ response_data = self.api_client.call_api(
1569
+ *_param,
1570
+ _request_timeout=_request_timeout
1571
+ )
1572
+ return response_data.response
1573
+
1574
+
1575
+ def _list_indexing_schedules_serialize(
1576
+ self,
1577
+ enabled,
1578
+ file_system_rid,
1579
+ limit,
1580
+ offset,
1581
+ _request_auth,
1582
+ _content_type,
1583
+ _headers,
1584
+ _host_index,
1585
+ ) -> RequestSerialized:
1586
+
1587
+ _host = None
1588
+
1589
+ _collection_formats: Dict[str, str] = {
1590
+ }
1591
+
1592
+ _path_params: Dict[str, str] = {}
1593
+ _query_params: List[Tuple[str, str]] = []
1594
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1595
+ _form_params: List[Tuple[str, str]] = []
1596
+ _files: Dict[
1597
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1598
+ ] = {}
1599
+ _body_params: Optional[bytes] = None
1600
+
1601
+ # process the path parameters
1602
+ # process the query parameters
1603
+ if enabled is not None:
1604
+
1605
+ _query_params.append(('enabled', enabled))
1606
+
1607
+ if file_system_rid is not None:
1608
+
1609
+ _query_params.append(('fileSystemRid', file_system_rid))
1610
+
1611
+ if limit is not None:
1612
+
1613
+ _query_params.append(('limit', limit))
1614
+
1615
+ if offset is not None:
1616
+
1617
+ _query_params.append(('offset', offset))
1618
+
1619
+ # process the header parameters
1620
+ # process the form parameters
1621
+ # process the body parameter
1622
+
1623
+
1624
+ # set the HTTP header `Accept`
1625
+ if 'Accept' not in _header_params:
1626
+ _header_params['Accept'] = self.api_client.select_header_accept(
1627
+ [
1628
+ 'application/json'
1629
+ ]
1630
+ )
1631
+
1632
+
1633
+ # authentication setting
1634
+ _auth_settings: List[str] = [
1635
+ ]
1636
+
1637
+ return self.api_client.param_serialize(
1638
+ method='GET',
1639
+ resource_path='/api/v1/indexing/schedules',
1640
+ path_params=_path_params,
1641
+ query_params=_query_params,
1642
+ header_params=_header_params,
1643
+ body=_body_params,
1644
+ post_params=_form_params,
1645
+ files=_files,
1646
+ auth_settings=_auth_settings,
1647
+ collection_formats=_collection_formats,
1648
+ _host=_host,
1649
+ _request_auth=_request_auth
1650
+ )
1651
+
1652
+
1653
+
1654
+
1655
+ @validate_call
1656
+ def list_schedule_executions(
1657
+ self,
1658
+ schedule_rid: StrictStr,
1659
+ limit: Optional[StrictInt] = None,
1660
+ offset: Optional[StrictInt] = None,
1661
+ _request_timeout: Union[
1662
+ None,
1663
+ Annotated[StrictFloat, Field(gt=0)],
1664
+ Tuple[
1665
+ Annotated[StrictFloat, Field(gt=0)],
1666
+ Annotated[StrictFloat, Field(gt=0)]
1667
+ ]
1668
+ ] = None,
1669
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1670
+ _content_type: Optional[StrictStr] = None,
1671
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1672
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1673
+ ) -> ListScheduleExecutionsResponse:
1674
+ """List schedule execution history
1675
+
1676
+
1677
+ :param schedule_rid: (required)
1678
+ :type schedule_rid: str
1679
+ :param limit:
1680
+ :type limit: int
1681
+ :param offset:
1682
+ :type offset: int
1683
+ :param _request_timeout: timeout setting for this request. If one
1684
+ number provided, it will be total request
1685
+ timeout. It can also be a pair (tuple) of
1686
+ (connection, read) timeouts.
1687
+ :type _request_timeout: int, tuple(int, int), optional
1688
+ :param _request_auth: set to override the auth_settings for an a single
1689
+ request; this effectively ignores the
1690
+ authentication in the spec for a single request.
1691
+ :type _request_auth: dict, optional
1692
+ :param _content_type: force content-type for the request.
1693
+ :type _content_type: str, Optional
1694
+ :param _headers: set to override the headers for a single
1695
+ request; this effectively ignores the headers
1696
+ in the spec for a single request.
1697
+ :type _headers: dict, optional
1698
+ :param _host_index: set to override the host_index for a single
1699
+ request; this effectively ignores the host_index
1700
+ in the spec for a single request.
1701
+ :type _host_index: int, optional
1702
+ :return: Returns the result object.
1703
+ """ # noqa: E501
1704
+
1705
+ _param = self._list_schedule_executions_serialize(
1706
+ schedule_rid=schedule_rid,
1707
+ limit=limit,
1708
+ offset=offset,
1709
+ _request_auth=_request_auth,
1710
+ _content_type=_content_type,
1711
+ _headers=_headers,
1712
+ _host_index=_host_index
1713
+ )
1714
+
1715
+ _response_types_map: Dict[str, Optional[str]] = {
1716
+ '200': "ListScheduleExecutionsResponse",
1717
+ '404': None,
1718
+ }
1719
+ response_data = self.api_client.call_api(
1720
+ *_param,
1721
+ _request_timeout=_request_timeout
1722
+ )
1723
+ response_data.read()
1724
+ return self.api_client.response_deserialize(
1725
+ response_data=response_data,
1726
+ response_types_map=_response_types_map,
1727
+ ).data
1728
+
1729
+
1730
+ @validate_call
1731
+ def list_schedule_executions_with_http_info(
1732
+ self,
1733
+ schedule_rid: StrictStr,
1734
+ limit: Optional[StrictInt] = None,
1735
+ offset: Optional[StrictInt] = None,
1736
+ _request_timeout: Union[
1737
+ None,
1738
+ Annotated[StrictFloat, Field(gt=0)],
1739
+ Tuple[
1740
+ Annotated[StrictFloat, Field(gt=0)],
1741
+ Annotated[StrictFloat, Field(gt=0)]
1742
+ ]
1743
+ ] = None,
1744
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1745
+ _content_type: Optional[StrictStr] = None,
1746
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1747
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1748
+ ) -> ApiResponse[ListScheduleExecutionsResponse]:
1749
+ """List schedule execution history
1750
+
1751
+
1752
+ :param schedule_rid: (required)
1753
+ :type schedule_rid: str
1754
+ :param limit:
1755
+ :type limit: int
1756
+ :param offset:
1757
+ :type offset: int
1758
+ :param _request_timeout: timeout setting for this request. If one
1759
+ number provided, it will be total request
1760
+ timeout. It can also be a pair (tuple) of
1761
+ (connection, read) timeouts.
1762
+ :type _request_timeout: int, tuple(int, int), optional
1763
+ :param _request_auth: set to override the auth_settings for an a single
1764
+ request; this effectively ignores the
1765
+ authentication in the spec for a single request.
1766
+ :type _request_auth: dict, optional
1767
+ :param _content_type: force content-type for the request.
1768
+ :type _content_type: str, Optional
1769
+ :param _headers: set to override the headers for a single
1770
+ request; this effectively ignores the headers
1771
+ in the spec for a single request.
1772
+ :type _headers: dict, optional
1773
+ :param _host_index: set to override the host_index for a single
1774
+ request; this effectively ignores the host_index
1775
+ in the spec for a single request.
1776
+ :type _host_index: int, optional
1777
+ :return: Returns the result object.
1778
+ """ # noqa: E501
1779
+
1780
+ _param = self._list_schedule_executions_serialize(
1781
+ schedule_rid=schedule_rid,
1782
+ limit=limit,
1783
+ offset=offset,
1784
+ _request_auth=_request_auth,
1785
+ _content_type=_content_type,
1786
+ _headers=_headers,
1787
+ _host_index=_host_index
1788
+ )
1789
+
1790
+ _response_types_map: Dict[str, Optional[str]] = {
1791
+ '200': "ListScheduleExecutionsResponse",
1792
+ '404': None,
1793
+ }
1794
+ response_data = self.api_client.call_api(
1795
+ *_param,
1796
+ _request_timeout=_request_timeout
1797
+ )
1798
+ response_data.read()
1799
+ return self.api_client.response_deserialize(
1800
+ response_data=response_data,
1801
+ response_types_map=_response_types_map,
1802
+ )
1803
+
1804
+
1805
+ @validate_call
1806
+ def list_schedule_executions_without_preload_content(
1807
+ self,
1808
+ schedule_rid: StrictStr,
1809
+ limit: Optional[StrictInt] = None,
1810
+ offset: Optional[StrictInt] = None,
1811
+ _request_timeout: Union[
1812
+ None,
1813
+ Annotated[StrictFloat, Field(gt=0)],
1814
+ Tuple[
1815
+ Annotated[StrictFloat, Field(gt=0)],
1816
+ Annotated[StrictFloat, Field(gt=0)]
1817
+ ]
1818
+ ] = None,
1819
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1820
+ _content_type: Optional[StrictStr] = None,
1821
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1822
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1823
+ ) -> RESTResponseType:
1824
+ """List schedule execution history
1825
+
1826
+
1827
+ :param schedule_rid: (required)
1828
+ :type schedule_rid: str
1829
+ :param limit:
1830
+ :type limit: int
1831
+ :param offset:
1832
+ :type offset: int
1833
+ :param _request_timeout: timeout setting for this request. If one
1834
+ number provided, it will be total request
1835
+ timeout. It can also be a pair (tuple) of
1836
+ (connection, read) timeouts.
1837
+ :type _request_timeout: int, tuple(int, int), optional
1838
+ :param _request_auth: set to override the auth_settings for an a single
1839
+ request; this effectively ignores the
1840
+ authentication in the spec for a single request.
1841
+ :type _request_auth: dict, optional
1842
+ :param _content_type: force content-type for the request.
1843
+ :type _content_type: str, Optional
1844
+ :param _headers: set to override the headers for a single
1845
+ request; this effectively ignores the headers
1846
+ in the spec for a single request.
1847
+ :type _headers: dict, optional
1848
+ :param _host_index: set to override the host_index for a single
1849
+ request; this effectively ignores the host_index
1850
+ in the spec for a single request.
1851
+ :type _host_index: int, optional
1852
+ :return: Returns the result object.
1853
+ """ # noqa: E501
1854
+
1855
+ _param = self._list_schedule_executions_serialize(
1856
+ schedule_rid=schedule_rid,
1857
+ limit=limit,
1858
+ offset=offset,
1859
+ _request_auth=_request_auth,
1860
+ _content_type=_content_type,
1861
+ _headers=_headers,
1862
+ _host_index=_host_index
1863
+ )
1864
+
1865
+ _response_types_map: Dict[str, Optional[str]] = {
1866
+ '200': "ListScheduleExecutionsResponse",
1867
+ '404': None,
1868
+ }
1869
+ response_data = self.api_client.call_api(
1870
+ *_param,
1871
+ _request_timeout=_request_timeout
1872
+ )
1873
+ return response_data.response
1874
+
1875
+
1876
+ def _list_schedule_executions_serialize(
1877
+ self,
1878
+ schedule_rid,
1879
+ limit,
1880
+ offset,
1881
+ _request_auth,
1882
+ _content_type,
1883
+ _headers,
1884
+ _host_index,
1885
+ ) -> RequestSerialized:
1886
+
1887
+ _host = None
1888
+
1889
+ _collection_formats: Dict[str, str] = {
1890
+ }
1891
+
1892
+ _path_params: Dict[str, str] = {}
1893
+ _query_params: List[Tuple[str, str]] = []
1894
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1895
+ _form_params: List[Tuple[str, str]] = []
1896
+ _files: Dict[
1897
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1898
+ ] = {}
1899
+ _body_params: Optional[bytes] = None
1900
+
1901
+ # process the path parameters
1902
+ if schedule_rid is not None:
1903
+ _path_params['scheduleRid'] = schedule_rid
1904
+ # process the query parameters
1905
+ if limit is not None:
1906
+
1907
+ _query_params.append(('limit', limit))
1908
+
1909
+ if offset is not None:
1910
+
1911
+ _query_params.append(('offset', offset))
1912
+
1913
+ # process the header parameters
1914
+ # process the form parameters
1915
+ # process the body parameter
1916
+
1917
+
1918
+ # set the HTTP header `Accept`
1919
+ if 'Accept' not in _header_params:
1920
+ _header_params['Accept'] = self.api_client.select_header_accept(
1921
+ [
1922
+ 'application/json'
1923
+ ]
1924
+ )
1925
+
1926
+
1927
+ # authentication setting
1928
+ _auth_settings: List[str] = [
1929
+ ]
1930
+
1931
+ return self.api_client.param_serialize(
1932
+ method='GET',
1933
+ resource_path='/api/v1/indexing/schedules/{scheduleRid}/executions',
1934
+ path_params=_path_params,
1935
+ query_params=_query_params,
1936
+ header_params=_header_params,
1937
+ body=_body_params,
1938
+ post_params=_form_params,
1939
+ files=_files,
1940
+ auth_settings=_auth_settings,
1941
+ collection_formats=_collection_formats,
1942
+ _host=_host,
1943
+ _request_auth=_request_auth
1944
+ )
1945
+
1946
+
1947
+
1948
+
1949
+ @validate_call
1950
+ def update_indexing_schedule(
1951
+ self,
1952
+ schedule_rid: StrictStr,
1953
+ update_indexing_schedule_request: UpdateIndexingScheduleRequest,
1954
+ _request_timeout: Union[
1955
+ None,
1956
+ Annotated[StrictFloat, Field(gt=0)],
1957
+ Tuple[
1958
+ Annotated[StrictFloat, Field(gt=0)],
1959
+ Annotated[StrictFloat, Field(gt=0)]
1960
+ ]
1961
+ ] = None,
1962
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1963
+ _content_type: Optional[StrictStr] = None,
1964
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1965
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1966
+ ) -> UpdateIndexingScheduleResponse:
1967
+ """Update an indexing schedule
1968
+
1969
+ Updates specific fields of an existing schedule. Only provided fields will be updated.
1970
+
1971
+ :param schedule_rid: (required)
1972
+ :type schedule_rid: str
1973
+ :param update_indexing_schedule_request: (required)
1974
+ :type update_indexing_schedule_request: UpdateIndexingScheduleRequest
1975
+ :param _request_timeout: timeout setting for this request. If one
1976
+ number provided, it will be total request
1977
+ timeout. It can also be a pair (tuple) of
1978
+ (connection, read) timeouts.
1979
+ :type _request_timeout: int, tuple(int, int), optional
1980
+ :param _request_auth: set to override the auth_settings for an a single
1981
+ request; this effectively ignores the
1982
+ authentication in the spec for a single request.
1983
+ :type _request_auth: dict, optional
1984
+ :param _content_type: force content-type for the request.
1985
+ :type _content_type: str, Optional
1986
+ :param _headers: set to override the headers for a single
1987
+ request; this effectively ignores the headers
1988
+ in the spec for a single request.
1989
+ :type _headers: dict, optional
1990
+ :param _host_index: set to override the host_index for a single
1991
+ request; this effectively ignores the host_index
1992
+ in the spec for a single request.
1993
+ :type _host_index: int, optional
1994
+ :return: Returns the result object.
1995
+ """ # noqa: E501
1996
+
1997
+ _param = self._update_indexing_schedule_serialize(
1998
+ schedule_rid=schedule_rid,
1999
+ update_indexing_schedule_request=update_indexing_schedule_request,
2000
+ _request_auth=_request_auth,
2001
+ _content_type=_content_type,
2002
+ _headers=_headers,
2003
+ _host_index=_host_index
2004
+ )
2005
+
2006
+ _response_types_map: Dict[str, Optional[str]] = {
2007
+ '200': "UpdateIndexingScheduleResponse",
2008
+ '400': None,
2009
+ '404': None,
2010
+ '409': None,
2011
+ }
2012
+ response_data = self.api_client.call_api(
2013
+ *_param,
2014
+ _request_timeout=_request_timeout
2015
+ )
2016
+ response_data.read()
2017
+ return self.api_client.response_deserialize(
2018
+ response_data=response_data,
2019
+ response_types_map=_response_types_map,
2020
+ ).data
2021
+
2022
+
2023
+ @validate_call
2024
+ def update_indexing_schedule_with_http_info(
2025
+ self,
2026
+ schedule_rid: StrictStr,
2027
+ update_indexing_schedule_request: UpdateIndexingScheduleRequest,
2028
+ _request_timeout: Union[
2029
+ None,
2030
+ Annotated[StrictFloat, Field(gt=0)],
2031
+ Tuple[
2032
+ Annotated[StrictFloat, Field(gt=0)],
2033
+ Annotated[StrictFloat, Field(gt=0)]
2034
+ ]
2035
+ ] = None,
2036
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2037
+ _content_type: Optional[StrictStr] = None,
2038
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2039
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2040
+ ) -> ApiResponse[UpdateIndexingScheduleResponse]:
2041
+ """Update an indexing schedule
2042
+
2043
+ Updates specific fields of an existing schedule. Only provided fields will be updated.
2044
+
2045
+ :param schedule_rid: (required)
2046
+ :type schedule_rid: str
2047
+ :param update_indexing_schedule_request: (required)
2048
+ :type update_indexing_schedule_request: UpdateIndexingScheduleRequest
2049
+ :param _request_timeout: timeout setting for this request. If one
2050
+ number provided, it will be total request
2051
+ timeout. It can also be a pair (tuple) of
2052
+ (connection, read) timeouts.
2053
+ :type _request_timeout: int, tuple(int, int), optional
2054
+ :param _request_auth: set to override the auth_settings for an a single
2055
+ request; this effectively ignores the
2056
+ authentication in the spec for a single request.
2057
+ :type _request_auth: dict, optional
2058
+ :param _content_type: force content-type for the request.
2059
+ :type _content_type: str, Optional
2060
+ :param _headers: set to override the headers for a single
2061
+ request; this effectively ignores the headers
2062
+ in the spec for a single request.
2063
+ :type _headers: dict, optional
2064
+ :param _host_index: set to override the host_index for a single
2065
+ request; this effectively ignores the host_index
2066
+ in the spec for a single request.
2067
+ :type _host_index: int, optional
2068
+ :return: Returns the result object.
2069
+ """ # noqa: E501
2070
+
2071
+ _param = self._update_indexing_schedule_serialize(
2072
+ schedule_rid=schedule_rid,
2073
+ update_indexing_schedule_request=update_indexing_schedule_request,
2074
+ _request_auth=_request_auth,
2075
+ _content_type=_content_type,
2076
+ _headers=_headers,
2077
+ _host_index=_host_index
2078
+ )
2079
+
2080
+ _response_types_map: Dict[str, Optional[str]] = {
2081
+ '200': "UpdateIndexingScheduleResponse",
2082
+ '400': None,
2083
+ '404': None,
2084
+ '409': None,
2085
+ }
2086
+ response_data = self.api_client.call_api(
2087
+ *_param,
2088
+ _request_timeout=_request_timeout
2089
+ )
2090
+ response_data.read()
2091
+ return self.api_client.response_deserialize(
2092
+ response_data=response_data,
2093
+ response_types_map=_response_types_map,
2094
+ )
2095
+
2096
+
2097
+ @validate_call
2098
+ def update_indexing_schedule_without_preload_content(
2099
+ self,
2100
+ schedule_rid: StrictStr,
2101
+ update_indexing_schedule_request: UpdateIndexingScheduleRequest,
2102
+ _request_timeout: Union[
2103
+ None,
2104
+ Annotated[StrictFloat, Field(gt=0)],
2105
+ Tuple[
2106
+ Annotated[StrictFloat, Field(gt=0)],
2107
+ Annotated[StrictFloat, Field(gt=0)]
2108
+ ]
2109
+ ] = None,
2110
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2111
+ _content_type: Optional[StrictStr] = None,
2112
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2113
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2114
+ ) -> RESTResponseType:
2115
+ """Update an indexing schedule
2116
+
2117
+ Updates specific fields of an existing schedule. Only provided fields will be updated.
2118
+
2119
+ :param schedule_rid: (required)
2120
+ :type schedule_rid: str
2121
+ :param update_indexing_schedule_request: (required)
2122
+ :type update_indexing_schedule_request: UpdateIndexingScheduleRequest
2123
+ :param _request_timeout: timeout setting for this request. If one
2124
+ number provided, it will be total request
2125
+ timeout. It can also be a pair (tuple) of
2126
+ (connection, read) timeouts.
2127
+ :type _request_timeout: int, tuple(int, int), optional
2128
+ :param _request_auth: set to override the auth_settings for an a single
2129
+ request; this effectively ignores the
2130
+ authentication in the spec for a single request.
2131
+ :type _request_auth: dict, optional
2132
+ :param _content_type: force content-type for the request.
2133
+ :type _content_type: str, Optional
2134
+ :param _headers: set to override the headers for a single
2135
+ request; this effectively ignores the headers
2136
+ in the spec for a single request.
2137
+ :type _headers: dict, optional
2138
+ :param _host_index: set to override the host_index for a single
2139
+ request; this effectively ignores the host_index
2140
+ in the spec for a single request.
2141
+ :type _host_index: int, optional
2142
+ :return: Returns the result object.
2143
+ """ # noqa: E501
2144
+
2145
+ _param = self._update_indexing_schedule_serialize(
2146
+ schedule_rid=schedule_rid,
2147
+ update_indexing_schedule_request=update_indexing_schedule_request,
2148
+ _request_auth=_request_auth,
2149
+ _content_type=_content_type,
2150
+ _headers=_headers,
2151
+ _host_index=_host_index
2152
+ )
2153
+
2154
+ _response_types_map: Dict[str, Optional[str]] = {
2155
+ '200': "UpdateIndexingScheduleResponse",
2156
+ '400': None,
2157
+ '404': None,
2158
+ '409': None,
2159
+ }
2160
+ response_data = self.api_client.call_api(
2161
+ *_param,
2162
+ _request_timeout=_request_timeout
2163
+ )
2164
+ return response_data.response
2165
+
2166
+
2167
+ def _update_indexing_schedule_serialize(
2168
+ self,
2169
+ schedule_rid,
2170
+ update_indexing_schedule_request,
2171
+ _request_auth,
2172
+ _content_type,
2173
+ _headers,
2174
+ _host_index,
2175
+ ) -> RequestSerialized:
2176
+
2177
+ _host = None
2178
+
2179
+ _collection_formats: Dict[str, str] = {
2180
+ }
2181
+
2182
+ _path_params: Dict[str, str] = {}
2183
+ _query_params: List[Tuple[str, str]] = []
2184
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2185
+ _form_params: List[Tuple[str, str]] = []
2186
+ _files: Dict[
2187
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2188
+ ] = {}
2189
+ _body_params: Optional[bytes] = None
2190
+
2191
+ # process the path parameters
2192
+ if schedule_rid is not None:
2193
+ _path_params['scheduleRid'] = schedule_rid
2194
+ # process the query parameters
2195
+ # process the header parameters
2196
+ # process the form parameters
2197
+ # process the body parameter
2198
+ if update_indexing_schedule_request is not None:
2199
+ _body_params = update_indexing_schedule_request
2200
+
2201
+
2202
+ # set the HTTP header `Accept`
2203
+ if 'Accept' not in _header_params:
2204
+ _header_params['Accept'] = self.api_client.select_header_accept(
2205
+ [
2206
+ 'application/json'
2207
+ ]
2208
+ )
2209
+
2210
+ # set the HTTP header `Content-Type`
2211
+ if _content_type:
2212
+ _header_params['Content-Type'] = _content_type
2213
+ else:
2214
+ _default_content_type = (
2215
+ self.api_client.select_header_content_type(
2216
+ [
2217
+ 'application/json'
2218
+ ]
2219
+ )
2220
+ )
2221
+ if _default_content_type is not None:
2222
+ _header_params['Content-Type'] = _default_content_type
2223
+
2224
+ # authentication setting
2225
+ _auth_settings: List[str] = [
2226
+ ]
2227
+
2228
+ return self.api_client.param_serialize(
2229
+ method='PATCH',
2230
+ resource_path='/api/v1/indexing/schedules/{scheduleRid}',
2231
+ path_params=_path_params,
2232
+ query_params=_query_params,
2233
+ header_params=_header_params,
2234
+ body=_body_params,
2235
+ post_params=_form_params,
2236
+ files=_files,
2237
+ auth_settings=_auth_settings,
2238
+ collection_formats=_collection_formats,
2239
+ _host=_host,
2240
+ _request_auth=_request_auth
2241
+ )
2242
+
2243
+