REST Resource: matters.exports

Tài nguyên: Xuất

Tệp xuất.

Để làm việc với các tài nguyên của Vault, tài khoản phải có các đặc quyền bắt buộc của Vault và quyền truy cập vào vấn đề. Để truy cập vào một vấn đề, tài khoản phải đã tạo vấn đề, chia sẻ vấn đề với họ hoặc có đặc quyền Xem tất cả các vấn đề.

Biểu diễn dưới dạng 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)
  }
}
Các trường
id

string

Chỉ có đầu ra. Mã xuất đã tạo.

matterId

string

Chỉ có đầu ra. Mã vấn đề.

parentExportId

string

Chỉ có đầu ra. Xác định lượt xuất dữ liệu mẹ đã tạo ra tệp dữ liệu xuất phụ này. Chế độ này chỉ áp dụng cho các tệp dữ liệu xuất phụ.

name

string

Tên tệp xuất. Đừng sử dụng các ký tự đặc biệt (~!$'(),;@:/?) trong tên này vì các ký tự này có thể khiến bạn không tải được tệp xuất xuống.

requester

object (UserInfo)

Chỉ có đầu ra. Người yêu cầu xuất.

query

object (Query)

Tham số truy vấn được dùng để tạo tệp xuất.

exportOptions

object (ExportOptions)

Các lựa chọn xuất khác.

createTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm tạo tệp xuất.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

status

enum (ExportStatus)

Chỉ có đầu ra. Trạng thái của quá trình xuất.

stats

object (ExportStats)

Chỉ có đầu ra. Thông tin chi tiết về tiến trình và kích thước xuất.

cloudStorageSink

object (CloudStorageSink)

Chỉ có đầu ra. Bồn lưu trữ dữ liệu để xuất các tệp trong Cloud Storage.

UserInfo

Thông tin của người dùng.

Biểu diễn dưới dạng JSON
{
  "email": string,
  "displayName": string
}
Các trường
email

string

Địa chỉ email của người dùng.

displayName

string

Tên hiển thị của người dùng.

ExportOptions

Các lựa chọn khác để xuất

Biểu diễn dưới dạng 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)
  },
  "calendarOptions": {
    object (CalendarExportOptions)
  }
  // End of list of possible types for union field corpus_export_options.
}
Các trường
region

enum (ExportRegion)

Khu vực lưu trữ dữ liệu được yêu cầu để xuất.

Trường nhóm corpus_export_options. Các tuỳ chọn xuất theo dịch vụ cụ thể. corpus_export_options chỉ có thể là một trong những trạng thái sau đây:
mailOptions

object (MailExportOptions)

Các tuỳ chọn về tệp xuất của Gmail.

groupsOptions

object (GroupsExportOptions)

Các tuỳ chọn để xuất dữ liệu trên Groups.

driveOptions

object (DriveExportOptions)

Các tuỳ chọn về tệp xuất trên Drive.

hangoutsChatOptions

object (HangoutsChatExportOptions)

Các tuỳ chọn xuất dữ liệu từ Chat.

voiceOptions

object (VoiceExportOptions)

Các tuỳ chọn để xuất dữ liệu bằng giọng nói.

calendarOptions

object (CalendarExportOptions)

Có tuỳ chọn để xuất Lịch.

MailExportOptions

Các tuỳ chọn về tệp xuất của Gmail.

Biểu diễn dưới dạng JSON
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Các trường
exportFormat

enum (ExportFormat)

Định dạng tệp cho thư đã xuất.

showConfidentialModeContent

boolean

Để xuất nội dung ở chế độ bảo mật, hãy đặt thành true.

useNewExport

boolean

Để sử dụng hệ thống xuất dữ liệu mới, hãy đặt thành true.

exportLinkedDriveFiles

boolean

Không bắt buộc. Để bật tính năng xuất các tệp được liên kết trên Drive, hãy đặt thành true.

ExportFormat

Định dạng xuất của thư

Enum
EXPORT_FORMAT_UNSPECIFIED Chưa chỉ định định dạng xuất.
MBOX Xuất dưới dạng MBOX. Chỉ dành cho Gmail, Groups, Hangouts và Voice.
PST Xuất dưới dạng PST. Chỉ dành cho Gmail, Groups, Hangouts, Voice và Lịch.
ICS Xuất dưới dạng ICS. Chỉ dành cho Lịch.

GroupsExportOptions

Các tuỳ chọn để xuất dữ liệu trên Groups.

Biểu diễn dưới dạng JSON
{
  "exportFormat": enum (ExportFormat)
}
Các trường
exportFormat

enum (ExportFormat)

Định dạng tệp cho thư đã xuất.

DriveExportOptions

Các tuỳ chọn về tệp xuất trên Drive.

Biểu diễn dưới dạng JSON
{
  "includeAccessInfo": boolean
}
Các trường
includeAccessInfo

boolean

Để bao gồm thông tin về cấp truy cập cho người dùng có quyền truy cập gián tiếp vào tệp, hãy đặt thành true.

HangoutsChatExportOptions

Các tuỳ chọn xuất dữ liệu từ Chat.

Biểu diễn dưới dạng JSON
{
  "exportFormat": enum (ExportFormat)
}
Các trường
exportFormat

enum (ExportFormat)

Định dạng tệp cho thư đã xuất.

VoiceExportOptions

Các lựa chọn để xuất dữ liệu bằng giọng nói.

Biểu diễn dưới dạng JSON
{
  "exportFormat": enum (ExportFormat)
}
Các trường
exportFormat

enum (ExportFormat)

Định dạng tệp cho tin nhắn văn bản được xuất.

CalendarExportOptions

Các tuỳ chọn để xuất Lịch.

Biểu diễn dưới dạng JSON
{
  "exportFormat": enum (ExportFormat)
}
Các trường
exportFormat

enum (ExportFormat)

Định dạng tệp cho tin nhắn văn bản được xuất.

ExportRegion

Khu vực lưu trữ dữ liệu để xuất.

Enum
EXPORT_REGION_UNSPECIFIED Khu vực chưa được chỉ định. Giá trị mặc định là BẤT KỲ.
ANY Bất kỳ khu vực nào.
US Hoa Kỳ.
EUROPE Châu Âu.

ExportStatus

Trạng thái của quá trình xuất.

Enum
EXPORT_STATUS_UNSPECIFIED Trạng thái chưa xác định.
COMPLETED Đã xuất xong.
FAILED Không xuất được dữ liệu.
IN_PROGRESS Đang xuất dữ liệu.

ExportStats

Thông tin về tiến trình để xuất.

Biểu diễn dưới dạng JSON
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Các trường
exportedArtifactCount

string (int64 format)

Số lượng thư hoặc tệp đã được xử lý để xuất.

totalArtifactCount

string (int64 format)

Số lượng thư hoặc tệp được xuất.

sizeInBytes

string (int64 format)

Kích thước của tệp xuất tính bằng byte.

CloudStorageSink

Xuất bồn lưu trữ dữ liệu cho các tệp trên Cloud Storage.

Biểu diễn dưới dạng JSON
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Các trường
files[]

object (CloudStorageFile)

Chỉ có đầu ra. Các tệp đã xuất trong Cloud Storage.

CloudStorageFile

Tệp xuất trong Cloud Storage

Biểu diễn dưới dạng JSON
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Các trường
bucketName

string

Tên bộ chứa Cloud Storage cho tệp xuất. Bạn có thể sử dụng giá trị này trong JSON API hoặc XML API trong Cloud Storage, nhưng không được liệt kê nội dung trong bộ chứa. Thay vào đó, bạn có thể lấy từng tệp xuất riêng lẻ theo tên đối tượng.

objectName

string

Tên của đối tượng trong Cloud Storage của tệp xuất. Bạn có thể sử dụng giá trị này trong JSON API hoặc XML API của Cloud Storage.

size

string (int64 format)

Kích thước tệp xuất.

md5Hash

string

Hàm băm md5 của tệp.

Phương thức

create

Tạo tệp xuất.

delete

Xoá một tệp dữ liệu xuất.

get

Nhận tệp xuất.

list

Liệt kê chi tiết về các tệp xuất liên quan đến vấn đề cụ thể.