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">Google Vault API</a> . <a href="vault_v1.matters.html">matters</a> . <a href="vault_v1.matters.exports.html">exports</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81  <code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates an export.</p>
83<p class="toc_element">
84  <code><a href="#delete">delete(matterId, exportId, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes an export.</p>
86<p class="toc_element">
87  <code><a href="#get">get(matterId, exportId, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets an export.</p>
89<p class="toc_element">
90  <code><a href="#list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Lists details about the exports in the specified matter.</p>
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">
97    <code class="details" id="close">close()</code>
98  <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
102    <code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code>
103  <pre>Creates an export.
104
105Args:
106  matterId: string, The matter ID. (required)
107  body: object, The request body.
108    The object takes the form of:
109
110{ # An export. 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;cloudStorageSink&quot;: { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
112    &quot;files&quot;: [ # Output only. The exported files in Cloud Storage.
113      { # The export file in Cloud Storage
114        &quot;bucketName&quot;: &quot;A String&quot;, # The name of the Cloud Storage bucket for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis), but not to list the bucket contents. Instead, you can [get individual export files](https://cloud.google.com/storage/docs/json_api/v1/objects/get) by object name.
115        &quot;md5Hash&quot;: &quot;A String&quot;, # The md5 hash of the file.
116        &quot;objectName&quot;: &quot;A String&quot;, # The name of the Cloud Storage object for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis).
117        &quot;size&quot;: &quot;A String&quot;, # The export file size.
118      },
119    ],
120  },
121  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the export was created.
122  &quot;exportOptions&quot;: { # Additional options for exports # Additional export options.
123    &quot;driveOptions&quot;: { # Options for Drive exports. # Options for Drive exports.
124      &quot;includeAccessInfo&quot;: True or False, # To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.
125    },
126    &quot;groupsOptions&quot;: { # Options for Groups exports. # Options for Groups exports.
127      &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
128    },
129    &quot;hangoutsChatOptions&quot;: { # Options for Chat exports. # Options for Chat exports.
130      &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
131    },
132    &quot;mailOptions&quot;: { # Options for Gmail exports. # Options for Gmail exports.
133      &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
134      &quot;showConfidentialModeContent&quot;: True or False, # To export confidential mode content, set to **true**.
135    },
136    &quot;region&quot;: &quot;A String&quot;, # The requested data region for the export.
137    &quot;voiceOptions&quot;: { # The options for Voice exports. # Options for Voice exports.
138      &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported text messages.
139    },
140  },
141  &quot;id&quot;: &quot;A String&quot;, # Output only. The generated export ID.
142  &quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID.
143  &quot;name&quot;: &quot;A String&quot;, # The export name.
144  &quot;query&quot;: { # The query definition used for search and export. # The query parameters used to create the export.
145    &quot;accountInfo&quot;: { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
146      &quot;emails&quot;: [ # A set of accounts to search.
147        &quot;A String&quot;,
148      ],
149    },
150    &quot;corpus&quot;: &quot;A String&quot;, # The Google Workspace service to search.
151    &quot;dataScope&quot;: &quot;A String&quot;, # The data source to search.
152    &quot;driveOptions&quot;: { # Additional options for Drive search # Set Drive search-specific options.
153      &quot;includeSharedDrives&quot;: True or False, # Set to **true** to include shared drives.
154      &quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
155      &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.
156    },
157    &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.
158    &quot;hangoutsChatInfo&quot;: { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
159      &quot;roomId&quot;: [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
160        &quot;A String&quot;,
161      ],
162    },
163    &quot;hangoutsChatOptions&quot;: { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
164      &quot;includeRooms&quot;: True or False, # For searches by account or organizational unit, set to **true** to include rooms.
165    },
166    &quot;mailOptions&quot;: { # Additional options for Gmail search # Set Gmail search-specific options.
167      &quot;excludeDrafts&quot;: True or False, # Set to **true** to exclude drafts.
168    },
169    &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**.
170    &quot;orgUnitInfo&quot;: { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
171      &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/).
172    },
173    &quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
174    &quot;sharedDriveInfo&quot;: { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
175      &quot;sharedDriveIds&quot;: [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
176        &quot;A String&quot;,
177      ],
178    },
179    &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.
180    &quot;teamDriveInfo&quot;: { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
181      &quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
182        &quot;A String&quot;,
183      ],
184    },
185    &quot;terms&quot;: &quot;A String&quot;, # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
186    &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).
187    &quot;voiceOptions&quot;: { # Additional options for Voice search # Set Voice search-specific options.
188      &quot;coveredData&quot;: [ # Datatypes to search
189        &quot;A String&quot;,
190      ],
191    },
192  },
193  &quot;requester&quot;: { # User&#x27;s information. # Output only. The requester of the export.
194    &quot;displayName&quot;: &quot;A String&quot;, # The displayed name of the user.
195    &quot;email&quot;: &quot;A String&quot;, # The email address of the user.
196  },
197  &quot;stats&quot;: { # Progress information for an export. # Output only. Details about the export progress and size.
198    &quot;exportedArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files already processed for export.
199    &quot;sizeInBytes&quot;: &quot;A String&quot;, # The size of export in bytes.
200    &quot;totalArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files to be exported.
201  },
202  &quot;status&quot;: &quot;A String&quot;, # Output only. The status of the export.
203}
204
205  x__xgafv: string, V1 error format.
206    Allowed values
207      1 - v1 error format
208      2 - v2 error format
209
210Returns:
211  An object of the form:
212
213    { # An export. 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.
214  &quot;cloudStorageSink&quot;: { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
215    &quot;files&quot;: [ # Output only. The exported files in Cloud Storage.
216      { # The export file in Cloud Storage
217        &quot;bucketName&quot;: &quot;A String&quot;, # The name of the Cloud Storage bucket for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis), but not to list the bucket contents. Instead, you can [get individual export files](https://cloud.google.com/storage/docs/json_api/v1/objects/get) by object name.
218        &quot;md5Hash&quot;: &quot;A String&quot;, # The md5 hash of the file.
219        &quot;objectName&quot;: &quot;A String&quot;, # The name of the Cloud Storage object for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis).
220        &quot;size&quot;: &quot;A String&quot;, # The export file size.
221      },
222    ],
223  },
224  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the export was created.
225  &quot;exportOptions&quot;: { # Additional options for exports # Additional export options.
226    &quot;driveOptions&quot;: { # Options for Drive exports. # Options for Drive exports.
227      &quot;includeAccessInfo&quot;: True or False, # To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.
228    },
229    &quot;groupsOptions&quot;: { # Options for Groups exports. # Options for Groups exports.
230      &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
231    },
232    &quot;hangoutsChatOptions&quot;: { # Options for Chat exports. # Options for Chat exports.
233      &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
234    },
235    &quot;mailOptions&quot;: { # Options for Gmail exports. # Options for Gmail exports.
236      &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
237      &quot;showConfidentialModeContent&quot;: True or False, # To export confidential mode content, set to **true**.
238    },
239    &quot;region&quot;: &quot;A String&quot;, # The requested data region for the export.
240    &quot;voiceOptions&quot;: { # The options for Voice exports. # Options for Voice exports.
241      &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported text messages.
242    },
243  },
244  &quot;id&quot;: &quot;A String&quot;, # Output only. The generated export ID.
245  &quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID.
246  &quot;name&quot;: &quot;A String&quot;, # The export name.
247  &quot;query&quot;: { # The query definition used for search and export. # The query parameters used to create the export.
248    &quot;accountInfo&quot;: { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
249      &quot;emails&quot;: [ # A set of accounts to search.
250        &quot;A String&quot;,
251      ],
252    },
253    &quot;corpus&quot;: &quot;A String&quot;, # The Google Workspace service to search.
254    &quot;dataScope&quot;: &quot;A String&quot;, # The data source to search.
255    &quot;driveOptions&quot;: { # Additional options for Drive search # Set Drive search-specific options.
256      &quot;includeSharedDrives&quot;: True or False, # Set to **true** to include shared drives.
257      &quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
258      &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.
259    },
260    &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.
261    &quot;hangoutsChatInfo&quot;: { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
262      &quot;roomId&quot;: [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
263        &quot;A String&quot;,
264      ],
265    },
266    &quot;hangoutsChatOptions&quot;: { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
267      &quot;includeRooms&quot;: True or False, # For searches by account or organizational unit, set to **true** to include rooms.
268    },
269    &quot;mailOptions&quot;: { # Additional options for Gmail search # Set Gmail search-specific options.
270      &quot;excludeDrafts&quot;: True or False, # Set to **true** to exclude drafts.
271    },
272    &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**.
273    &quot;orgUnitInfo&quot;: { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
274      &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/).
275    },
276    &quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
277    &quot;sharedDriveInfo&quot;: { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
278      &quot;sharedDriveIds&quot;: [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
279        &quot;A String&quot;,
280      ],
281    },
282    &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.
283    &quot;teamDriveInfo&quot;: { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
284      &quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
285        &quot;A String&quot;,
286      ],
287    },
288    &quot;terms&quot;: &quot;A String&quot;, # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
289    &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).
290    &quot;voiceOptions&quot;: { # Additional options for Voice search # Set Voice search-specific options.
291      &quot;coveredData&quot;: [ # Datatypes to search
292        &quot;A String&quot;,
293      ],
294    },
295  },
296  &quot;requester&quot;: { # User&#x27;s information. # Output only. The requester of the export.
297    &quot;displayName&quot;: &quot;A String&quot;, # The displayed name of the user.
298    &quot;email&quot;: &quot;A String&quot;, # The email address of the user.
299  },
300  &quot;stats&quot;: { # Progress information for an export. # Output only. Details about the export progress and size.
301    &quot;exportedArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files already processed for export.
302    &quot;sizeInBytes&quot;: &quot;A String&quot;, # The size of export in bytes.
303    &quot;totalArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files to be exported.
304  },
305  &quot;status&quot;: &quot;A String&quot;, # Output only. The status of the export.
306}</pre>
307</div>
308
309<div class="method">
310    <code class="details" id="delete">delete(matterId, exportId, x__xgafv=None)</code>
311  <pre>Deletes an export.
312
313Args:
314  matterId: string, The matter ID. (required)
315  exportId: string, The export ID. (required)
316  x__xgafv: string, V1 error format.
317    Allowed values
318      1 - v1 error format
319      2 - v2 error format
320
321Returns:
322  An object of the form:
323
324    { # 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 `{}`.
325}</pre>
326</div>
327
328<div class="method">
329    <code class="details" id="get">get(matterId, exportId, x__xgafv=None)</code>
330  <pre>Gets an export.
331
332Args:
333  matterId: string, The matter ID. (required)
334  exportId: string, The export ID. (required)
335  x__xgafv: string, V1 error format.
336    Allowed values
337      1 - v1 error format
338      2 - v2 error format
339
340Returns:
341  An object of the form:
342
343    { # An export. 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.
344  &quot;cloudStorageSink&quot;: { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
345    &quot;files&quot;: [ # Output only. The exported files in Cloud Storage.
346      { # The export file in Cloud Storage
347        &quot;bucketName&quot;: &quot;A String&quot;, # The name of the Cloud Storage bucket for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis), but not to list the bucket contents. Instead, you can [get individual export files](https://cloud.google.com/storage/docs/json_api/v1/objects/get) by object name.
348        &quot;md5Hash&quot;: &quot;A String&quot;, # The md5 hash of the file.
349        &quot;objectName&quot;: &quot;A String&quot;, # The name of the Cloud Storage object for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis).
350        &quot;size&quot;: &quot;A String&quot;, # The export file size.
351      },
352    ],
353  },
354  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the export was created.
355  &quot;exportOptions&quot;: { # Additional options for exports # Additional export options.
356    &quot;driveOptions&quot;: { # Options for Drive exports. # Options for Drive exports.
357      &quot;includeAccessInfo&quot;: True or False, # To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.
358    },
359    &quot;groupsOptions&quot;: { # Options for Groups exports. # Options for Groups exports.
360      &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
361    },
362    &quot;hangoutsChatOptions&quot;: { # Options for Chat exports. # Options for Chat exports.
363      &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
364    },
365    &quot;mailOptions&quot;: { # Options for Gmail exports. # Options for Gmail exports.
366      &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
367      &quot;showConfidentialModeContent&quot;: True or False, # To export confidential mode content, set to **true**.
368    },
369    &quot;region&quot;: &quot;A String&quot;, # The requested data region for the export.
370    &quot;voiceOptions&quot;: { # The options for Voice exports. # Options for Voice exports.
371      &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported text messages.
372    },
373  },
374  &quot;id&quot;: &quot;A String&quot;, # Output only. The generated export ID.
375  &quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID.
376  &quot;name&quot;: &quot;A String&quot;, # The export name.
377  &quot;query&quot;: { # The query definition used for search and export. # The query parameters used to create the export.
378    &quot;accountInfo&quot;: { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
379      &quot;emails&quot;: [ # A set of accounts to search.
380        &quot;A String&quot;,
381      ],
382    },
383    &quot;corpus&quot;: &quot;A String&quot;, # The Google Workspace service to search.
384    &quot;dataScope&quot;: &quot;A String&quot;, # The data source to search.
385    &quot;driveOptions&quot;: { # Additional options for Drive search # Set Drive search-specific options.
386      &quot;includeSharedDrives&quot;: True or False, # Set to **true** to include shared drives.
387      &quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
388      &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.
389    },
390    &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.
391    &quot;hangoutsChatInfo&quot;: { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
392      &quot;roomId&quot;: [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
393        &quot;A String&quot;,
394      ],
395    },
396    &quot;hangoutsChatOptions&quot;: { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
397      &quot;includeRooms&quot;: True or False, # For searches by account or organizational unit, set to **true** to include rooms.
398    },
399    &quot;mailOptions&quot;: { # Additional options for Gmail search # Set Gmail search-specific options.
400      &quot;excludeDrafts&quot;: True or False, # Set to **true** to exclude drafts.
401    },
402    &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**.
403    &quot;orgUnitInfo&quot;: { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
404      &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/).
405    },
406    &quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
407    &quot;sharedDriveInfo&quot;: { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
408      &quot;sharedDriveIds&quot;: [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
409        &quot;A String&quot;,
410      ],
411    },
412    &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.
413    &quot;teamDriveInfo&quot;: { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
414      &quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
415        &quot;A String&quot;,
416      ],
417    },
418    &quot;terms&quot;: &quot;A String&quot;, # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
419    &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).
420    &quot;voiceOptions&quot;: { # Additional options for Voice search # Set Voice search-specific options.
421      &quot;coveredData&quot;: [ # Datatypes to search
422        &quot;A String&quot;,
423      ],
424    },
425  },
426  &quot;requester&quot;: { # User&#x27;s information. # Output only. The requester of the export.
427    &quot;displayName&quot;: &quot;A String&quot;, # The displayed name of the user.
428    &quot;email&quot;: &quot;A String&quot;, # The email address of the user.
429  },
430  &quot;stats&quot;: { # Progress information for an export. # Output only. Details about the export progress and size.
431    &quot;exportedArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files already processed for export.
432    &quot;sizeInBytes&quot;: &quot;A String&quot;, # The size of export in bytes.
433    &quot;totalArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files to be exported.
434  },
435  &quot;status&quot;: &quot;A String&quot;, # Output only. The status of the export.
436}</pre>
437</div>
438
439<div class="method">
440    <code class="details" id="list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</code>
441  <pre>Lists details about the exports in the specified matter.
442
443Args:
444  matterId: string, The matter ID. (required)
445  pageSize: integer, The number of exports to return in the response.
446  pageToken: string, The pagination token as returned in the response.
447  x__xgafv: string, V1 error format.
448    Allowed values
449      1 - v1 error format
450      2 - v2 error format
451
452Returns:
453  An object of the form:
454
455    { # The exports for a matter.
456  &quot;exports&quot;: [ # The list of exports.
457    { # An export. 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.
458      &quot;cloudStorageSink&quot;: { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
459        &quot;files&quot;: [ # Output only. The exported files in Cloud Storage.
460          { # The export file in Cloud Storage
461            &quot;bucketName&quot;: &quot;A String&quot;, # The name of the Cloud Storage bucket for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis), but not to list the bucket contents. Instead, you can [get individual export files](https://cloud.google.com/storage/docs/json_api/v1/objects/get) by object name.
462            &quot;md5Hash&quot;: &quot;A String&quot;, # The md5 hash of the file.
463            &quot;objectName&quot;: &quot;A String&quot;, # The name of the Cloud Storage object for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis).
464            &quot;size&quot;: &quot;A String&quot;, # The export file size.
465          },
466        ],
467      },
468      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the export was created.
469      &quot;exportOptions&quot;: { # Additional options for exports # Additional export options.
470        &quot;driveOptions&quot;: { # Options for Drive exports. # Options for Drive exports.
471          &quot;includeAccessInfo&quot;: True or False, # To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.
472        },
473        &quot;groupsOptions&quot;: { # Options for Groups exports. # Options for Groups exports.
474          &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
475        },
476        &quot;hangoutsChatOptions&quot;: { # Options for Chat exports. # Options for Chat exports.
477          &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
478        },
479        &quot;mailOptions&quot;: { # Options for Gmail exports. # Options for Gmail exports.
480          &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported messages.
481          &quot;showConfidentialModeContent&quot;: True or False, # To export confidential mode content, set to **true**.
482        },
483        &quot;region&quot;: &quot;A String&quot;, # The requested data region for the export.
484        &quot;voiceOptions&quot;: { # The options for Voice exports. # Options for Voice exports.
485          &quot;exportFormat&quot;: &quot;A String&quot;, # The file format for exported text messages.
486        },
487      },
488      &quot;id&quot;: &quot;A String&quot;, # Output only. The generated export ID.
489      &quot;matterId&quot;: &quot;A String&quot;, # Output only. The matter ID.
490      &quot;name&quot;: &quot;A String&quot;, # The export name.
491      &quot;query&quot;: { # The query definition used for search and export. # The query parameters used to create the export.
492        &quot;accountInfo&quot;: { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
493          &quot;emails&quot;: [ # A set of accounts to search.
494            &quot;A String&quot;,
495          ],
496        },
497        &quot;corpus&quot;: &quot;A String&quot;, # The Google Workspace service to search.
498        &quot;dataScope&quot;: &quot;A String&quot;, # The data source to search.
499        &quot;driveOptions&quot;: { # Additional options for Drive search # Set Drive search-specific options.
500          &quot;includeSharedDrives&quot;: True or False, # Set to **true** to include shared drives.
501          &quot;includeTeamDrives&quot;: True or False, # Set to true to include Team Drive.
502          &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.
503        },
504        &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.
505        &quot;hangoutsChatInfo&quot;: { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
506          &quot;roomId&quot;: [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
507            &quot;A String&quot;,
508          ],
509        },
510        &quot;hangoutsChatOptions&quot;: { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
511          &quot;includeRooms&quot;: True or False, # For searches by account or organizational unit, set to **true** to include rooms.
512        },
513        &quot;mailOptions&quot;: { # Additional options for Gmail search # Set Gmail search-specific options.
514          &quot;excludeDrafts&quot;: True or False, # Set to **true** to exclude drafts.
515        },
516        &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**.
517        &quot;orgUnitInfo&quot;: { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
518          &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/).
519        },
520        &quot;searchMethod&quot;: &quot;A String&quot;, # The search method to use.
521        &quot;sharedDriveInfo&quot;: { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
522          &quot;sharedDriveIds&quot;: [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
523            &quot;A String&quot;,
524          ],
525        },
526        &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.
527        &quot;teamDriveInfo&quot;: { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
528          &quot;teamDriveIds&quot;: [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
529            &quot;A String&quot;,
530          ],
531        },
532        &quot;terms&quot;: &quot;A String&quot;, # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
533        &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).
534        &quot;voiceOptions&quot;: { # Additional options for Voice search # Set Voice search-specific options.
535          &quot;coveredData&quot;: [ # Datatypes to search
536            &quot;A String&quot;,
537          ],
538        },
539      },
540      &quot;requester&quot;: { # User&#x27;s information. # Output only. The requester of the export.
541        &quot;displayName&quot;: &quot;A String&quot;, # The displayed name of the user.
542        &quot;email&quot;: &quot;A String&quot;, # The email address of the user.
543      },
544      &quot;stats&quot;: { # Progress information for an export. # Output only. Details about the export progress and size.
545        &quot;exportedArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files already processed for export.
546        &quot;sizeInBytes&quot;: &quot;A String&quot;, # The size of export in bytes.
547        &quot;totalArtifactCount&quot;: &quot;A String&quot;, # The number of messages or files to be exported.
548      },
549      &quot;status&quot;: &quot;A String&quot;, # Output only. The status of the export.
550    },
551  ],
552  &quot;nextPageToken&quot;: &quot;A String&quot;, # Page token to retrieve the next page of results in the list.
553}</pre>
554</div>
555
556<div class="method">
557    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
558  <pre>Retrieves the next page of results.
559
560Args:
561  previous_request: The request for the previous page. (required)
562  previous_response: The response from the request for the previous page. (required)
563
564Returns:
565  A request object that you can call &#x27;execute()&#x27; on to request the next
566  page. Returns None if there are no more items in the collection.
567    </pre>
568</div>
569
570</body></html>