/
cloudsearch-api.json
6021 lines (6021 loc) · 252 KB
/
cloudsearch-api.json
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
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud_search": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.debug": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.indexing": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.query": {
"description": "Search your organization's data in the Cloud Search index"
},
"https://www.googleapis.com/auth/cloud_search.settings": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.settings.indexing": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.settings.query": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.stats": {
"description": "Index and serve your organization's data with Cloud Search"
},
"https://www.googleapis.com/auth/cloud_search.stats.indexing": {
"description": "Index and serve your organization's data with Cloud Search"
}
}
}
},
"basePath": "",
"baseUrl": "https://cloudsearch.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Search",
"description": "Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud Search.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/cloud-search/docs/guides/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudsearch:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://cloudsearch.mtls.googleapis.com/",
"name": "cloudsearch",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"debug": {
"resources": {
"datasources": {
"resources": {
"items": {
"methods": {
"checkAccess": {
"description": "Checks whether an item is accessible by specified principal. Principal must be a user; groups and domain values aren't supported. **Note:** This API requires an admin account to execute.",
"flatPath": "v1/debug/datasources/{datasourcesId}/items/{itemsId}:checkAccess",
"httpMethod": "POST",
"id": "cloudsearch.debug.datasources.items.checkAccess",
"parameterOrder": [
"name"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Item name, format: datasources/{source_id}/items/{item_id}",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/debug/{+name}:checkAccess",
"request": {
"$ref": "Principal"
},
"response": {
"$ref": "CheckAccessResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
]
},
"searchByViewUrl": {
"description": "Fetches the item whose viewUrl exactly matches that of the URL provided in the request. **Note:** This API requires an admin account to execute.",
"flatPath": "v1/debug/datasources/{datasourcesId}/items:searchByViewUrl",
"httpMethod": "POST",
"id": "cloudsearch.debug.datasources.items.searchByViewUrl",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Source name, format: datasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/debug/{+name}/items:searchByViewUrl",
"request": {
"$ref": "SearchItemsByViewUrlRequest"
},
"response": {
"$ref": "SearchItemsByViewUrlResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
]
}
},
"resources": {
"unmappedids": {
"methods": {
"list": {
"description": "List all unmapped identities for a specific item. **Note:** This API requires an admin account to execute.",
"flatPath": "v1/debug/datasources/{datasourcesId}/items/{itemsId}/unmappedids",
"httpMethod": "GET",
"id": "cloudsearch.debug.datasources.items.unmappedids.list",
"parameterOrder": [
"parent"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"pageSize": {
"description": "Maximum number of items to fetch in a request. Defaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The name of the item, in the following format: datasources/{source_id}/items/{ID}",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/debug/{+parent}/unmappedids",
"response": {
"$ref": "ListUnmappedIdentitiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
]
}
}
}
}
}
}
},
"identitysources": {
"resources": {
"items": {
"methods": {
"listForunmappedidentity": {
"description": "Lists names of items associated with an unmapped identity. **Note:** This API requires an admin account to execute.",
"flatPath": "v1/debug/identitysources/{identitysourcesId}/items:forunmappedidentity",
"httpMethod": "GET",
"id": "cloudsearch.debug.identitysources.items.listForunmappedidentity",
"parameterOrder": [
"parent"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"groupResourceName": {
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of items to fetch in a request. Defaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The name of the identity source, in the following format: identitysources/{source_id}}",
"location": "path",
"pattern": "^identitysources/[^/]+$",
"required": true,
"type": "string"
},
"userResourceName": {
"location": "query",
"type": "string"
}
},
"path": "v1/debug/{+parent}/items:forunmappedidentity",
"response": {
"$ref": "ListItemNamesForUnmappedIdentityResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
]
}
}
},
"unmappedids": {
"methods": {
"list": {
"description": "Lists unmapped user identities for an identity source. **Note:** This API requires an admin account to execute.",
"flatPath": "v1/debug/identitysources/{identitysourcesId}/unmappedids",
"httpMethod": "GET",
"id": "cloudsearch.debug.identitysources.unmappedids.list",
"parameterOrder": [
"parent"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"pageSize": {
"description": "Maximum number of items to fetch in a request. Defaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The name of the identity source, in the following format: identitysources/{source_id}",
"location": "path",
"pattern": "^identitysources/[^/]+$",
"required": true,
"type": "string"
},
"resolutionStatusCode": {
"description": "Limit users selection to this status.",
"enum": [
"CODE_UNSPECIFIED",
"NOT_FOUND",
"IDENTITY_SOURCE_NOT_FOUND",
"IDENTITY_SOURCE_MISCONFIGURED",
"TOO_MANY_MAPPINGS_FOUND",
"INTERNAL_ERROR"
],
"enumDescriptions": [
"Input-only value. Used to list all unmapped identities regardless of status.",
"The unmapped identity was not found in IDaaS, and needs to be provided by the user.",
"The identity source associated with the identity was either not found or deleted.",
"IDaaS does not understand the identity source, probably because the schema was modified in a non compatible way.",
"The number of users associated with the external identity is too large.",
"Internal error."
],
"location": "query",
"type": "string"
}
},
"path": "v1/debug/{+parent}/unmappedids",
"response": {
"$ref": "ListUnmappedIdentitiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug"
]
}
}
}
}
}
}
},
"indexing": {
"resources": {
"datasources": {
"methods": {
"deleteSchema": {
"description": "Deletes the schema of a data source. **Note:** This API requires an admin or service account to execute.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/schema",
"httpMethod": "DELETE",
"id": "cloudsearch.indexing.datasources.deleteSchema",
"parameterOrder": [
"name"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "The name of the data source to delete Schema. Format: datasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}/schema",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing"
]
},
"getSchema": {
"description": "Gets the schema of a data source. **Note:** This API requires an admin or service account to execute.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/schema",
"httpMethod": "GET",
"id": "cloudsearch.indexing.datasources.getSchema",
"parameterOrder": [
"name"
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "The name of the data source to get Schema. Format: datasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}/schema",
"response": {
"$ref": "Schema"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing"
]
},
"updateSchema": {
"description": "Updates the schema of a data source. This method does not perform incremental updates to the schema. Instead, this method updates the schema by overwriting the entire schema. **Note:** This API requires an admin or service account to execute.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/schema",
"httpMethod": "PUT",
"id": "cloudsearch.indexing.datasources.updateSchema",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the data source to update Schema. Format: datasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}/schema",
"request": {
"$ref": "UpdateSchemaRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing"
]
}
},
"resources": {
"items": {
"methods": {
"delete": {
"description": "Deletes Item resource for the specified resource name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}",
"httpMethod": "DELETE",
"id": "cloudsearch.indexing.datasources.items.delete",
"parameterOrder": [
"name"
],
"parameters": {
"connectorName": {
"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}",
"location": "query",
"type": "string"
},
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"mode": {
"description": "Required. The RequestMode for this request.",
"enum": [
"UNSPECIFIED",
"SYNCHRONOUS",
"ASYNCHRONOUS"
],
"enumDescriptions": [
"The priority is not specified in the update request. Leaving priority unspecified results in an update failure.",
"For real-time updates.",
"For changes that are executed after the response is sent back to the caller."
],
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the item to delete. Format: datasources/{source_id}/items/{item_id}",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
},
"version": {
"description": "Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations).",
"format": "byte",
"location": "query",
"type": "string"
}
},
"path": "v1/indexing/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"deleteQueueItems": {
"description": "Deletes all items in a queue. This method is useful for deleting stale items. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items:deleteQueueItems",
"httpMethod": "POST",
"id": "cloudsearch.indexing.datasources.items.deleteQueueItems",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the Data Source to delete items in a queue. Format: datasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}/items:deleteQueueItems",
"request": {
"$ref": "DeleteQueueItemsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"get": {
"description": "Gets Item resource by item name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}",
"httpMethod": "GET",
"id": "cloudsearch.indexing.datasources.items.get",
"parameterOrder": [
"name"
],
"parameters": {
"connectorName": {
"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}",
"location": "query",
"type": "string"
},
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "The name of the item to get info. Format: datasources/{source_id}/items/{item_id}",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}",
"response": {
"$ref": "Item"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"index": {
"description": "Updates Item ACL, metadata, and content. It will insert the Item if it does not exist. This method does not support partial updates. Fields with no provided values are cleared out in the Cloud Search index. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}:index",
"httpMethod": "POST",
"id": "cloudsearch.indexing.datasources.items.index",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}:index",
"request": {
"$ref": "IndexItemRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"list": {
"description": "Lists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items",
"httpMethod": "GET",
"id": "cloudsearch.indexing.datasources.items.list",
"parameterOrder": [
"name"
],
"parameters": {
"brief": {
"description": "When set to true, the indexing system only populates the following fields: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type, If this value is false, then all the fields are populated in Item.",
"location": "query",
"type": "boolean"
},
"connectorName": {
"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}",
"location": "query",
"type": "string"
},
"debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "The name of the Data Source to list Items. Format: datasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false. The default value is 10",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
}
},
"path": "v1/indexing/{+name}/items",
"response": {
"$ref": "ListItemsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"poll": {
"description": "Polls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority ItemStatus. The priority order is as follows: ERROR MODIFIED NEW_ITEM ACCEPTED Reserving items ensures that polling from other threads cannot create overlapping sets. After handling the reserved items, the client should put items back into the unreserved state, either by calling index, or by calling push with the type REQUEUE. Items automatically become available (unreserved) after 4 hours even if no update or push method is called. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items:poll",
"httpMethod": "POST",
"id": "cloudsearch.indexing.datasources.items.poll",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the Data Source to poll items. Format: datasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}/items:poll",
"request": {
"$ref": "PollItemsRequest"
},
"response": {
"$ref": "PollItemsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"push": {
"description": "Pushes an item onto a queue for later polling and updating. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}:push",
"httpMethod": "POST",
"id": "cloudsearch.indexing.datasources.items.push",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the item to push into the indexing queue. Format: datasources/{source_id}/items/{ID} This is a required field. The maximum length is 1536 characters.",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}:push",
"request": {
"$ref": "PushItemRequest"
},
"response": {
"$ref": "Item"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"unreserve": {
"description": "Unreserves all items from a queue, making them all eligible to be polled. This method is useful for resetting the indexing queue after a connector has been restarted. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items:unreserve",
"httpMethod": "POST",
"id": "cloudsearch.indexing.datasources.items.unreserve",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the Data Source to unreserve all items. Format: datasources/{source_id}",
"location": "path",
"pattern": "^datasources/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}/items:unreserve",
"request": {
"$ref": "UnreserveItemsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
},
"upload": {
"description": "Creates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline within an index request. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.",
"flatPath": "v1/indexing/datasources/{datasourcesId}/items/{itemsId}:upload",
"httpMethod": "POST",
"id": "cloudsearch.indexing.datasources.items.upload",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}. The maximum length is 1536 bytes.",
"location": "path",
"pattern": "^datasources/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/indexing/{+name}:upload",
"request": {
"$ref": "StartUploadItemRequest"
},
"response": {
"$ref": "UploadItemRef"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
]
}
}
}
}
}
}
},
"media": {
"methods": {
"upload": {
"description": "Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute.",
"flatPath": "v1/media/{mediaId}",
"httpMethod": "POST",
"id": "cloudsearch.media.upload",
"mediaUpload": {
"accept": [
"*/*"
],
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/v1/media/{+resourceName}"
}
}
},
"parameterOrder": [
"resourceName"
],
"parameters": {
"resourceName": {
"description": "Name of the media that is being downloaded. See ReadRequest.resource_name.",
"location": "path",
"pattern": "^.*$",
"required": true,
"type": "string"
}
},
"path": "v1/media/{+resourceName}",
"request": {
"$ref": "Media"
},
"response": {
"$ref": "Media"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.indexing"
],
"supportsMediaUpload": true
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "GET",
"id": "cloudsearch.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug",
"https://www.googleapis.com/auth/cloud_search.indexing",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing",
"https://www.googleapis.com/auth/cloud_search.settings.query"
]
}
},
"resources": {
"lro": {
"methods": {
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1/operations/{operationsId}/lro",
"httpMethod": "GET",
"id": "cloudsearch.operations.lro.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/lro",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug",
"https://www.googleapis.com/auth/cloud_search.indexing",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing",
"https://www.googleapis.com/auth/cloud_search.settings.query"
]
}
}
}
}
},
"query": {
"methods": {
"search": {
"description": "The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).",
"flatPath": "v1/query/search",
"httpMethod": "POST",
"id": "cloudsearch.query.search",
"parameterOrder": [],
"parameters": {},
"path": "v1/query/search",
"request": {
"$ref": "SearchRequest"
},
"response": {
"$ref": "SearchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.query"
]
},
"suggest": {
"description": "Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).",
"flatPath": "v1/query/suggest",
"httpMethod": "POST",
"id": "cloudsearch.query.suggest",
"parameterOrder": [],
"parameters": {},
"path": "v1/query/suggest",
"request": {
"$ref": "SuggestRequest"
},
"response": {
"$ref": "SuggestResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.query"
]
}
},
"resources": {
"sources": {
"methods": {
"list": {
"description": "Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).",
"flatPath": "v1/query/sources",
"httpMethod": "GET",
"id": "cloudsearch.query.sources.list",
"parameterOrder": [],
"parameters": {
"pageToken": {
"description": "Number of sources to return in the response.",
"location": "query",
"type": "string"
},
"requestOptions.debugOptions.enableDebugging": {
"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"requestOptions.languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query.",