Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / vault_v1.matters.savedQueries.html
blob: 14e0b90858094469c72e3ab3fdc1ed3da5088cc8 [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
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700[diff] [blame]75<h1><a href="vault_v1.html">Google Vault API</a> . <a href="vault_v1.matters.html">matters</a> . <a href="vault_v1.matters.savedQueries.html">savedQueries</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <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]82<p class="firstline">Creates a saved query.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(matterId, savedQueryId, x__xgafv=None)</a></code></p>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]85<p class="firstline">Deletes the specified saved query.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(matterId, savedQueryId, x__xgafv=None)</a></code></p>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]88<p class="firstline">Retrieves the specified saved query.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]90 <code><a href="#list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]91<p class="firstline">Lists the saved queries in a matter.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 <code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 <pre>Creates a saved query.
104
105Args:
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]106 matterId: string, The ID of the matter to create the saved query in. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]107 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 The object takes the form of:
109
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]110{ # The definition of a saved query. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
111 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The server-generated timestamp when the saved query was created.
112 &quot;displayName&quot;: &quot;A String&quot;, # The name of the saved query.
113 &quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL.
114 &quot;query&quot;: { # The query definition used for search and export. # The search parameters of the saved query.
115 &quot;accountInfo&quot;: { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]116 &quot;emails&quot;: [ # A set of accounts to search.
117 &quot;A String&quot;,
118 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]120 &quot;corpus&quot;: &quot;A String&quot;, # The Google Workspace service to search.
121 &quot;dataScope&quot;: &quot;A String&quot;, # The data source to search.
122 &quot;driveOptions&quot;: { # Additional options for Drive search # Set Drive search-specific options.
123 &quot;includeSharedDrives&quot;: True or False, # Set to **true** to include shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]124 &quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]125 &quot;versionDate&quot;: &quot;A String&quot;, # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]126 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]127 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
128 &quot;hangoutsChatInfo&quot;: { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
129 &quot;roomId&quot;: [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]130 &quot;A String&quot;,
131 ],
132 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]133 &quot;hangoutsChatOptions&quot;: { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
134 &quot;includeRooms&quot;: True or False, # For searches by account or organizational unit, set to **true** to include rooms.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]135 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]136 &quot;mailOptions&quot;: { # Additional options for Gmail search # Set Gmail search-specific options.
137 &quot;excludeDrafts&quot;: True or False, # Set to **true** to exclude drafts.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]138 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]139 &quot;method&quot;: &quot;A String&quot;, # The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**.
140 &quot;orgUnitInfo&quot;: { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
141 &quot;orgUnitId&quot;: &quot;A String&quot;, # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]142 },
143 &quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]144 &quot;sharedDriveInfo&quot;: { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
145 &quot;sharedDriveIds&quot;: [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]146 &quot;A String&quot;,
147 ],
148 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]149 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
150 &quot;teamDriveInfo&quot;: { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
151 &quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]152 &quot;A String&quot;,
153 ],
154 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]155 &quot;terms&quot;: &quot;A String&quot;, # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
156 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone name. It should be an IANA TZ name, such as &quot;America/Los_Angeles&quot;. For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time).
157 &quot;voiceOptions&quot;: { # Additional options for Voice search # Set Voice search-specific options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]158 &quot;coveredData&quot;: [ # Datatypes to search
159 &quot;A String&quot;,
160 ],
161 },
162 },
163 &quot;savedQueryId&quot;: &quot;A String&quot;, # A unique identifier for the saved query.
164}
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]165
166 x__xgafv: string, V1 error format.
167 Allowed values
168 1 - v1 error format
169 2 - v2 error format
170
171Returns:
172 An object of the form:
173
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]174 { # The definition of a saved query. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
175 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The server-generated timestamp when the saved query was created.
176 &quot;displayName&quot;: &quot;A String&quot;, # The name of the saved query.
177 &quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL.
178 &quot;query&quot;: { # The query definition used for search and export. # The search parameters of the saved query.
179 &quot;accountInfo&quot;: { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]180 &quot;emails&quot;: [ # A set of accounts to search.
181 &quot;A String&quot;,
182 ],
183 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]184 &quot;corpus&quot;: &quot;A String&quot;, # The Google Workspace service to search.
185 &quot;dataScope&quot;: &quot;A String&quot;, # The data source to search.
186 &quot;driveOptions&quot;: { # Additional options for Drive search # Set Drive search-specific options.
187 &quot;includeSharedDrives&quot;: True or False, # Set to **true** to include shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]188 &quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]189 &quot;versionDate&quot;: &quot;A String&quot;, # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]190 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]191 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
192 &quot;hangoutsChatInfo&quot;: { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
193 &quot;roomId&quot;: [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]194 &quot;A String&quot;,
195 ],
196 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]197 &quot;hangoutsChatOptions&quot;: { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
198 &quot;includeRooms&quot;: True or False, # For searches by account or organizational unit, set to **true** to include rooms.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]199 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]200 &quot;mailOptions&quot;: { # Additional options for Gmail search # Set Gmail search-specific options.
201 &quot;excludeDrafts&quot;: True or False, # Set to **true** to exclude drafts.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]202 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]203 &quot;method&quot;: &quot;A String&quot;, # The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**.
204 &quot;orgUnitInfo&quot;: { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
205 &quot;orgUnitId&quot;: &quot;A String&quot;, # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]206 },
207 &quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]208 &quot;sharedDriveInfo&quot;: { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
209 &quot;sharedDriveIds&quot;: [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]210 &quot;A String&quot;,
211 ],
212 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]213 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
214 &quot;teamDriveInfo&quot;: { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
215 &quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]216 &quot;A String&quot;,
217 ],
218 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]219 &quot;terms&quot;: &quot;A String&quot;, # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
220 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone name. It should be an IANA TZ name, such as &quot;America/Los_Angeles&quot;. For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time).
221 &quot;voiceOptions&quot;: { # Additional options for Voice search # Set Voice search-specific options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]222 &quot;coveredData&quot;: [ # Datatypes to search
223 &quot;A String&quot;,
224 ],
225 },
226 },
227 &quot;savedQueryId&quot;: &quot;A String&quot;, # A unique identifier for the saved query.
228}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229</div>
230
231<div class="method">
232 <code class="details" id="delete">delete(matterId, savedQueryId, x__xgafv=None)</code>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]233 <pre>Deletes the specified saved query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234
235Args:
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]236 matterId: string, The ID of the matter to delete the saved query from. (required)
237 savedQueryId: string, ID of the saved query to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]238 x__xgafv: string, V1 error format.
239 Allowed values
240 1 - v1 error format
241 2 - v2 error format
242
243Returns:
244 An object of the form:
245
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]246 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]247}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248</div>
249
250<div class="method">
251 <code class="details" id="get">get(matterId, savedQueryId, x__xgafv=None)</code>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]252 <pre>Retrieves the specified saved query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]253
254Args:
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]255 matterId: string, The ID of the matter to get the saved query from. (required)
256 savedQueryId: string, ID of the saved query to retrieve. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]257 x__xgafv: string, V1 error format.
258 Allowed values
259 1 - v1 error format
260 2 - v2 error format
261
262Returns:
263 An object of the form:
264
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]265 { # The definition of a saved query. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
266 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The server-generated timestamp when the saved query was created.
267 &quot;displayName&quot;: &quot;A String&quot;, # The name of the saved query.
268 &quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL.
269 &quot;query&quot;: { # The query definition used for search and export. # The search parameters of the saved query.
270 &quot;accountInfo&quot;: { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]271 &quot;emails&quot;: [ # A set of accounts to search.
272 &quot;A String&quot;,
273 ],
274 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]275 &quot;corpus&quot;: &quot;A String&quot;, # The Google Workspace service to search.
276 &quot;dataScope&quot;: &quot;A String&quot;, # The data source to search.
277 &quot;driveOptions&quot;: { # Additional options for Drive search # Set Drive search-specific options.
278 &quot;includeSharedDrives&quot;: True or False, # Set to **true** to include shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]279 &quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]280 &quot;versionDate&quot;: &quot;A String&quot;, # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]281 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]282 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
283 &quot;hangoutsChatInfo&quot;: { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
284 &quot;roomId&quot;: [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]285 &quot;A String&quot;,
286 ],
287 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]288 &quot;hangoutsChatOptions&quot;: { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
289 &quot;includeRooms&quot;: True or False, # For searches by account or organizational unit, set to **true** to include rooms.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]290 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]291 &quot;mailOptions&quot;: { # Additional options for Gmail search # Set Gmail search-specific options.
292 &quot;excludeDrafts&quot;: True or False, # Set to **true** to exclude drafts.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]293 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]294 &quot;method&quot;: &quot;A String&quot;, # The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**.
295 &quot;orgUnitInfo&quot;: { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
296 &quot;orgUnitId&quot;: &quot;A String&quot;, # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]297 },
298 &quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]299 &quot;sharedDriveInfo&quot;: { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
300 &quot;sharedDriveIds&quot;: [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]301 &quot;A String&quot;,
302 ],
303 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]304 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
305 &quot;teamDriveInfo&quot;: { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
306 &quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]307 &quot;A String&quot;,
308 ],
309 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]310 &quot;terms&quot;: &quot;A String&quot;, # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
311 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone name. It should be an IANA TZ name, such as &quot;America/Los_Angeles&quot;. For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time).
312 &quot;voiceOptions&quot;: { # Additional options for Voice search # Set Voice search-specific options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]313 &quot;coveredData&quot;: [ # Datatypes to search
314 &quot;A String&quot;,
315 ],
316 },
317 },
318 &quot;savedQueryId&quot;: &quot;A String&quot;, # A unique identifier for the saved query.
319}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320</div>
321
322<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]323 <code class="details" id="list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</code>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]324 <pre>Lists the saved queries in a matter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]325
326Args:
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]327 matterId: string, The ID of the matter to get the saved queries for. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]328 pageSize: integer, The maximum number of saved queries to return.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]329 pageToken: string, The pagination token as returned in the previous response. An empty token means start from the beginning.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]330 x__xgafv: string, V1 error format.
331 Allowed values
332 1 - v1 error format
333 2 - v2 error format
334
335Returns:
336 An object of the form:
337
338 { # Definition of the response for method ListSaveQuery.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]339 &quot;nextPageToken&quot;: &quot;A String&quot;, # Page token to retrieve the next page of results in the list. If this is empty, then there are no more saved queries to list.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]340 &quot;savedQueries&quot;: [ # List of saved queries.
341 { # The definition of a saved query. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
342 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The server-generated timestamp when the saved query was created.
343 &quot;displayName&quot;: &quot;A String&quot;, # The name of the saved query.
344 &quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL.
345 &quot;query&quot;: { # The query definition used for search and export. # The search parameters of the saved query.
346 &quot;accountInfo&quot;: { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]347 &quot;emails&quot;: [ # A set of accounts to search.
348 &quot;A String&quot;,
349 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]350 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]351 &quot;corpus&quot;: &quot;A String&quot;, # The Google Workspace service to search.
352 &quot;dataScope&quot;: &quot;A String&quot;, # The data source to search.
353 &quot;driveOptions&quot;: { # Additional options for Drive search # Set Drive search-specific options.
354 &quot;includeSharedDrives&quot;: True or False, # Set to **true** to include shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]355 &quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]356 &quot;versionDate&quot;: &quot;A String&quot;, # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]357 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]358 &quot;endTime&quot;: &quot;A String&quot;, # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
359 &quot;hangoutsChatInfo&quot;: { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
360 &quot;roomId&quot;: [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]361 &quot;A String&quot;,
362 ],
363 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]364 &quot;hangoutsChatOptions&quot;: { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
365 &quot;includeRooms&quot;: True or False, # For searches by account or organizational unit, set to **true** to include rooms.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]366 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]367 &quot;mailOptions&quot;: { # Additional options for Gmail search # Set Gmail search-specific options.
368 &quot;excludeDrafts&quot;: True or False, # Set to **true** to exclude drafts.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]369 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]370 &quot;method&quot;: &quot;A String&quot;, # The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**.
371 &quot;orgUnitInfo&quot;: { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
372 &quot;orgUnitId&quot;: &quot;A String&quot;, # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]373 },
374 &quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]375 &quot;sharedDriveInfo&quot;: { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
376 &quot;sharedDriveIds&quot;: [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]377 &quot;A String&quot;,
378 ],
379 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]380 &quot;startTime&quot;: &quot;A String&quot;, # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
381 &quot;teamDriveInfo&quot;: { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
382 &quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]383 &quot;A String&quot;,
384 ],
385 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]386 &quot;terms&quot;: &quot;A String&quot;, # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
387 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone name. It should be an IANA TZ name, such as &quot;America/Los_Angeles&quot;. For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time).
388 &quot;voiceOptions&quot;: { # Additional options for Voice search # Set Voice search-specific options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]389 &quot;coveredData&quot;: [ # Datatypes to search
390 &quot;A String&quot;,
391 ],
392 },
393 },
394 &quot;savedQueryId&quot;: &quot;A String&quot;, # A unique identifier for the saved query.
395 },
396 ],
397}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]398</div>
399
400<div class="method">
401 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
402 <pre>Retrieves the next page of results.
403
404Args:
405 previous_request: The request for the previous page. (required)
406 previous_response: The response from the request for the previous page. (required)
407
408Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]409 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]410 page. Returns None if there are no more items in the collection.
411 </pre>
412</div>
413
414</body></html>