REST Resource: matters.exports

Stay organized with collections Save and categorize content based on your preferences.

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. Don't use special characters (~!$'(),;@:/?) in the name, they can prevent you from downloading exports.
requester

object (UserInfo)

Output only. The requester of the export.
query

object (Query)

The query parameters used to create the export.
exportOptions

object (ExportOptions)

Additional export options.
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 status of the export.
stats

object (ExportStats)

Output only. Details about the export progress and size.
cloudStorageSink

object (CloudStorageSink)

Output only. The sink for export files in Cloud Storage.

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

Additional options for exports

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 data region for the export.
Union field corpus_export_options. Service-specific options for exports. corpus_export_options can be only one of the following:
mailOptions

object (MailExportOptions)

Options for Gmail exports.
groupsOptions

object (GroupsExportOptions)

Options for Groups exports.
driveOptions

object (DriveExportOptions)

Options for Drive exports.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Options for Chat exports.
voiceOptions

object (VoiceExportOptions)

Options for Voice exports.

MailExportOptions

Options for Gmail exports.

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

enum (ExportFormat)

The file format for exported messages.
showConfidentialModeContent

boolean

To export confidential mode content, set to true.
useNewExport

boolean

To use the new export system, set to true.

ExportFormat

Export format for messages

Enums
EXPORT_FORMAT_UNSPECIFIED No export format specified.
MBOX Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.
PST Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.

GroupsExportOptions

Options for Groups exports.

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

enum (ExportFormat)

The file format for exported messages.

DriveExportOptions

Options for Drive exports.

JSON representation 
{
  "includeAccessInfo": boolean
}
Fields
includeAccessInfo

boolean

To include access level information for users with indirect access to files, set to true.

HangoutsChatExportOptions

Options for Chat exports.

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

enum (ExportFormat)

The file format for exported messages.

VoiceExportOptions

The options for Voice exports.

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

enum (ExportFormat)

The file format for exported text messages.

ExportRegion

The data region for the export.

Enums
EXPORT_REGION_UNSPECIFIED The region is unspecified. Defaults to ANY.
ANY Any region.
US United States 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 in progress.

ExportStats

Progress information for an export.

JSON representation 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Fields
exportedArtifactCount

string (int64 format)

The number of messages or files already processed for export.
totalArtifactCount

string (int64 format)

The number of messages or files 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 in Cloud Storage.

CloudStorageFile

The export file in Cloud Storage

JSON representation 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Fields
bucketName

string

The name of the Cloud Storage bucket for the export file. You can use this value in the Cloud Storage JSON or XML APIs, but not to list the bucket contents. Instead, you can get individual export files by object name.
objectName

string

The name of the Cloud Storage object for the export file. You can use this value in the Cloud Storage JSON or XML APIs.
size

string (int64 format)

The export file size.
md5Hash

string

The md5 hash of the file.

Methods

create

 Creates an export.

delete

 Deletes an export.

get

 Gets an export.

list

 Lists details about the exports in the specified matter.