Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / vault_v1.matters.savedQueries.html
blob: 8a571e076b640e0570623866552698c07fe6939a [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87 <code><a href="#list">list(matterId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]94 <code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95 <pre>Creates a saved query.
96
97Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]98 matterId: string, The matter ID of the parent matter for which the saved query is to be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99created. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101 The object takes the form of:
102
103{ # Definition of the saved query.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]104 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The server generated timestamp at which saved query was
105 # created.
106 &quot;savedQueryId&quot;: &quot;A String&quot;, # A unique identifier for the saved query.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 &quot;query&quot;: { # A query definition relevant for search &amp; export. # The underlying Query object which contains all the information of the saved
108 # query.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]109 &quot;accountInfo&quot;: { # Accounts to search # When &#x27;ACCOUNT&#x27; is chosen as search method,
110 # account_info needs to be specified.
111 &quot;emails&quot;: [ # A set of accounts to search.
112 &quot;A String&quot;,
113 ],
114 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 &quot;hangoutsChatInfo&quot;: { # Accounts to search # When &#x27;ROOM&#x27; is chosen as search method, hangout_chats_info needs to be
116 # specified. (read-only)
117 &quot;roomId&quot;: [ # A set of rooms to search.
118 &quot;A String&quot;,
119 ],
120 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 &quot;teamDriveInfo&quot;: { # Team Drives to search # When &#x27;TEAM_DRIVE&#x27; is chosen as search method, team_drive_info needs to be
122 # specified.
123 &quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by &lt;a
124 # href=&quot;https://developers.google.com/drive&quot;&gt;Drive API&lt;/a&gt;.
125 &quot;A String&quot;,
126 ],
127 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]128 &quot;dataScope&quot;: &quot;A String&quot;, # The data source to search from.
129 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
130 # rounded down to the start of the given date.
131 &quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
132 &quot;driveOptions&quot;: { # Drive search advanced options # For Drive search, specify more options in this field.
133 &quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
134 &quot;includeSharedDrives&quot;: True or False, # Set to true to include shared drive.
135 &quot;versionDate&quot;: &quot;A String&quot;, # Search the versions of the Drive file
136 # as of the reference date. These timestamps are in GMT and
137 # rounded down to the given date.
138 },
139 &quot;orgUnitInfo&quot;: { # Org Unit to search # When &#x27;ORG_UNIT&#x27; is chosen as as search method, org_unit_info needs
140 # to be specified.
141 &quot;orgUnitId&quot;: &quot;A String&quot;, # Org unit to search, as provided by the
142 # &lt;a href=&quot;https://developers.google.com/admin-sdk/directory/&quot;&gt;Admin SDK
143 # Directory API&lt;/a&gt;.
144 },
145 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
146 # rounded down to the start of the given date.
147 &quot;terms&quot;: &quot;A String&quot;, # The corpus-specific
148 # &lt;a href=&quot;https://support.google.com/vault/answer/2474474&quot;&gt;search
149 # operators&lt;/a&gt; used to generate search results.
150 &quot;hangoutsChatOptions&quot;: { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
151 &quot;includeRooms&quot;: True or False, # Set to true to include rooms.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]152 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]153 &quot;sharedDriveInfo&quot;: { # Shared drives to search # When &#x27;SHARED_DRIVE&#x27; is chosen as search method, shared_drive_info needs
154 # to be specified.
155 &quot;sharedDriveIds&quot;: [ # List of Shared drive IDs, as provided by &lt;a
156 # href=&quot;https://developers.google.com/drive&quot;&gt;Drive API&lt;/a&gt;.
157 &quot;A String&quot;,
158 ],
159 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]160 &quot;mailOptions&quot;: { # Mail search advanced options # For mail search, specify more options in this field.
161 &quot;excludeDrafts&quot;: True or False, # Set to true to exclude drafts.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]162 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]163 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone name.
164 # It should be an IANA TZ name, such as &quot;America/Los_Angeles&quot;.
165 # For more information, see
166 # &lt;a href=&quot;https://en.wikipedia.org/wiki/List_of_tz_database_time_zones&quot;&gt;Time
167 # Zone&lt;/a&gt;.
168 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to search.
169 &quot;method&quot;: &quot;A String&quot;, # The search method to use. This field is similar to the search_method field
170 # but is introduced to support shared drives. It supports all
171 # search method types. In case the search_method is TEAM_DRIVE the response
172 # of this field will be SHARED_DRIVE only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]173 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]174 &quot;displayName&quot;: &quot;A String&quot;, # Name of the saved query.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 &quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID of the associated matter.
176 # The server does not look at this field during create and always uses matter
177 # id in the URL.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]189 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The server generated timestamp at which saved query was
190 # created.
191 &quot;savedQueryId&quot;: &quot;A String&quot;, # A unique identifier for the saved query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]192 &quot;query&quot;: { # A query definition relevant for search &amp; export. # The underlying Query object which contains all the information of the saved
193 # query.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]194 &quot;accountInfo&quot;: { # Accounts to search # When &#x27;ACCOUNT&#x27; is chosen as search method,
195 # account_info needs to be specified.
196 &quot;emails&quot;: [ # A set of accounts to search.
197 &quot;A String&quot;,
198 ],
199 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]200 &quot;hangoutsChatInfo&quot;: { # Accounts to search # When &#x27;ROOM&#x27; is chosen as search method, hangout_chats_info needs to be
201 # specified. (read-only)
202 &quot;roomId&quot;: [ # A set of rooms to search.
203 &quot;A String&quot;,
204 ],
205 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]206 &quot;teamDriveInfo&quot;: { # Team Drives to search # When &#x27;TEAM_DRIVE&#x27; is chosen as search method, team_drive_info needs to be
207 # specified.
208 &quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by &lt;a
209 # href=&quot;https://developers.google.com/drive&quot;&gt;Drive API&lt;/a&gt;.
210 &quot;A String&quot;,
211 ],
212 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]213 &quot;dataScope&quot;: &quot;A String&quot;, # The data source to search from.
214 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
215 # rounded down to the start of the given date.
216 &quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
217 &quot;driveOptions&quot;: { # Drive search advanced options # For Drive search, specify more options in this field.
218 &quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
219 &quot;includeSharedDrives&quot;: True or False, # Set to true to include shared drive.
220 &quot;versionDate&quot;: &quot;A String&quot;, # Search the versions of the Drive file
221 # as of the reference date. These timestamps are in GMT and
222 # rounded down to the given date.
223 },
224 &quot;orgUnitInfo&quot;: { # Org Unit to search # When &#x27;ORG_UNIT&#x27; is chosen as as search method, org_unit_info needs
225 # to be specified.
226 &quot;orgUnitId&quot;: &quot;A String&quot;, # Org unit to search, as provided by the
227 # &lt;a href=&quot;https://developers.google.com/admin-sdk/directory/&quot;&gt;Admin SDK
228 # Directory API&lt;/a&gt;.
229 },
230 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
231 # rounded down to the start of the given date.
232 &quot;terms&quot;: &quot;A String&quot;, # The corpus-specific
233 # &lt;a href=&quot;https://support.google.com/vault/answer/2474474&quot;&gt;search
234 # operators&lt;/a&gt; used to generate search results.
235 &quot;hangoutsChatOptions&quot;: { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
236 &quot;includeRooms&quot;: True or False, # Set to true to include rooms.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]237 },
238 &quot;sharedDriveInfo&quot;: { # Shared drives to search # When &#x27;SHARED_DRIVE&#x27; is chosen as search method, shared_drive_info needs
239 # to be specified.
240 &quot;sharedDriveIds&quot;: [ # List of Shared drive IDs, as provided by &lt;a
241 # href=&quot;https://developers.google.com/drive&quot;&gt;Drive API&lt;/a&gt;.
242 &quot;A String&quot;,
243 ],
244 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]245 &quot;mailOptions&quot;: { # Mail search advanced options # For mail search, specify more options in this field.
246 &quot;excludeDrafts&quot;: True or False, # Set to true to exclude drafts.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]247 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]248 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone name.
249 # It should be an IANA TZ name, such as &quot;America/Los_Angeles&quot;.
250 # For more information, see
251 # &lt;a href=&quot;https://en.wikipedia.org/wiki/List_of_tz_database_time_zones&quot;&gt;Time
252 # Zone&lt;/a&gt;.
253 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to search.
254 &quot;method&quot;: &quot;A String&quot;, # The search method to use. This field is similar to the search_method field
255 # but is introduced to support shared drives. It supports all
256 # search method types. In case the search_method is TEAM_DRIVE the response
257 # of this field will be SHARED_DRIVE only.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]258 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]259 &quot;displayName&quot;: &quot;A String&quot;, # Name of the saved query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]260 &quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID of the associated matter.
261 # The server does not look at this field during create and always uses matter
262 # id in the URL.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]263 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]271 matterId: string, The matter ID of the parent matter for which the saved query is to be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]272deleted. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]273 savedQueryId: string, ID of the saved query to be deleted. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]299 matterId: string, The matter ID of the parent matter for which the saved query is to be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]300retrieved. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]301 savedQueryId: string, ID of the saved query to be retrieved. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]311 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The server generated timestamp at which saved query was
312 # created.
313 &quot;savedQueryId&quot;: &quot;A String&quot;, # A unique identifier for the saved query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]314 &quot;query&quot;: { # A query definition relevant for search &amp; export. # The underlying Query object which contains all the information of the saved
315 # query.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]316 &quot;accountInfo&quot;: { # Accounts to search # When &#x27;ACCOUNT&#x27; is chosen as search method,
317 # account_info needs to be specified.
318 &quot;emails&quot;: [ # A set of accounts to search.
319 &quot;A String&quot;,
320 ],
321 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]322 &quot;hangoutsChatInfo&quot;: { # Accounts to search # When &#x27;ROOM&#x27; is chosen as search method, hangout_chats_info needs to be
323 # specified. (read-only)
324 &quot;roomId&quot;: [ # A set of rooms to search.
325 &quot;A String&quot;,
326 ],
327 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]328 &quot;teamDriveInfo&quot;: { # Team Drives to search # When &#x27;TEAM_DRIVE&#x27; is chosen as search method, team_drive_info needs to be
329 # specified.
330 &quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by &lt;a
331 # href=&quot;https://developers.google.com/drive&quot;&gt;Drive API&lt;/a&gt;.
332 &quot;A String&quot;,
333 ],
334 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]335 &quot;dataScope&quot;: &quot;A String&quot;, # The data source to search from.
336 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
337 # rounded down to the start of the given date.
338 &quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
339 &quot;driveOptions&quot;: { # Drive search advanced options # For Drive search, specify more options in this field.
340 &quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
341 &quot;includeSharedDrives&quot;: True or False, # Set to true to include shared drive.
342 &quot;versionDate&quot;: &quot;A String&quot;, # Search the versions of the Drive file
343 # as of the reference date. These timestamps are in GMT and
344 # rounded down to the given date.
345 },
346 &quot;orgUnitInfo&quot;: { # Org Unit to search # When &#x27;ORG_UNIT&#x27; is chosen as as search method, org_unit_info needs
347 # to be specified.
348 &quot;orgUnitId&quot;: &quot;A String&quot;, # Org unit to search, as provided by the
349 # &lt;a href=&quot;https://developers.google.com/admin-sdk/directory/&quot;&gt;Admin SDK
350 # Directory API&lt;/a&gt;.
351 },
352 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
353 # rounded down to the start of the given date.
354 &quot;terms&quot;: &quot;A String&quot;, # The corpus-specific
355 # &lt;a href=&quot;https://support.google.com/vault/answer/2474474&quot;&gt;search
356 # operators&lt;/a&gt; used to generate search results.
357 &quot;hangoutsChatOptions&quot;: { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
358 &quot;includeRooms&quot;: True or False, # Set to true to include rooms.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]359 },
360 &quot;sharedDriveInfo&quot;: { # Shared drives to search # When &#x27;SHARED_DRIVE&#x27; is chosen as search method, shared_drive_info needs
361 # to be specified.
362 &quot;sharedDriveIds&quot;: [ # List of Shared drive IDs, as provided by &lt;a
363 # href=&quot;https://developers.google.com/drive&quot;&gt;Drive API&lt;/a&gt;.
364 &quot;A String&quot;,
365 ],
366 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]367 &quot;mailOptions&quot;: { # Mail search advanced options # For mail search, specify more options in this field.
368 &quot;excludeDrafts&quot;: True or False, # Set to true to exclude drafts.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]369 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]370 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone name.
371 # It should be an IANA TZ name, such as &quot;America/Los_Angeles&quot;.
372 # For more information, see
373 # &lt;a href=&quot;https://en.wikipedia.org/wiki/List_of_tz_database_time_zones&quot;&gt;Time
374 # Zone&lt;/a&gt;.
375 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to search.
376 &quot;method&quot;: &quot;A String&quot;, # The search method to use. This field is similar to the search_method field
377 # but is introduced to support shared drives. It supports all
378 # search method types. In case the search_method is TEAM_DRIVE the response
379 # of this field will be SHARED_DRIVE only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]380 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]381 &quot;displayName&quot;: &quot;A String&quot;, # Name of the saved query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]382 &quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID of the associated matter.
383 # The server does not look at this field during create and always uses matter
384 # id in the URL.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]385 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386</div>
387
388<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]389 <code class="details" id="list">list(matterId, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 <pre>Lists saved queries within a matter. An empty page token in
391ListSavedQueriesResponse denotes no more saved queries to list.
392
393Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]394 matterId: string, The matter ID of the parent matter for which the saved queries are to be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]395retrieved. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]396 pageToken: string, The pagination token as returned in the previous response.
397An empty token means start from the beginning.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]398 pageSize: integer, The maximum number of saved queries to return.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]408 &quot;savedQueries&quot;: [ # List of output saved queries.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]409 { # Definition of the saved query.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]410 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The server generated timestamp at which saved query was
411 # created.
412 &quot;savedQueryId&quot;: &quot;A String&quot;, # A unique identifier for the saved query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]413 &quot;query&quot;: { # A query definition relevant for search &amp; export. # The underlying Query object which contains all the information of the saved
414 # query.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]415 &quot;accountInfo&quot;: { # Accounts to search # When &#x27;ACCOUNT&#x27; is chosen as search method,
416 # account_info needs to be specified.
417 &quot;emails&quot;: [ # A set of accounts to search.
418 &quot;A String&quot;,
419 ],
420 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]421 &quot;hangoutsChatInfo&quot;: { # Accounts to search # When &#x27;ROOM&#x27; is chosen as search method, hangout_chats_info needs to be
422 # specified. (read-only)
423 &quot;roomId&quot;: [ # A set of rooms to search.
424 &quot;A String&quot;,
425 ],
426 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]427 &quot;teamDriveInfo&quot;: { # Team Drives to search # When &#x27;TEAM_DRIVE&#x27; is chosen as search method, team_drive_info needs to be
428 # specified.
429 &quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by &lt;a
430 # href=&quot;https://developers.google.com/drive&quot;&gt;Drive API&lt;/a&gt;.
431 &quot;A String&quot;,
432 ],
433 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]434 &quot;dataScope&quot;: &quot;A String&quot;, # The data source to search from.
435 &quot;endTime&quot;: &quot;A String&quot;, # The end time range for the search query. These timestamps are in GMT and
436 # rounded down to the start of the given date.
437 &quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
438 &quot;driveOptions&quot;: { # Drive search advanced options # For Drive search, specify more options in this field.
439 &quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
440 &quot;includeSharedDrives&quot;: True or False, # Set to true to include shared drive.
441 &quot;versionDate&quot;: &quot;A String&quot;, # Search the versions of the Drive file
442 # as of the reference date. These timestamps are in GMT and
443 # rounded down to the given date.
444 },
445 &quot;orgUnitInfo&quot;: { # Org Unit to search # When &#x27;ORG_UNIT&#x27; is chosen as as search method, org_unit_info needs
446 # to be specified.
447 &quot;orgUnitId&quot;: &quot;A String&quot;, # Org unit to search, as provided by the
448 # &lt;a href=&quot;https://developers.google.com/admin-sdk/directory/&quot;&gt;Admin SDK
449 # Directory API&lt;/a&gt;.
450 },
451 &quot;startTime&quot;: &quot;A String&quot;, # The start time range for the search query. These timestamps are in GMT and
452 # rounded down to the start of the given date.
453 &quot;terms&quot;: &quot;A String&quot;, # The corpus-specific
454 # &lt;a href=&quot;https://support.google.com/vault/answer/2474474&quot;&gt;search
455 # operators&lt;/a&gt; used to generate search results.
456 &quot;hangoutsChatOptions&quot;: { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
457 &quot;includeRooms&quot;: True or False, # Set to true to include rooms.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]458 },
459 &quot;sharedDriveInfo&quot;: { # Shared drives to search # When &#x27;SHARED_DRIVE&#x27; is chosen as search method, shared_drive_info needs
460 # to be specified.
461 &quot;sharedDriveIds&quot;: [ # List of Shared drive IDs, as provided by &lt;a
462 # href=&quot;https://developers.google.com/drive&quot;&gt;Drive API&lt;/a&gt;.
463 &quot;A String&quot;,
464 ],
465 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]466 &quot;mailOptions&quot;: { # Mail search advanced options # For mail search, specify more options in this field.
467 &quot;excludeDrafts&quot;: True or False, # Set to true to exclude drafts.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]468 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]469 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone name.
470 # It should be an IANA TZ name, such as &quot;America/Los_Angeles&quot;.
471 # For more information, see
472 # &lt;a href=&quot;https://en.wikipedia.org/wiki/List_of_tz_database_time_zones&quot;&gt;Time
473 # Zone&lt;/a&gt;.
474 &quot;corpus&quot;: &quot;A String&quot;, # The corpus to search.
475 &quot;method&quot;: &quot;A String&quot;, # The search method to use. This field is similar to the search_method field
476 # but is introduced to support shared drives. It supports all
477 # search method types. In case the search_method is TEAM_DRIVE the response
478 # of this field will be SHARED_DRIVE only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]479 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]480 &quot;displayName&quot;: &quot;A String&quot;, # Name of the saved query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]481 &quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID of the associated matter.
482 # The server does not look at this field during create and always uses matter
483 # id in the URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]484 },
485 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]486 &quot;nextPageToken&quot;: &quot;A String&quot;, # Page token to retrieve the next page of results in the list.
487 # If this is empty, then there are no more saved queries to list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]500 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]501 page. Returns None if there are no more items in the collection.
502 </pre>
503</div>
504
505</body></html>