- Resource: Export
- UserInfo
- ExportOptions
- MailExportOptions
- ExportFormat
- GroupsExportOptions
- DriveExportOptions
- HangoutsChatExportOptions
- VoiceExportOptions
- ExportRegion
- ExportStatus
- ExportStats
- CloudStorageSink
- CloudStorageFile
- Methods
Resource: Export
An export
To work with Vault resources, the account must have the required Vault privileges 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.
JSON representation | |
---|---|
{ "id": string, "matterId": string, "name": string, "requester": { object ( |
Fields | |
---|---|
id |
Output only. The generated export ID. |
matterId |
Output only. The matter ID. |
name |
The export name. |
requester |
Output only. The requester of the export. |
query |
The search query being exported. |
exportOptions |
Advanced options of the export. |
createTime |
Output only. The time when the export was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
status |
Output only. The export status. |
stats |
Output only. Export statistics. |
cloudStorageSink |
Output only. Export sink for cloud storage files. |
UserInfo
User's information.
JSON representation | |
---|---|
{ "email": string, "displayName": string } |
Fields | |
---|---|
email |
The email address of the user. |
displayName |
The displayed name of the user. |
ExportOptions
Export advanced options
JSON representation | |
---|---|
{ "region": enum ( |
Fields | ||
---|---|---|
region |
The requested export location. |
|
Union field corpus_export_options . Options for export. corpus_export_options can be only one of the following: |
||
mailOptions |
Option available for mail export. |
|
groupsOptions |
Option available for groups export. |
|
driveOptions |
Option available for Drive export. |
|
hangoutsChatOptions |
Option available for hangouts chat export. |
|
voiceOptions |
Option available for voice export. |
MailExportOptions
The options for mail export.
JSON representation | |
---|---|
{
"exportFormat": enum ( |
Fields | |
---|---|
exportFormat |
The export file format. |
showConfidentialModeContent |
Set to true to export confidential mode content. |
ExportFormat
Supported export format
Enums | |
---|---|
EXPORT_FORMAT_UNSPECIFIED |
No export format specified. |
MBOX |
MBOX as export format. |
PST |
PST as export format |
GroupsExportOptions
The options for groups export.
JSON representation | |
---|---|
{
"exportFormat": enum ( |
Fields | |
---|---|
exportFormat |
The export format for groups export. |
DriveExportOptions
The options for Drive export.
JSON representation | |
---|---|
{ "includeAccessInfo": boolean } |
Fields | |
---|---|
includeAccessInfo |
Set to true to include access level information for users with indirect access to files. |
HangoutsChatExportOptions
The options for hangouts chat export.
JSON representation | |
---|---|
{
"exportFormat": enum ( |
Fields | |
---|---|
exportFormat |
The export format for hangouts chat export. |
VoiceExportOptions
The options for voice export.
JSON representation | |
---|---|
{
"exportFormat": enum ( |
Fields | |
---|---|
exportFormat |
The export format for voice export. |
ExportRegion
The requested location of the export.
Enums | |
---|---|
EXPORT_REGION_UNSPECIFIED |
The region is unspecified. Will be treated the same as ANY. |
ANY |
Any region. |
US |
US region. |
EUROPE |
Europe region. |
ExportStatus
The status of the export.
Enums | |
---|---|
EXPORT_STATUS_UNSPECIFIED |
The status is unspecified. |
COMPLETED |
The export completed. |
FAILED |
The export failed. |
IN_PROGRESS |
The export is still being executed. |
ExportStats
Stats of an export.
JSON representation | |
---|---|
{ "exportedArtifactCount": string, "totalArtifactCount": string, "sizeInBytes": string } |
Fields | |
---|---|
exportedArtifactCount |
The number of documents already processed by the export. |
totalArtifactCount |
The number of documents to be exported. |
sizeInBytes |
The size of export in bytes. |
CloudStorageSink
Export sink for cloud storage files.
JSON representation | |
---|---|
{
"files": [
{
object ( |
Fields | |
---|---|
files[] |
Output only. The exported files on cloud storage. |
CloudStorageFile
An export file on cloud storage
JSON representation | |
---|---|
{ "bucketName": string, "objectName": string, "size": string, "md5Hash": string } |
Fields | |
---|---|
bucketName |
The cloud storage bucket name of this export file. Can be used in cloud storage JSON/XML API, but not to list the bucket contents. Instead, you can get individual export files by object name. |
objectName |
The cloud storage object name of this export file. Can be used in cloud storage JSON/XML API. |
size |
The size of the export file. |
md5Hash |
The md5 hash of the file. |
Methods |
|
---|---|
|
Creates an Export. |
|
Deletes an Export. |
|
Gets an Export. |
|
Lists Exports. |