REST Resource: matters.exports

资源:Export

导出。

要使用保险柜资源,帐号必须拥有必需的保险柜权限和访问诉讼或调查的权限。要访问诉讼或调查,帐号必须已创建诉讼或调查,拥有诉讼或调查的共享权限,或者拥有查看所有诉讼或调查权限。

JSON 表示法
{
  "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)
  }
}
字段
id

string

仅供输出。生成的导出 ID。

matterId

string

仅供输出。诉讼或调查 ID。

name

string

导出名称。请勿在名称中使用特殊字符 (~!$'(),;@:/?),否则可能会导致您无法下载导出内容。

requester

object (UserInfo)

仅供输出。导出请求者。

query

object (Query)

用于创建导出操作的查询参数。

exportOptions

object (ExportOptions)

其他导出选项。

createTime

string (Timestamp format)

仅供输出。导出作业的创建时间。

时间戳采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

status

enum (ExportStatus)

仅供输出。导出状态。

stats

object (ExportStats)

仅供输出。有关导出进度和大小的详细信息。

cloudStorageSink

object (CloudStorageSink)

仅供输出。Cloud Storage 中导出文件的接收器。

UserInfo

用户信息。

JSON 表示法
{
  "email": string,
  "displayName": string
}
字段
email

string

用户的电子邮件地址。

displayName

string

用户的显示名。

导出选项

其他导出选项

JSON 表示法
{
  "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.
}
字段
region

enum (ExportRegion)

所请求的导出的数据区域。

联合字段 corpus_export_options。特定于服务的导出选项。corpus_export_options 只能是下列其中一项:
mailOptions

object (MailExportOptions)

Gmail 导出选项。

groupsOptions

object (GroupsExportOptions)

群组导出选项。

driveOptions

object (DriveExportOptions)

云端硬盘导出选项。

hangoutsChatOptions

object (HangoutsChatExportOptions)

Chat 导出选项。

voiceOptions

object (VoiceExportOptions)

Voice 导出选项。

MailExportOptions

Gmail 导出选项。

JSON 表示法
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean
}
字段
exportFormat

enum (ExportFormat)

导出消息的文件格式。

showConfidentialModeContent

boolean

如需导出机密模式内容,请设置为 true

useNewExport

boolean

要使用新的导出系统,请设置为 true

导出格式

导出消息的格式

枚举
EXPORT_FORMAT_UNSPECIFIED 未指定导出格式。
MBOX 导出为 MBOX。仅适用于 Gmail、网上论坛、环聊和 Voice。
PST 以 PST 格式导出。仅适用于 Gmail、网上论坛、环聊、Voice 和日历。

群组导出选项

群组导出选项。

JSON 表示法
{
  "exportFormat": enum (ExportFormat)
}
字段
exportFormat

enum (ExportFormat)

导出消息的文件格式。

云端硬盘导出选项

云端硬盘导出选项。

JSON 表示法
{
  "includeAccessInfo": boolean
}
字段
includeAccessInfo

boolean

要为拥有间接访问权限的用户添加访问权限级别信息,请设置为 true

HangoutsChatExportOptions

Chat 导出选项。

JSON 表示法
{
  "exportFormat": enum (ExportFormat)
}
字段
exportFormat

enum (ExportFormat)

导出消息的文件格式。

VoiceExport 选项

Voice 导出选项。

JSON 表示法
{
  "exportFormat": enum (ExportFormat)
}
字段
exportFormat

enum (ExportFormat)

导出短信的文件格式。

导出区域

导出数据的数据区域

枚举
EXPORT_REGION_UNSPECIFIED 未指定区域。默认值为“任意”。
ANY 任何区域。
US 美国地区。
EUROPE 欧洲区域。

导出状态

导出状态。

枚举
EXPORT_STATUS_UNSPECIFIED 状态未指定。
COMPLETED 导出已完成。
FAILED 导出失败。
IN_PROGRESS 正在导出。

导出统计信息

导出进度信息。

JSON 表示法
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
字段
exportedArtifactCount

string (int64 format)

已处理要导出的邮件或文件的数量。

totalArtifactCount

string (int64 format)

要导出的消息或文件的数量。

sizeInBytes

string (int64 format)

导出大小(以字节为单位)。

Cloud Storage 接收器

导出 Cloud Storage 文件的接收器。

JSON 表示法
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
字段
files[]

object (CloudStorageFile)

仅供输出。Cloud Storage 中导出的文件。

Cloud Storage 文件

Cloud Storage 中的导出文件

JSON 表示法
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
字段
bucketName

string

导出文件的 Cloud Storage 存储分区名称。您可以在 Cloud Storage JSON 或 XML API 中使用此值,但不能列出存储分区内容。相反,您可以按对象名称获取各个导出文件

objectName

string

导出文件的 Cloud Storage 对象的名称。您可以在 Cloud Storage JSON 或 XML API 中使用此值。

size

string (int64 format)

导出文件的大小。

md5Hash

string

相应文件的 md5 哈希值。

方法

create

创建导出作业。

delete

删除导出内容。

get

获取导出内容。

list

列出指定诉讼或调查中的导出操作的详细信息。