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 này phải có các đặc quyền cần thiết 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 là người đã tạo vấn đề, đã chia sẻ vấn đề đó với họ hoặc có đặc quyền Xem tất 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)
  }
}
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 tệp xuất dữ liệu gốc đã tạo tệp xuất dữ liệu con này. Chế độ này chỉ được đặt cho các tệp 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 vì chúng có thể khiến bạn không thể tải cá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 bổ sung.
createTime

string (Timestamp format)

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

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
status

enum (ExportStatus)

Chỉ có đầu ra. Trạng thái 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
}
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.
}
Trường
region

enum (ExportRegion)

Khu vực lưu trữ dữ liệu được yêu cầu để xuất.
Trường kết hợp corpus_export_options. Các lựa chọn xuất dành riêng cho từng dịch vụ. 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 để xuất dữ liệu của Gmail.
groupsOptions

object (GroupsExportOptions)

Các tuỳ chọn xuất dữ liệu của Groups.
driveOptions

object (DriveExportOptions)

Các lựa chọn về tệp xuất trên Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Các lựa chọn xuất dữ liệu từ Chat.
voiceOptions

object (VoiceExportOptions)

Các lựa chọn xuất dữ liệu bằng Voice.
calendarOptions

object (CalendarExportOptions)

Có một lựa chọn để xuất Lịch.

MailExportOptions

Các tuỳ chọn để xuất dữ liệu của Gmail.

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

enum (ExportFormat)

Định dạng tệp cho thư được 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 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 cho thư

Enum
EXPORT_FORMAT_UNSPECIFIED Chưa chỉ định định dạng xuất nào.
MBOX Xuất dưới dạng MBOX. Chỉ dùng được 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. Tính năng này chỉ dành cho Lịch.

GroupsExportOptions

Các tuỳ chọn xuất dữ liệu của Groups.

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

enum (ExportFormat)

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

DriveExportOptions

Các lựa chọn về tệp xuất trên Drive.

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

boolean

Để thêm thông tin về cấp truy cập của 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 lựa chọn xuất dữ liệu từ Chat.

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

enum (ExportFormat)

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

VoiceExportOptions

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

Biểu diễn dưới dạng JSON 
{
  "exportFormat": enum (ExportFormat)
}
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 dữ liệu của Lịch Google.

Biểu diễn dưới dạng JSON 
{
  "exportFormat": enum (ExportFormat)
}
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 Mọi khu vực.
US Khu vực Hoa Kỳ.
EUROPE Khu vực Châu Âu.

ExportStatus

Trạng thái xuất.

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

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
}
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 tin nhắn hoặc tệp sẽ 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)
    }
  ]
}
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
}
Trường
bucketName

string

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

string

Tên của đối tượng Cloud Storage cho tệp xuất. Bạn có thể dùng giá trị này trong API JSON hoặc API XML 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 một 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ê thông tin chi tiết về các tệp xuất trong vấn đề đã chỉ định.