1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an export.</p>
<p class="toc_element">
<code><a href="#delete">delete(matterId, exportId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an export.</p>
<p class="toc_element">
<code><a href="#get">get(matterId, exportId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an export.</p>
<p class="toc_element">
<code><a href="#list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists details about the exports in the specified matter.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code>
<pre>Creates an export.
Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:
{ # 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.
"cloudStorageSink": { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
"files": [ # Output only. The exported files in Cloud Storage.
{ # The export file in Cloud Storage
"bucketName": "A String", # The name of the Cloud Storage bucket for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api), 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.
"md5Hash": "A String", # The md5 hash of the file.
"objectName": "A String", # The name of the Cloud Storage object for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api).
"size": "A String", # The export file size.
},
],
},
"createTime": "A String", # Output only. The time when the export was created.
"exportOptions": { # Additional options for exports # Additional export options.
"calendarOptions": { # The options for Calendar exports. # Option available for Calendar export.
"exportFormat": "A String", # The file format for exported text messages.
},
"driveOptions": { # Options for Drive exports. # Options for Drive exports.
"includeAccessInfo": 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**.
},
"geminiOptions": { # The options for Gemini exports. # Option available for Gemini export.
"exportFormat": "A String", # The file format for exported messages.
},
"groupsOptions": { # Options for Groups exports. # Options for Groups exports.
"exportFormat": "A String", # The file format for exported messages.
},
"hangoutsChatOptions": { # Options for Chat exports. # Options for Chat exports.
"exportFormat": "A String", # The file format for exported messages.
},
"mailOptions": { # Options for Gmail exports. # Options for Gmail exports.
"exportFormat": "A String", # The file format for exported messages.
"exportLinkedDriveFiles": True or False, # Optional. To enable exporting linked Drive files, set to **true**.
"showConfidentialModeContent": True or False, # To export confidential mode content, set to **true**.
"useNewExport": True or False, # To use the new export system, set to **true**.
},
"region": "A String", # The requested data region for the export.
"voiceOptions": { # The options for Voice exports. # Options for Voice exports.
"exportFormat": "A String", # The file format for exported text messages.
},
},
"id": "A String", # Output only. The generated export ID.
"matterId": "A String", # Output only. The matter ID.
"name": "A String", # The export name. Don't use special characters (~!$'(),;@:/?) in the name, they can prevent you from downloading exports.
"parentExportId": "A String", # Output only. Identifies the parent export that spawned this child export. This is only set on child exports.
"query": { # The query definition used for search and export. # The query parameters used to create the export.
"accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
"emails": [ # A set of accounts to search.
"A String",
],
},
"calendarOptions": { # Additional options for Calendar search # Set Calendar search-specific options.
"locationQuery": [ # Matches only those events whose location contains all of the words in the given set. If the string contains quoted phrases, this method only matches those events whose location contain the exact phrase. Entries in the set are considered in "and". Word splitting example: ["New Zealand"] vs ["New","Zealand"] "New Zealand": matched by both "New and better Zealand": only matched by the later
"A String",
],
"minusWords": [ # Matches only those events that do not contain any of the words in the given set in title, description, location, or attendees. Entries in the set are considered in "or".
"A String",
],
"peopleQuery": [ # Matches only those events whose attendees contain all of the words in the given set. Entries in the set are considered in "and".
"A String",
],
"responseStatuses": [ # Matches only events for which the custodian gave one of these responses. If the set is empty or contains ATTENDEE_RESPONSE_UNSPECIFIED there will be no filtering on responses.
"A String",
],
"versionDate": "A String", # Search the current version of the Calendar event, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
},
"corpus": "A String", # The Google Workspace service to search.
"dataScope": "A String", # The data source to search.
"driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**.
"documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID.
"ids": [ # Required. A list of Drive document IDs.
"A String",
],
},
},
"driveOptions": { # Additional options for Drive search. # Set Drive search-specific options.
"clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive.
"includeSharedDrives": True or False, # Set to **true** to include shared drives.
"includeTeamDrives": True or False, # Set to true to include Team Drive.
"sharedDrivesOption": "A String", # Optional. Options to include or exclude documents in shared drives. We recommend using this field over include_shared_drives. This field overrides include_shared_drives and include_team_drives when set.
"versionDate": "A String", # 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.
},
"endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
"geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options.
},
"hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
"roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/workspace/chat). There is a limit of exporting from 500 Chat spaces per request.
"A String",
],
},
"hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
"includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms.
},
"mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options.
"clientSideEncryptedOption": "A String", # Specifies whether the results should include encrypted content, unencrypted content, or both. Defaults to including both.
"excludeDrafts": True or False, # Set to **true** to exclude drafts.
},
"method": "A String", # 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**.
"orgUnitInfo": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
"orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
},
"searchMethod": "A String", # The search method to use.
"sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
"sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
"A String",
],
},
"sitesUrlInfo": { # The published site URLs of new Google Sites to search # Required when **SearchMethod** is **SITES_URL**.
"urls": [ # A list of published site URLs.
"A String",
],
},
"startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
"teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
"teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
"A String",
],
},
"terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
"timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". 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).
"voiceOptions": { # Additional options for Voice search # Set Voice search-specific options.
"coveredData": [ # Datatypes to search
"A String",
],
},
},
"requester": { # User's information. # Output only. The requester of the export.
"displayName": "A String", # The displayed name of the user.
"email": "A String", # The email address of the user.
},
"stats": { # Progress information for an export. # Output only. Details about the export progress and size.
"exportedArtifactCount": "A String", # The number of messages or files already processed for export.
"sizeInBytes": "A String", # The size of export in bytes.
"totalArtifactCount": "A String", # The number of messages or files to be exported.
},
"status": "A String", # Output only. The status of the export.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
"cloudStorageSink": { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
"files": [ # Output only. The exported files in Cloud Storage.
{ # The export file in Cloud Storage
"bucketName": "A String", # The name of the Cloud Storage bucket for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api), 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.
"md5Hash": "A String", # The md5 hash of the file.
"objectName": "A String", # The name of the Cloud Storage object for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api).
"size": "A String", # The export file size.
},
],
},
"createTime": "A String", # Output only. The time when the export was created.
"exportOptions": { # Additional options for exports # Additional export options.
"calendarOptions": { # The options for Calendar exports. # Option available for Calendar export.
"exportFormat": "A String", # The file format for exported text messages.
},
"driveOptions": { # Options for Drive exports. # Options for Drive exports.
"includeAccessInfo": 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**.
},
"geminiOptions": { # The options for Gemini exports. # Option available for Gemini export.
"exportFormat": "A String", # The file format for exported messages.
},
"groupsOptions": { # Options for Groups exports. # Options for Groups exports.
"exportFormat": "A String", # The file format for exported messages.
},
"hangoutsChatOptions": { # Options for Chat exports. # Options for Chat exports.
"exportFormat": "A String", # The file format for exported messages.
},
"mailOptions": { # Options for Gmail exports. # Options for Gmail exports.
"exportFormat": "A String", # The file format for exported messages.
"exportLinkedDriveFiles": True or False, # Optional. To enable exporting linked Drive files, set to **true**.
"showConfidentialModeContent": True or False, # To export confidential mode content, set to **true**.
"useNewExport": True or False, # To use the new export system, set to **true**.
},
"region": "A String", # The requested data region for the export.
"voiceOptions": { # The options for Voice exports. # Options for Voice exports.
"exportFormat": "A String", # The file format for exported text messages.
},
},
"id": "A String", # Output only. The generated export ID.
"matterId": "A String", # Output only. The matter ID.
"name": "A String", # The export name. Don't use special characters (~!$'(),;@:/?) in the name, they can prevent you from downloading exports.
"parentExportId": "A String", # Output only. Identifies the parent export that spawned this child export. This is only set on child exports.
"query": { # The query definition used for search and export. # The query parameters used to create the export.
"accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
"emails": [ # A set of accounts to search.
"A String",
],
},
"calendarOptions": { # Additional options for Calendar search # Set Calendar search-specific options.
"locationQuery": [ # Matches only those events whose location contains all of the words in the given set. If the string contains quoted phrases, this method only matches those events whose location contain the exact phrase. Entries in the set are considered in "and". Word splitting example: ["New Zealand"] vs ["New","Zealand"] "New Zealand": matched by both "New and better Zealand": only matched by the later
"A String",
],
"minusWords": [ # Matches only those events that do not contain any of the words in the given set in title, description, location, or attendees. Entries in the set are considered in "or".
"A String",
],
"peopleQuery": [ # Matches only those events whose attendees contain all of the words in the given set. Entries in the set are considered in "and".
"A String",
],
"responseStatuses": [ # Matches only events for which the custodian gave one of these responses. If the set is empty or contains ATTENDEE_RESPONSE_UNSPECIFIED there will be no filtering on responses.
"A String",
],
"versionDate": "A String", # Search the current version of the Calendar event, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
},
"corpus": "A String", # The Google Workspace service to search.
"dataScope": "A String", # The data source to search.
"driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**.
"documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID.
"ids": [ # Required. A list of Drive document IDs.
"A String",
],
},
},
"driveOptions": { # Additional options for Drive search. # Set Drive search-specific options.
"clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive.
"includeSharedDrives": True or False, # Set to **true** to include shared drives.
"includeTeamDrives": True or False, # Set to true to include Team Drive.
"sharedDrivesOption": "A String", # Optional. Options to include or exclude documents in shared drives. We recommend using this field over include_shared_drives. This field overrides include_shared_drives and include_team_drives when set.
"versionDate": "A String", # 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.
},
"endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
"geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options.
},
"hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
"roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/workspace/chat). There is a limit of exporting from 500 Chat spaces per request.
"A String",
],
},
"hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
"includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms.
},
"mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options.
"clientSideEncryptedOption": "A String", # Specifies whether the results should include encrypted content, unencrypted content, or both. Defaults to including both.
"excludeDrafts": True or False, # Set to **true** to exclude drafts.
},
"method": "A String", # 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**.
"orgUnitInfo": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
"orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
},
"searchMethod": "A String", # The search method to use.
"sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
"sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
"A String",
],
},
"sitesUrlInfo": { # The published site URLs of new Google Sites to search # Required when **SearchMethod** is **SITES_URL**.
"urls": [ # A list of published site URLs.
"A String",
],
},
"startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
"teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
"teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
"A String",
],
},
"terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
"timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". 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).
"voiceOptions": { # Additional options for Voice search # Set Voice search-specific options.
"coveredData": [ # Datatypes to search
"A String",
],
},
},
"requester": { # User's information. # Output only. The requester of the export.
"displayName": "A String", # The displayed name of the user.
"email": "A String", # The email address of the user.
},
"stats": { # Progress information for an export. # Output only. Details about the export progress and size.
"exportedArtifactCount": "A String", # The number of messages or files already processed for export.
"sizeInBytes": "A String", # The size of export in bytes.
"totalArtifactCount": "A String", # The number of messages or files to be exported.
},
"status": "A String", # Output only. The status of the export.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(matterId, exportId, x__xgafv=None)</code>
<pre>Deletes an export.
Args:
matterId: string, The matter ID. (required)
exportId: string, The export ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(matterId, exportId, x__xgafv=None)</code>
<pre>Gets an export.
Args:
matterId: string, The matter ID. (required)
exportId: string, The export ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
"cloudStorageSink": { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
"files": [ # Output only. The exported files in Cloud Storage.
{ # The export file in Cloud Storage
"bucketName": "A String", # The name of the Cloud Storage bucket for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api), 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.
"md5Hash": "A String", # The md5 hash of the file.
"objectName": "A String", # The name of the Cloud Storage object for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api).
"size": "A String", # The export file size.
},
],
},
"createTime": "A String", # Output only. The time when the export was created.
"exportOptions": { # Additional options for exports # Additional export options.
"calendarOptions": { # The options for Calendar exports. # Option available for Calendar export.
"exportFormat": "A String", # The file format for exported text messages.
},
"driveOptions": { # Options for Drive exports. # Options for Drive exports.
"includeAccessInfo": 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**.
},
"geminiOptions": { # The options for Gemini exports. # Option available for Gemini export.
"exportFormat": "A String", # The file format for exported messages.
},
"groupsOptions": { # Options for Groups exports. # Options for Groups exports.
"exportFormat": "A String", # The file format for exported messages.
},
"hangoutsChatOptions": { # Options for Chat exports. # Options for Chat exports.
"exportFormat": "A String", # The file format for exported messages.
},
"mailOptions": { # Options for Gmail exports. # Options for Gmail exports.
"exportFormat": "A String", # The file format for exported messages.
"exportLinkedDriveFiles": True or False, # Optional. To enable exporting linked Drive files, set to **true**.
"showConfidentialModeContent": True or False, # To export confidential mode content, set to **true**.
"useNewExport": True or False, # To use the new export system, set to **true**.
},
"region": "A String", # The requested data region for the export.
"voiceOptions": { # The options for Voice exports. # Options for Voice exports.
"exportFormat": "A String", # The file format for exported text messages.
},
},
"id": "A String", # Output only. The generated export ID.
"matterId": "A String", # Output only. The matter ID.
"name": "A String", # The export name. Don't use special characters (~!$'(),;@:/?) in the name, they can prevent you from downloading exports.
"parentExportId": "A String", # Output only. Identifies the parent export that spawned this child export. This is only set on child exports.
"query": { # The query definition used for search and export. # The query parameters used to create the export.
"accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
"emails": [ # A set of accounts to search.
"A String",
],
},
"calendarOptions": { # Additional options for Calendar search # Set Calendar search-specific options.
"locationQuery": [ # Matches only those events whose location contains all of the words in the given set. If the string contains quoted phrases, this method only matches those events whose location contain the exact phrase. Entries in the set are considered in "and". Word splitting example: ["New Zealand"] vs ["New","Zealand"] "New Zealand": matched by both "New and better Zealand": only matched by the later
"A String",
],
"minusWords": [ # Matches only those events that do not contain any of the words in the given set in title, description, location, or attendees. Entries in the set are considered in "or".
"A String",
],
"peopleQuery": [ # Matches only those events whose attendees contain all of the words in the given set. Entries in the set are considered in "and".
"A String",
],
"responseStatuses": [ # Matches only events for which the custodian gave one of these responses. If the set is empty or contains ATTENDEE_RESPONSE_UNSPECIFIED there will be no filtering on responses.
"A String",
],
"versionDate": "A String", # Search the current version of the Calendar event, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
},
"corpus": "A String", # The Google Workspace service to search.
"dataScope": "A String", # The data source to search.
"driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**.
"documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID.
"ids": [ # Required. A list of Drive document IDs.
"A String",
],
},
},
"driveOptions": { # Additional options for Drive search. # Set Drive search-specific options.
"clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive.
"includeSharedDrives": True or False, # Set to **true** to include shared drives.
"includeTeamDrives": True or False, # Set to true to include Team Drive.
"sharedDrivesOption": "A String", # Optional. Options to include or exclude documents in shared drives. We recommend using this field over include_shared_drives. This field overrides include_shared_drives and include_team_drives when set.
"versionDate": "A String", # 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.
},
"endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
"geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options.
},
"hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
"roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/workspace/chat). There is a limit of exporting from 500 Chat spaces per request.
"A String",
],
},
"hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
"includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms.
},
"mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options.
"clientSideEncryptedOption": "A String", # Specifies whether the results should include encrypted content, unencrypted content, or both. Defaults to including both.
"excludeDrafts": True or False, # Set to **true** to exclude drafts.
},
"method": "A String", # 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**.
"orgUnitInfo": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
"orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
},
"searchMethod": "A String", # The search method to use.
"sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
"sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
"A String",
],
},
"sitesUrlInfo": { # The published site URLs of new Google Sites to search # Required when **SearchMethod** is **SITES_URL**.
"urls": [ # A list of published site URLs.
"A String",
],
},
"startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
"teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
"teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
"A String",
],
},
"terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
"timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". 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).
"voiceOptions": { # Additional options for Voice search # Set Voice search-specific options.
"coveredData": [ # Datatypes to search
"A String",
],
},
},
"requester": { # User's information. # Output only. The requester of the export.
"displayName": "A String", # The displayed name of the user.
"email": "A String", # The email address of the user.
},
"stats": { # Progress information for an export. # Output only. Details about the export progress and size.
"exportedArtifactCount": "A String", # The number of messages or files already processed for export.
"sizeInBytes": "A String", # The size of export in bytes.
"totalArtifactCount": "A String", # The number of messages or files to be exported.
},
"status": "A String", # Output only. The status of the export.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists details about the exports in the specified matter.
Args:
matterId: string, The matter ID. (required)
pageSize: integer, The number of exports to return in the response.
pageToken: string, The pagination token as returned in the response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The exports for a matter.
"exports": [ # The list of exports.
{ # 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.
"cloudStorageSink": { # Export sink for Cloud Storage files. # Output only. The sink for export files in Cloud Storage.
"files": [ # Output only. The exported files in Cloud Storage.
{ # The export file in Cloud Storage
"bucketName": "A String", # The name of the Cloud Storage bucket for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api), 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.
"md5Hash": "A String", # The md5 hash of the file.
"objectName": "A String", # The name of the Cloud Storage object for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api).
"size": "A String", # The export file size.
},
],
},
"createTime": "A String", # Output only. The time when the export was created.
"exportOptions": { # Additional options for exports # Additional export options.
"calendarOptions": { # The options for Calendar exports. # Option available for Calendar export.
"exportFormat": "A String", # The file format for exported text messages.
},
"driveOptions": { # Options for Drive exports. # Options for Drive exports.
"includeAccessInfo": 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**.
},
"geminiOptions": { # The options for Gemini exports. # Option available for Gemini export.
"exportFormat": "A String", # The file format for exported messages.
},
"groupsOptions": { # Options for Groups exports. # Options for Groups exports.
"exportFormat": "A String", # The file format for exported messages.
},
"hangoutsChatOptions": { # Options for Chat exports. # Options for Chat exports.
"exportFormat": "A String", # The file format for exported messages.
},
"mailOptions": { # Options for Gmail exports. # Options for Gmail exports.
"exportFormat": "A String", # The file format for exported messages.
"exportLinkedDriveFiles": True or False, # Optional. To enable exporting linked Drive files, set to **true**.
"showConfidentialModeContent": True or False, # To export confidential mode content, set to **true**.
"useNewExport": True or False, # To use the new export system, set to **true**.
},
"region": "A String", # The requested data region for the export.
"voiceOptions": { # The options for Voice exports. # Options for Voice exports.
"exportFormat": "A String", # The file format for exported text messages.
},
},
"id": "A String", # Output only. The generated export ID.
"matterId": "A String", # Output only. The matter ID.
"name": "A String", # The export name. Don't use special characters (~!$'(),;@:/?) in the name, they can prevent you from downloading exports.
"parentExportId": "A String", # Output only. Identifies the parent export that spawned this child export. This is only set on child exports.
"query": { # The query definition used for search and export. # The query parameters used to create the export.
"accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
"emails": [ # A set of accounts to search.
"A String",
],
},
"calendarOptions": { # Additional options for Calendar search # Set Calendar search-specific options.
"locationQuery": [ # Matches only those events whose location contains all of the words in the given set. If the string contains quoted phrases, this method only matches those events whose location contain the exact phrase. Entries in the set are considered in "and". Word splitting example: ["New Zealand"] vs ["New","Zealand"] "New Zealand": matched by both "New and better Zealand": only matched by the later
"A String",
],
"minusWords": [ # Matches only those events that do not contain any of the words in the given set in title, description, location, or attendees. Entries in the set are considered in "or".
"A String",
],
"peopleQuery": [ # Matches only those events whose attendees contain all of the words in the given set. Entries in the set are considered in "and".
"A String",
],
"responseStatuses": [ # Matches only events for which the custodian gave one of these responses. If the set is empty or contains ATTENDEE_RESPONSE_UNSPECIFIED there will be no filtering on responses.
"A String",
],
"versionDate": "A String", # Search the current version of the Calendar event, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
},
"corpus": "A String", # The Google Workspace service to search.
"dataScope": "A String", # The data source to search.
"driveDocumentInfo": { # The Drive documents to search. # Required when **SearchMethod** is **DRIVE_DOCUMENT**.
"documentIds": { # Specify Drive documents by document ID. # Specify Drive documents by document ID.
"ids": [ # Required. A list of Drive document IDs.
"A String",
],
},
},
"driveOptions": { # Additional options for Drive search. # Set Drive search-specific options.
"clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive.
"includeSharedDrives": True or False, # Set to **true** to include shared drives.
"includeTeamDrives": True or False, # Set to true to include Team Drive.
"sharedDrivesOption": "A String", # Optional. Options to include or exclude documents in shared drives. We recommend using this field over include_shared_drives. This field overrides include_shared_drives and include_team_drives when set.
"versionDate": "A String", # 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.
},
"endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
"geminiOptions": { # Additional options for Gemini search # Set Gemini search-specific options.
},
"hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
"roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/workspace/chat). There is a limit of exporting from 500 Chat spaces per request.
"A String",
],
},
"hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
"includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms.
},
"mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options.
"clientSideEncryptedOption": "A String", # Specifies whether the results should include encrypted content, unencrypted content, or both. Defaults to including both.
"excludeDrafts": True or False, # Set to **true** to exclude drafts.
},
"method": "A String", # 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**.
"orgUnitInfo": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
"orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
},
"searchMethod": "A String", # The search method to use.
"sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
"sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
"A String",
],
},
"sitesUrlInfo": { # The published site URLs of new Google Sites to search # Required when **SearchMethod** is **SITES_URL**.
"urls": [ # A list of published site URLs.
"A String",
],
},
"startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
"teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
"teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
"A String",
],
},
"terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
"timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". 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).
"voiceOptions": { # Additional options for Voice search # Set Voice search-specific options.
"coveredData": [ # Datatypes to search
"A String",
],
},
},
"requester": { # User's information. # Output only. The requester of the export.
"displayName": "A String", # The displayed name of the user.
"email": "A String", # The email address of the user.
},
"stats": { # Progress information for an export. # Output only. Details about the export progress and size.
"exportedArtifactCount": "A String", # The number of messages or files already processed for export.
"sizeInBytes": "A String", # The size of export in bytes.
"totalArtifactCount": "A String", # The number of messages or files to be exported.
},
"status": "A String", # Output only. The status of the export.
},
],
"nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
