-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathdocument_api.py
More file actions
784 lines (657 loc) · 40.1 KB
/
Copy pathdocument_api.py
File metadata and controls
784 lines (657 loc) · 40.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
# coding: utf-8
"""
Vidispine API
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
The version of the OpenAPI document: 5.x
Contact: info@vidispine.com
Generated by: https://openapi-generator.tech
"""
from __future__ import absolute_import
import re # noqa: F401
# python 2 and python 3 compatibility library
import six
from vidispine.models import *
from vidispine.api_client import ApiClient
from vidispine.exceptions import (
ApiTypeError,
ApiValueError
)
class DocumentApi(object):
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def delete_document(self, name, **kwargs): # noqa: E501
"""Delete a document # noqa: E501
Removes the metadata document with the specified name. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_document(name, async_req=True)
>>> result = thread.get()
:key bool async_req: execute request asynchronously
:param str name: The name. (required)
:key _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:key _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None.
If the method is called asynchronously, returns the request thread.
:rtype: None or multiprocessing.pool.AsyncResult
"""
kwargs['_return_http_data_only'] = True
return self.delete_document_with_http_info(name, **kwargs) # noqa: E501
def delete_document_with_http_info(self, name, **kwargs): # noqa: E501
"""Delete a document # noqa: E501
Removes the metadata document with the specified name. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_document_with_http_info(name, async_req=True)
>>> result = thread.get()
:key bool async_req: execute request asynchronously
:param str name: The name. (required)
:key _return_http_data_only: response data without head status code
and headers
:key _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:key _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['name'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_document" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in local_var_params or
local_var_params['name'] is None):
raise ApiValueError("Missing the required parameter `name` when calling `delete_document`") # noqa: E501
collection_formats = {}
path_params = {}
if 'name' in local_var_params:
path_params['name'] = local_var_params['name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/document/{name}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_document(self, name, **kwargs): # noqa: E501
"""Retrieve a document # noqa: E501
Retrieves the document with the specified name. This resource shares the same query parameters as the item metadata resource. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_document(name, async_req=True)
>>> result = thread.get()
:key bool async_req: execute request asynchronously
:param str name: The name. (required)
:key list[str] language: Comma-separated list. - *language-tag* - Return metadata for specific language, e. g. `en_US`. Wildcards may be used, e. g. `*_CA` for both Canadian French and Canadian English. - `none` - Return all metadata without language specification. - `all` (default) - Return all metadata, with or without language specification.
:key list[str] track: Comma-separated list. - *track-type* *track-number* - Return metadata for specified track. Example of track is `A2`. - *track-type* *t1* `-` *t2* - Return metadata for specified track interval, e. g. `A2-4`. - *track-type* `*` - Return metadata for all tracks of specified type, e. g. `A*`. - `generic` - Return all non-tracked metadata. - `all` (default) - All metadata, with or without track specification, are returned.
:key str conflict: - `yes` (default) - Include all metadata conflicts, unresolved. - `no` - Return conflicts resolved according to field rules.
:key str samplerate: Convert all outgoing time instants to specified rate. *NB!* Time codes which cannot be expressed in an integer number of samples will be returned as a decimal number, with risk of losing precision.
:key bool default_value: - `true` - For unset fields, return default values. - `false` (default) - Do not return default values.
:key list[str] interval: Comma-separated list - *time-span* - Filter out metadata, return only metadata for specified time span. - `generic` - Return all non-timed metadata. - `all` (default) - Return all metadata, same as `interval=generic,-INF-+INF`
:key list[str] group: Comma-separated list. - *group-name* - Return specified group. - *group-name* `+` - Return specified group and subgroups. - *group-name* `:` *new-name* - Return specified group, renamed to a new name in return value. - `-` *group-name* - Exclude specified group. - (default) - Return all groups.
:key list[str] field: Comma-separated list. - *field-name* - Return specified field. - *field-name* \":\" *new-name* - Return specified field, renamed to a new name in return value. - \"-\" *field-name* - Exclude specified field. - (default) - Return all fields.
:key str include: A list of keys. Includes additional field specific data. Additionally, if set to `type` the type definition of the field will be retrieved.
:key _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:key _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: MetadataType.
If the method is called asynchronously, returns the request thread.
:rtype: MetadataType or multiprocessing.pool.AsyncResult
"""
kwargs['_return_http_data_only'] = True
return self.get_document_with_http_info(name, **kwargs) # noqa: E501
def get_document_with_http_info(self, name, **kwargs): # noqa: E501
"""Retrieve a document # noqa: E501
Retrieves the document with the specified name. This resource shares the same query parameters as the item metadata resource. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_document_with_http_info(name, async_req=True)
>>> result = thread.get()
:key bool async_req: execute request asynchronously
:param str name: The name. (required)
:key list[str] language: Comma-separated list. - *language-tag* - Return metadata for specific language, e. g. `en_US`. Wildcards may be used, e. g. `*_CA` for both Canadian French and Canadian English. - `none` - Return all metadata without language specification. - `all` (default) - Return all metadata, with or without language specification.
:key list[str] track: Comma-separated list. - *track-type* *track-number* - Return metadata for specified track. Example of track is `A2`. - *track-type* *t1* `-` *t2* - Return metadata for specified track interval, e. g. `A2-4`. - *track-type* `*` - Return metadata for all tracks of specified type, e. g. `A*`. - `generic` - Return all non-tracked metadata. - `all` (default) - All metadata, with or without track specification, are returned.
:key str conflict: - `yes` (default) - Include all metadata conflicts, unresolved. - `no` - Return conflicts resolved according to field rules.
:key str samplerate: Convert all outgoing time instants to specified rate. *NB!* Time codes which cannot be expressed in an integer number of samples will be returned as a decimal number, with risk of losing precision.
:key bool default_value: - `true` - For unset fields, return default values. - `false` (default) - Do not return default values.
:key list[str] interval: Comma-separated list - *time-span* - Filter out metadata, return only metadata for specified time span. - `generic` - Return all non-timed metadata. - `all` (default) - Return all metadata, same as `interval=generic,-INF-+INF`
:key list[str] group: Comma-separated list. - *group-name* - Return specified group. - *group-name* `+` - Return specified group and subgroups. - *group-name* `:` *new-name* - Return specified group, renamed to a new name in return value. - `-` *group-name* - Exclude specified group. - (default) - Return all groups.
:key list[str] field: Comma-separated list. - *field-name* - Return specified field. - *field-name* \":\" *new-name* - Return specified field, renamed to a new name in return value. - \"-\" *field-name* - Exclude specified field. - (default) - Return all fields.
:key str include: A list of keys. Includes additional field specific data. Additionally, if set to `type` the type definition of the field will be retrieved.
:key _return_http_data_only: response data without head status code
and headers
:key _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:key _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(MetadataType, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['name', 'language', 'track', 'conflict', 'samplerate', 'default_value', 'interval', 'group', 'field', 'include'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_document" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in local_var_params or
local_var_params['name'] is None):
raise ApiValueError("Missing the required parameter `name` when calling `get_document`") # noqa: E501
collection_formats = {}
path_params = {}
if 'name' in local_var_params:
path_params['name'] = local_var_params['name'] # noqa: E501
query_params = []
if 'language' in local_var_params:
query_params.append(('language', local_var_params['language'])) # noqa: E501
collection_formats['language'] = 'csv' # noqa: E501
if 'track' in local_var_params:
query_params.append(('track', local_var_params['track'])) # noqa: E501
collection_formats['track'] = 'csv' # noqa: E501
if 'conflict' in local_var_params:
query_params.append(('conflict', local_var_params['conflict'])) # noqa: E501
if 'samplerate' in local_var_params:
query_params.append(('samplerate', local_var_params['samplerate'])) # noqa: E501
if 'default_value' in local_var_params:
query_params.append(('defaultValue', local_var_params['default_value'])) # noqa: E501
if 'interval' in local_var_params:
query_params.append(('interval', local_var_params['interval'])) # noqa: E501
collection_formats['interval'] = 'csv' # noqa: E501
if 'group' in local_var_params:
query_params.append(('group', local_var_params['group'])) # noqa: E501
collection_formats['group'] = 'csv' # noqa: E501
if 'field' in local_var_params:
query_params.append(('field', local_var_params['field'])) # noqa: E501
collection_formats['field'] = 'csv' # noqa: E501
if 'include' in local_var_params:
query_params.append(('include', local_var_params['include'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/xml']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/document/{name}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='MetadataType', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_document_change_sets(self, name, **kwargs): # noqa: E501
"""View change sets # noqa: E501
Retrieves all change sets that have been applied to the document. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_document_change_sets(name, async_req=True)
>>> result = thread.get()
:key bool async_req: execute request asynchronously
:param str name: The name. (required)
:key str change: Retrieve a single change set.
:key int first: Return change sets from that number in the list of sorted change sets.
:key int number: Return at most that number of change sets. Default is all change sets.
:key _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:key _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: MetadataChangeSetType.
If the method is called asynchronously, returns the request thread.
:rtype: MetadataChangeSetType or multiprocessing.pool.AsyncResult
"""
kwargs['_return_http_data_only'] = True
return self.get_document_change_sets_with_http_info(name, **kwargs) # noqa: E501
def get_document_change_sets_with_http_info(self, name, **kwargs): # noqa: E501
"""View change sets # noqa: E501
Retrieves all change sets that have been applied to the document. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_document_change_sets_with_http_info(name, async_req=True)
>>> result = thread.get()
:key bool async_req: execute request asynchronously
:param str name: The name. (required)
:key str change: Retrieve a single change set.
:key int first: Return change sets from that number in the list of sorted change sets.
:key int number: Return at most that number of change sets. Default is all change sets.
:key _return_http_data_only: response data without head status code
and headers
:key _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:key _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(MetadataChangeSetType, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['name', 'change', 'first', 'number'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_document_change_sets" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in local_var_params or
local_var_params['name'] is None):
raise ApiValueError("Missing the required parameter `name` when calling `get_document_change_sets`") # noqa: E501
collection_formats = {}
path_params = {}
if 'name' in local_var_params:
path_params['name'] = local_var_params['name'] # noqa: E501
query_params = []
if 'change' in local_var_params:
query_params.append(('change', local_var_params['change'])) # noqa: E501
if 'first' in local_var_params:
query_params.append(('first', local_var_params['first'])) # noqa: E501
if 'number' in local_var_params:
query_params.append(('number', local_var_params['number'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/xml']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/document/{name}/changes', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='MetadataChangeSetType', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_documents(self, **kwargs): # noqa: E501
"""List all documents # noqa: E501
Retrieves the list of metadata documents. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_documents(async_req=True)
>>> result = thread.get()
:key bool async_req: execute request asynchronously
:key int first: Return documents from that number in the document list.
:key int number: Return at most that number of documents.
:key _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:key _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: DocumentListType.
If the method is called asynchronously, returns the request thread.
:rtype: DocumentListType or multiprocessing.pool.AsyncResult
"""
kwargs['_return_http_data_only'] = True
return self.get_documents_with_http_info(**kwargs) # noqa: E501
def get_documents_with_http_info(self, **kwargs): # noqa: E501
"""List all documents # noqa: E501
Retrieves the list of metadata documents. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_documents_with_http_info(async_req=True)
>>> result = thread.get()
:key bool async_req: execute request asynchronously
:key int first: Return documents from that number in the document list.
:key int number: Return at most that number of documents.
:key _return_http_data_only: response data without head status code
and headers
:key _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:key _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(DocumentListType, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['first', 'number'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_documents" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'first' in local_var_params:
query_params.append(('first', local_var_params['first'])) # noqa: E501
if 'number' in local_var_params:
query_params.append(('number', local_var_params['number'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/xml']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/document', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DocumentListType', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def search_documents(self, item_search_type, **kwargs): # noqa: E501
"""Search for documents # noqa: E501
Searches for documents matching a provided *ItemSearchDocument*. Note that document indexing is disabled by default. Make sure to enable document indexing using `indexDocumentMetadata` and trigger a reindex so that any existing documents are added to the index. New in version 5.0. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_documents(item_search_type, async_req=True)
>>> result = thread.get()
:key bool async_req: execute request asynchronously
:param ItemSearchType item_search_type: (required)
:key int first: Start returning results from this index.
:key bool count: - `true` (default) - Return hits in result. - `false` - Do not return hits in result, in order to produce results faster.
:key int number: Return at most this number of documents.
:key _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:key _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: SearchResultType.
If the method is called asynchronously, returns the request thread.
:rtype: SearchResultType or multiprocessing.pool.AsyncResult
"""
kwargs['_return_http_data_only'] = True
return self.search_documents_with_http_info(item_search_type, **kwargs) # noqa: E501
def search_documents_with_http_info(self, item_search_type, **kwargs): # noqa: E501
"""Search for documents # noqa: E501
Searches for documents matching a provided *ItemSearchDocument*. Note that document indexing is disabled by default. Make sure to enable document indexing using `indexDocumentMetadata` and trigger a reindex so that any existing documents are added to the index. New in version 5.0. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_documents_with_http_info(item_search_type, async_req=True)
>>> result = thread.get()
:key bool async_req: execute request asynchronously
:param ItemSearchType item_search_type: (required)
:key int first: Start returning results from this index.
:key bool count: - `true` (default) - Return hits in result. - `false` - Do not return hits in result, in order to produce results faster.
:key int number: Return at most this number of documents.
:key _return_http_data_only: response data without head status code
and headers
:key _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:key _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(SearchResultType, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['item_search_type', 'first', 'count', 'number'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method search_documents" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'item_search_type' is set
if ('item_search_type' not in local_var_params or
local_var_params['item_search_type'] is None):
raise ApiValueError("Missing the required parameter `item_search_type` when calling `search_documents`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'first' in local_var_params:
query_params.append(('first', local_var_params['first'])) # noqa: E501
if 'count' in local_var_params:
query_params.append(('count', local_var_params['count'])) # noqa: E501
if 'number' in local_var_params:
query_params.append(('number', local_var_params['number'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'item_search_type' in local_var_params:
body_params = local_var_params['item_search_type']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json', 'application/xml']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/document', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SearchResultType', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def update_or_create_document(self, name, metadata_type, **kwargs): # noqa: E501
"""Update or creates a document # noqa: E501
Creates a new or modifies the existing document with the specified name. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_or_create_document(name, metadata_type, async_req=True)
>>> result = thread.get()
:key bool async_req: execute request asynchronously
:param str name: The name. (required)
:param MetadataType metadata_type: (required)
:key str revision: The known revision. If not specified, the change set will attempt to override existing change sets.
:key bool skip_forbidden: Skip fields or groups that the user doesn't have write access to.
:key _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:key _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: MetadataType.
If the method is called asynchronously, returns the request thread.
:rtype: MetadataType or multiprocessing.pool.AsyncResult
"""
kwargs['_return_http_data_only'] = True
return self.update_or_create_document_with_http_info(name, metadata_type, **kwargs) # noqa: E501
def update_or_create_document_with_http_info(self, name, metadata_type, **kwargs): # noqa: E501
"""Update or creates a document # noqa: E501
Creates a new or modifies the existing document with the specified name. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_or_create_document_with_http_info(name, metadata_type, async_req=True)
>>> result = thread.get()
:key bool async_req: execute request asynchronously
:param str name: The name. (required)
:param MetadataType metadata_type: (required)
:key str revision: The known revision. If not specified, the change set will attempt to override existing change sets.
:key bool skip_forbidden: Skip fields or groups that the user doesn't have write access to.
:key _return_http_data_only: response data without head status code
and headers
:key _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:key _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(MetadataType, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['name', 'metadata_type', 'revision', 'skip_forbidden'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method update_or_create_document" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in local_var_params or
local_var_params['name'] is None):
raise ApiValueError("Missing the required parameter `name` when calling `update_or_create_document`") # noqa: E501
# verify the required parameter 'metadata_type' is set
if ('metadata_type' not in local_var_params or
local_var_params['metadata_type'] is None):
raise ApiValueError("Missing the required parameter `metadata_type` when calling `update_or_create_document`") # noqa: E501
collection_formats = {}
path_params = {}
if 'name' in local_var_params:
path_params['name'] = local_var_params['name'] # noqa: E501
query_params = []
if 'revision' in local_var_params:
query_params.append(('revision', local_var_params['revision'])) # noqa: E501
if 'skip_forbidden' in local_var_params:
query_params.append(('skipForbidden', local_var_params['skip_forbidden'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'metadata_type' in local_var_params:
body_params = local_var_params['metadata_type']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json', 'application/xml']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/document/{name}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='MetadataType', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)