REST Resource: matters.exports

Ресурс: Экспорт

Экспорт.

Для работы с ресурсами Vault учетная запись должна обладать необходимыми привилегиями Vault и доступом к делу. Для доступа к делу учетная запись должна создать дело, предоставить к нему общий доступ или иметь привилегию «Просмотр всех дел» .

JSON-представление 
{
  "id": string,
  "matterId": string,
  "parentExportId": string,
  "name": string,
  "requester": {
    object (UserInfo)
  },
  "query": {
    object (Query)
  },
  "exportOptions": {
    object (ExportOptions)
  },
  "createTime": string,
  "status": enum (ExportStatus),
  "stats": {
    object (ExportStats)
  },

  "cloudStorageSink": {
    object (CloudStorageSink)
  }
}
Поля
id

string

Только вывод. Сгенерированный идентификатор экспорта.

matterId

string

Только вывод. Идентификатор дела.

parentExportId

string

Только для вывода. Указывает родительский экспорт, который породил этот дочерний экспорт. Этот параметр устанавливается только для дочерних экспортов.

name

string

Название экспортируемого файла. Не используйте специальные символы (~!$'(),;@:/?) в названии, так как они могут помешать загрузке экспортируемых файлов.

requester

object ( UserInfo )

Только вывод. Заказчик экспорта.

query

object ( Query )

Параметры запроса, использованные для создания экспорта.

exportOptions

object ( ExportOptions )

Дополнительные параметры экспорта.

createTime

string ( Timestamp format)

Только вывод. Время создания экспортируемого файла.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

status

enum ( ExportStatus )

Только выходные данные. Статус экспорта.

stats

object ( ExportStats )

Только выходные данные. Подробная информация о ходе экспорта и его объеме.

Поле объединения export_sink . Тип приемника экспорта. export_sink может принимать только одно из следующих значений:
cloudStorageSink

object ( CloudStorageSink )

Только для вывода. Место для экспорта файлов в облачное хранилище.

Информация о пользователе

Информация о пользователе.

JSON-представление 
{
  "email": string,
  "displayName": string
}
Поля
email

string

Адрес электронной почты пользователя.

displayName

string

The displayed name of the user.

ExportOptions

Дополнительные возможности экспорта

JSON-представление 
{
  "region": enum (ExportRegion),

  "mailOptions": {
    object (MailExportOptions)
  },
  "groupsOptions": {
    object (GroupsExportOptions)
  },
  "driveOptions": {
    object (DriveExportOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatExportOptions)
  },
  "voiceOptions": {
    object (VoiceExportOptions)
  },
  "calendarOptions": {
    object (CalendarExportOptions)
  },
  "geminiOptions": {
    object (GeminiExportOptions)
  }
}
Поля
region

enum ( ExportRegion )

Запрашиваемый регион данных для экспорта.

Поле объединения corpus_export_options . Специфические для сервиса параметры экспорта. corpus_export_options может принимать только одно из следующих значений:
mailOptions

object ( MailExportOptions )

Options for Gmail exports.

groupsOptions

object ( GroupsExportOptions )

Параметры экспорта групп.

driveOptions

object ( DriveExportOptions )

Параметры экспорта данных с диска.

hangoutsChatOptions

object ( HangoutsChatExportOptions )

Параметры экспорта чата.

voiceOptions

object ( VoiceExportOptions )

Параметры экспорта голосовых данных.

calendarOptions

object ( CalendarExportOptions )

Доступна опция экспорта календаря.

geminiOptions

object ( GeminiExportOptions )

Доступна опция экспорта через Gemini.

MailExportOptions

Параметры экспорта в Gmail.

JSON-представление 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Поля
exportFormat

enum ( ExportFormat )

Формат файла для экспортируемых сообщений.

showConfidentialModeContent

boolean

Для экспорта содержимого в конфиденциальном режиме установите значение true .

useNewExport

boolean

Для использования новой системы экспорта установите значение true .

exportLinkedDriveFiles

boolean

Необязательно. Чтобы включить экспорт связанных файлов Google Диска, установите значение true .

ЭкспортФормат

Формат экспорта сообщений

Перечисления
EXPORT_FORMAT_UNSPECIFIED Формат экспорта не указан.
MBOX Экспорт в формат MBOX. Доступно только для Gmail, Groups, Hangouts и Voice.
PST Экспорт в формат PST. Доступно только для Gmail, групп, Hangouts, голосовой связи и календаря.
ICS Экспорт в формате ICS. Доступно только для календаря.
XML Экспорт в формате XML. Доступно только для Gemini.

GroupsExportOptions

Параметры экспорта групп.

JSON-представление 
{
  "exportFormat": enum (ExportFormat)
}
Поля
exportFormat

enum ( ExportFormat )

Формат файла для экспортируемых сообщений.

DriveExportOptions

Параметры экспорта данных с диска.

JSON-представление 
{
  "includeAccessInfo": boolean
}
Поля
includeAccessInfo

boolean

Чтобы включить информацию об уровне доступа для пользователей с косвенным доступом к файлам, установите значение true .

HangoutsChatExportOptions

Параметры экспорта чата.

JSON-представление 
{
  "exportFormat": enum (ExportFormat)
}
Поля
exportFormat

enum ( ExportFormat )

The file format for exported messages.

VoiceExportOptions

The options for Voice exports.

JSON-представление 
{
  "exportFormat": enum (ExportFormat)
}
Поля
exportFormat

enum ( ExportFormat )

Формат файла для экспортируемых текстовых сообщений.

CalendarExportOptions

Параметры экспорта календаря.

JSON-представление 
{
  "exportFormat": enum (ExportFormat)
}
Поля
exportFormat

enum ( ExportFormat )

Формат файла для экспортируемых текстовых сообщений.

GeminiExportOptions

The options for Gemini exports.

JSON-представление 
{
  "exportFormat": enum (ExportFormat)
}
Поля
exportFormat

enum ( ExportFormat )

The file format for exported messages.

Экспортный регион

Регион данных для экспорта.

Перечисления
EXPORT_REGION_UNSPECIFIED Регион не указан. По умолчанию используется любой регион.
ANY Any region.
US Регион Соединенных Штатов.
EUROPE Europe region.

ЭкспортСтатус

The status of the export.

Перечисления
EXPORT_STATUS_UNSPECIFIED Статус не указан.
COMPLETED The export completed.
FAILED The export failed.
IN_PROGRESS The export is in progress.

ExportStats

Информация о ходе экспорта.

JSON-представление 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Поля
exportedArtifactCount

string ( int64 format)

Количество сообщений или файлов, уже обработанных для экспорта.

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-представление 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Поля
files[]

object ( CloudStorageFile )

Только выходные данные. Экспортированные файлы хранятся в облачном хранилище.

CloudStorageFile

The export file in Cloud Storage

JSON-представление 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Поля
bucketName

string

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

objectName

string

Имя объекта Cloud Storage для файла экспорта. Это значение можно использовать в JSON API или XML API Cloud Storage.

size

string ( int64 format)

The export file size.

md5Hash

string

The md5 hash of the file.

Методы

create

 Creates an export.

delete

 Deletes an export.

get

 Gets an export.

list

 Содержит подробную информацию об экспорте по указанному вопросу.