Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / vault_v1.matters.savedQueries.html
blob: 3e7e8002574f9bc7fd8739d20893661629e92800 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="vault_v1.html">G Suite Vault API</a> . <a href="vault_v1.matters.html">matters</a> . <a href="vault_v1.matters.savedQueries.html">savedQueries</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(matterId, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a saved query.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(matterId, savedQueryId, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a saved query by Id.</p>
83<p class="toc_element">
84 <code><a href="#get">get(matterId, savedQueryId, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves a saved query by Id.</p>
86<p class="toc_element">
87 <code><a href="#list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists saved queries within a matter. An empty page token in</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(matterId, body, x__xgafv=None)</code>
95 <pre>Creates a saved query.
96
97Args:
98 matterId: string, The matter id of the parent matter for which the saved query is to be
99created. (required)
100 body: object, The request body. (required)
101 The object takes the form of:
102
103{ # Definition of the saved query.
104 "matterId": "A String", # Output only. The matter id of the associated matter.
105 # The server does not look at this field during create and always uses matter
106 # id in the URL.
107 "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved
108 # query.
109 "terms": "A String", # The corpus-specific
110 # <a href="https://support.google.com/vault/answer/2474474">search
111 # operators</a> used to generate search results.
112 "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs
113 # to be specified.
114 "sharedDriveIds": [ # List of Shared drive ids, as provided by <a
115 # href="https://developers.google.com/drive">Drive API</a>.
116 "A String",
117 ],
118 },
119 "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be
120 # specified.
121 "teamDriveIds": [ # List of Team Drive ids, as provided by <a
122 # href="https://developers.google.com/drive">Drive API</a>.
123 "A String",
124 ],
125 },
126 "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
127 "excludeDrafts": True or False, # Set to true to exclude drafts.
128 },
129 "searchMethod": "A String", # The search method to use.
130 "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be
131 # specified. (read-only)
132 "roomId": [ # A set of rooms to search.
133 "A String",
134 ],
135 },
136 "method": "A String", # The search method to use. This field is similar to the search_method field
137 # but is introduced to support shared drives. It supports all
138 # search method types. In case the search_method is TEAM_DRIVE the response
139 # of this field will be SHARED_DRIVE only.
140 "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,
141 # account_info needs to be specified.
142 "emails": [ # A set of accounts to search.
143 "A String",
144 ],
145 },
146 "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
147 "includeRooms": True or False, # Set to true to include rooms.
148 },
149 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
150 # rounded down to the start of the given date.
151 "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs
152 # to be specified.
153 "orgUnitId": "A String", # Org unit to search, as provided by the
154 # <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK
155 # Directory API</a>.
156 },
157 "timeZone": "A String", # The time zone name.
158 # It should be an IANA TZ name, such as "America/Los_Angeles".
159 # For more information, see
160 # <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time
161 # Zone</a>.
162 "corpus": "A String", # The corpus to search.
163 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
164 # rounded down to the start of the given date.
165 "dataScope": "A String", # The data source to search from.
166 "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
167 "includeSharedDrives": True or False, # Set to true to include shared drive.
168 "versionDate": "A String", # Search the versions of the Drive file
169 # as of the reference date. These timestamps are in GMT and
170 # rounded down to the given date.
171 "includeTeamDrives": True or False, # Set to true to include Team Drive.
172 },
173 },
174 "savedQueryId": "A String", # A unique identifier for the saved query.
175 "displayName": "A String", # Name of the saved query.
176 "createTime": "A String", # Output only. The server generated timestamp at which saved query was
177 # created.
178 }
179
180 x__xgafv: string, V1 error format.
181 Allowed values
182 1 - v1 error format
183 2 - v2 error format
184
185Returns:
186 An object of the form:
187
188 { # Definition of the saved query.
189 "matterId": "A String", # Output only. The matter id of the associated matter.
190 # The server does not look at this field during create and always uses matter
191 # id in the URL.
192 "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved
193 # query.
194 "terms": "A String", # The corpus-specific
195 # <a href="https://support.google.com/vault/answer/2474474">search
196 # operators</a> used to generate search results.
197 "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs
198 # to be specified.
199 "sharedDriveIds": [ # List of Shared drive ids, as provided by <a
200 # href="https://developers.google.com/drive">Drive API</a>.
201 "A String",
202 ],
203 },
204 "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be
205 # specified.
206 "teamDriveIds": [ # List of Team Drive ids, as provided by <a
207 # href="https://developers.google.com/drive">Drive API</a>.
208 "A String",
209 ],
210 },
211 "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
212 "excludeDrafts": True or False, # Set to true to exclude drafts.
213 },
214 "searchMethod": "A String", # The search method to use.
215 "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be
216 # specified. (read-only)
217 "roomId": [ # A set of rooms to search.
218 "A String",
219 ],
220 },
221 "method": "A String", # The search method to use. This field is similar to the search_method field
222 # but is introduced to support shared drives. It supports all
223 # search method types. In case the search_method is TEAM_DRIVE the response
224 # of this field will be SHARED_DRIVE only.
225 "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,
226 # account_info needs to be specified.
227 "emails": [ # A set of accounts to search.
228 "A String",
229 ],
230 },
231 "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
232 "includeRooms": True or False, # Set to true to include rooms.
233 },
234 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
235 # rounded down to the start of the given date.
236 "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs
237 # to be specified.
238 "orgUnitId": "A String", # Org unit to search, as provided by the
239 # <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK
240 # Directory API</a>.
241 },
242 "timeZone": "A String", # The time zone name.
243 # It should be an IANA TZ name, such as "America/Los_Angeles".
244 # For more information, see
245 # <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time
246 # Zone</a>.
247 "corpus": "A String", # The corpus to search.
248 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
249 # rounded down to the start of the given date.
250 "dataScope": "A String", # The data source to search from.
251 "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
252 "includeSharedDrives": True or False, # Set to true to include shared drive.
253 "versionDate": "A String", # Search the versions of the Drive file
254 # as of the reference date. These timestamps are in GMT and
255 # rounded down to the given date.
256 "includeTeamDrives": True or False, # Set to true to include Team Drive.
257 },
258 },
259 "savedQueryId": "A String", # A unique identifier for the saved query.
260 "displayName": "A String", # Name of the saved query.
261 "createTime": "A String", # Output only. The server generated timestamp at which saved query was
262 # created.
263 }</pre>
264</div>
265
266<div class="method">
267 <code class="details" id="delete">delete(matterId, savedQueryId, x__xgafv=None)</code>
268 <pre>Deletes a saved query by Id.
269
270Args:
271 matterId: string, The matter id of the parent matter for which the saved query is to be
272deleted. (required)
273 savedQueryId: string, Id of the saved query to be deleted. (required)
274 x__xgafv: string, V1 error format.
275 Allowed values
276 1 - v1 error format
277 2 - v2 error format
278
279Returns:
280 An object of the form:
281
282 { # A generic empty message that you can re-use to avoid defining duplicated
283 # empty messages in your APIs. A typical example is to use it as the request
284 # or the response type of an API method. For instance:
285 #
286 # service Foo {
287 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
288 # }
289 #
290 # The JSON representation for `Empty` is empty JSON object `{}`.
291 }</pre>
292</div>
293
294<div class="method">
295 <code class="details" id="get">get(matterId, savedQueryId, x__xgafv=None)</code>
296 <pre>Retrieves a saved query by Id.
297
298Args:
299 matterId: string, The matter id of the parent matter for which the saved query is to be
300retrieved. (required)
301 savedQueryId: string, Id of the saved query to be retrieved. (required)
302 x__xgafv: string, V1 error format.
303 Allowed values
304 1 - v1 error format
305 2 - v2 error format
306
307Returns:
308 An object of the form:
309
310 { # Definition of the saved query.
311 "matterId": "A String", # Output only. The matter id of the associated matter.
312 # The server does not look at this field during create and always uses matter
313 # id in the URL.
314 "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved
315 # query.
316 "terms": "A String", # The corpus-specific
317 # <a href="https://support.google.com/vault/answer/2474474">search
318 # operators</a> used to generate search results.
319 "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs
320 # to be specified.
321 "sharedDriveIds": [ # List of Shared drive ids, as provided by <a
322 # href="https://developers.google.com/drive">Drive API</a>.
323 "A String",
324 ],
325 },
326 "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be
327 # specified.
328 "teamDriveIds": [ # List of Team Drive ids, as provided by <a
329 # href="https://developers.google.com/drive">Drive API</a>.
330 "A String",
331 ],
332 },
333 "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
334 "excludeDrafts": True or False, # Set to true to exclude drafts.
335 },
336 "searchMethod": "A String", # The search method to use.
337 "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be
338 # specified. (read-only)
339 "roomId": [ # A set of rooms to search.
340 "A String",
341 ],
342 },
343 "method": "A String", # The search method to use. This field is similar to the search_method field
344 # but is introduced to support shared drives. It supports all
345 # search method types. In case the search_method is TEAM_DRIVE the response
346 # of this field will be SHARED_DRIVE only.
347 "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,
348 # account_info needs to be specified.
349 "emails": [ # A set of accounts to search.
350 "A String",
351 ],
352 },
353 "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
354 "includeRooms": True or False, # Set to true to include rooms.
355 },
356 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
357 # rounded down to the start of the given date.
358 "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs
359 # to be specified.
360 "orgUnitId": "A String", # Org unit to search, as provided by the
361 # <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK
362 # Directory API</a>.
363 },
364 "timeZone": "A String", # The time zone name.
365 # It should be an IANA TZ name, such as "America/Los_Angeles".
366 # For more information, see
367 # <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time
368 # Zone</a>.
369 "corpus": "A String", # The corpus to search.
370 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
371 # rounded down to the start of the given date.
372 "dataScope": "A String", # The data source to search from.
373 "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
374 "includeSharedDrives": True or False, # Set to true to include shared drive.
375 "versionDate": "A String", # Search the versions of the Drive file
376 # as of the reference date. These timestamps are in GMT and
377 # rounded down to the given date.
378 "includeTeamDrives": True or False, # Set to true to include Team Drive.
379 },
380 },
381 "savedQueryId": "A String", # A unique identifier for the saved query.
382 "displayName": "A String", # Name of the saved query.
383 "createTime": "A String", # Output only. The server generated timestamp at which saved query was
384 # created.
385 }</pre>
386</div>
387
388<div class="method">
389 <code class="details" id="list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</code>
390 <pre>Lists saved queries within a matter. An empty page token in
391ListSavedQueriesResponse denotes no more saved queries to list.
392
393Args:
394 matterId: string, The matter id of the parent matter for which the saved queries are to be
395retrieved. (required)
396 pageSize: integer, The maximum number of saved queries to return.
397 pageToken: string, The pagination token as returned in the previous response.
398An empty token means start from the beginning.
399 x__xgafv: string, V1 error format.
400 Allowed values
401 1 - v1 error format
402 2 - v2 error format
403
404Returns:
405 An object of the form:
406
407 { # Definition of the response for method ListSaveQuery.
408 "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
409 # If this is empty, then there are no more saved queries to list.
410 "savedQueries": [ # List of output saved queries.
411 { # Definition of the saved query.
412 "matterId": "A String", # Output only. The matter id of the associated matter.
413 # The server does not look at this field during create and always uses matter
414 # id in the URL.
415 "query": { # A query definition relevant for search & export. # The underlying Query object which contains all the information of the saved
416 # query.
417 "terms": "A String", # The corpus-specific
418 # <a href="https://support.google.com/vault/answer/2474474">search
419 # operators</a> used to generate search results.
420 "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs
421 # to be specified.
422 "sharedDriveIds": [ # List of Shared drive ids, as provided by <a
423 # href="https://developers.google.com/drive">Drive API</a>.
424 "A String",
425 ],
426 },
427 "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be
428 # specified.
429 "teamDriveIds": [ # List of Team Drive ids, as provided by <a
430 # href="https://developers.google.com/drive">Drive API</a>.
431 "A String",
432 ],
433 },
434 "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
435 "excludeDrafts": True or False, # Set to true to exclude drafts.
436 },
437 "searchMethod": "A String", # The search method to use.
438 "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be
439 # specified. (read-only)
440 "roomId": [ # A set of rooms to search.
441 "A String",
442 ],
443 },
444 "method": "A String", # The search method to use. This field is similar to the search_method field
445 # but is introduced to support shared drives. It supports all
446 # search method types. In case the search_method is TEAM_DRIVE the response
447 # of this field will be SHARED_DRIVE only.
448 "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,
449 # account_info needs to be specified.
450 "emails": [ # A set of accounts to search.
451 "A String",
452 ],
453 },
454 "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
455 "includeRooms": True or False, # Set to true to include rooms.
456 },
457 "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
458 # rounded down to the start of the given date.
459 "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs
460 # to be specified.
461 "orgUnitId": "A String", # Org unit to search, as provided by the
462 # <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK
463 # Directory API</a>.
464 },
465 "timeZone": "A String", # The time zone name.
466 # It should be an IANA TZ name, such as "America/Los_Angeles".
467 # For more information, see
468 # <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time
469 # Zone</a>.
470 "corpus": "A String", # The corpus to search.
471 "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
472 # rounded down to the start of the given date.
473 "dataScope": "A String", # The data source to search from.
474 "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
475 "includeSharedDrives": True or False, # Set to true to include shared drive.
476 "versionDate": "A String", # Search the versions of the Drive file
477 # as of the reference date. These timestamps are in GMT and
478 # rounded down to the given date.
479 "includeTeamDrives": True or False, # Set to true to include Team Drive.
480 },
481 },
482 "savedQueryId": "A String", # A unique identifier for the saved query.
483 "displayName": "A String", # Name of the saved query.
484 "createTime": "A String", # Output only. The server generated timestamp at which saved query was
485 # created.
486 },
487 ],
488 }</pre>
489</div>
490
491<div class="method">
492 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
493 <pre>Retrieves the next page of results.
494
495Args:
496 previous_request: The request for the previous page. (required)
497 previous_response: The response from the request for the previous page. (required)
498
499Returns:
500 A request object that you can call 'execute()' on to request the next
501 page. Returns None if there are no more items in the collection.
502 </pre>
503</div>
504
505</body></html>