Team Drives-related fields in the Vault API are being replaced. Learn more.

REST Resource: matters.exports

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 (UserInfo)
  },
  "query": {
    object (Query)
  },
  "exportOptions": {
    object (ExportOptions)
  },
  "createTime": string,
  "status": enum (ExportStatus),
  "stats": {
    object (ExportStats)
  },
  "cloudStorageSink": {
    object (CloudStorageSink)
  }
}
Fields
id

string

Output only. The generated export ID.
matterId

string

Output only. The matter ID.
name

string

The export name.
requester

object (UserInfo)

Output only. The requester of the export.
query

object (Query)

The search query being exported.
exportOptions

object (ExportOptions)

Advanced options of the export.
createTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
status

enum (ExportStatus)

Output only. The export status.
stats

object (ExportStats)

Output only. Export statistics.
cloudStorageSink

object (CloudStorageSink)

Output only. Export sink for cloud storage files.

UserInfo

User's information.

JSON representation 
{
  "email": string,
  "displayName": string
}
Fields
email

string

The email address of the user.
displayName

string

The displayed name of the user.

ExportOptions

Export advanced options

JSON representation 
{
  "region": enum (ExportRegion),

  // Union field corpus_export_options can be only one of the following:
  "mailOptions": {
    object (MailExportOptions)
  },
  "groupsOptions": {
    object (GroupsExportOptions)
  },
  "driveOptions": {
    object (DriveExportOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatExportOptions)
  },
  "voiceOptions": {
    object (VoiceExportOptions)
  }
  // End of list of possible types for union field corpus_export_options.
}
Fields
region

enum (ExportRegion)

The requested export location.
Union field corpus_export_options. Options for export. corpus_export_options can be only one of the following:
mailOptions

object (MailExportOptions)

Option available for mail export.
groupsOptions

object (GroupsExportOptions)

Option available for groups export.
driveOptions

object (DriveExportOptions)

Option available for Drive export.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Option available for hangouts chat export.
voiceOptions

object (VoiceExportOptions)

Option available for voice export.

MailExportOptions

The options for mail export.

JSON representation 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean
}
Fields
exportFormat

enum (ExportFormat)

The export file format.
showConfidentialModeContent

boolean

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 (ExportFormat)
}
Fields
exportFormat

enum (ExportFormat)

The export format for groups export.

DriveExportOptions

The options for Drive export.

JSON representation 
{
  "includeAccessInfo": boolean
}
Fields
includeAccessInfo

boolean

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 (ExportFormat)
}
Fields
exportFormat

enum (ExportFormat)

The export format for hangouts chat export.

VoiceExportOptions

The options for voice export.

JSON representation 
{
  "exportFormat": enum (ExportFormat)
}
Fields
exportFormat

enum (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

string (int64 format)

The number of documents already processed by the export.
totalArtifactCount

string (int64 format)

The number of documents to be exported.
sizeInBytes

string (int64 format)

The size of export in bytes.

CloudStorageSink

Export sink for cloud storage files.

JSON representation 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Fields
files[]

object (CloudStorageFile)

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

string

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

string

The cloud storage object name of this export file. Can be used in cloud storage JSON/XML API.
size

string (int64 format)

The size of the export file.
md5Hash

string

The md5 hash of the file.

Methods

create

 Creates an Export.

delete

 Deletes an Export.

get

 Gets an Export.

list

 Lists Exports.