REST Resource: matters.exports

Recurso: Export

Uma exportação.

Para usar os recursos do Vault, a conta precisa ter os privilégios necessários do Vault e acesso ao caso. Para acessar um caso, a conta precisa ter criado ou ter o caso compartilhado com ele ou ter o privilégio Ver todos os casos.

Representação 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)
  }
}
Campos
id

string

Apenas saída. O ID de exportação gerado.
matterId

string

Apenas saída. O ID do caso.
name

string

O nome da exportação. Não use caracteres especiais (~!$'(),;@:/?) porque eles podem impedir o download das exportações.
requester

object (UserInfo)

Apenas saída. O solicitante da exportação.
query

object (Query)

Parâmetros de consulta usados para criar a exportação.
exportOptions

object (ExportOptions)

Outras opções de exportação.
createTime

string (Timestamp format)

Apenas saída. A hora em que a exportação foi criada.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
status

enum (ExportStatus)

Apenas saída. O status da exportação.
stats

object (ExportStats)

Apenas saída. Detalhes sobre o progresso e o tamanho da exportação.
cloudStorageSink

object (CloudStorageSink)

Apenas saída. O coletor para arquivos de exportação no Cloud Storage.

UserInfo

São as informações do usuário.

Representação JSON 
{
  "email": string,
  "displayName": string
}
Campos
email

string

Endereço de e-mail do usuário.
displayName

string

O nome exibido do usuário.

Opções de exportação

Outras opções para exportações

Representação 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.
}
Campos
region

enum (ExportRegion)

A região de dados solicitada para a exportação.
Campo de união corpus_export_options. Opções específicas de serviço para exportações. corpus_export_options pode ser apenas de um dos tipos a seguir:
mailOptions

object (MailExportOptions)

Opções de exportação do Gmail.
groupsOptions

object (GroupsExportOptions)

Opções para exportações de grupos.
driveOptions

object (DriveExportOptions)

Opções para exportações do Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Opções de exportação do Chat.
voiceOptions

object (VoiceExportOptions)

Opções de exportação do Voice.

Opções de exportação de e-mails

Opções de exportação do Gmail.

Representação JSON 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean
}
Campos
exportFormat

enum (ExportFormat)

O formato do arquivo das mensagens exportadas.
showConfidentialModeContent

boolean

Para exportar o conteúdo do modo confidencial, defina como true.
useNewExport

boolean

Para usar o novo sistema de exportação, defina como true.

Formato de exportação

Exportar formato para mensagens

Enums
EXPORT_FORMAT_UNSPECIFIED Nenhum formato de exportação especificado.
MBOX Exportar como MBOX. Disponível apenas para o Gmail, o Grupos, o Hangouts e o Voice.
PST Exportar como PST. Disponível apenas para o Gmail, Grupos, Hangouts, Voice e Agenda.

Opções de Exportação de Grupos

Opções para exportações de grupos.

Representação JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

O formato do arquivo das mensagens exportadas.

Opções de exportação do Drive

Opções para exportações do Drive.

Representação JSON 
{
  "includeAccessInfo": boolean
}
Campos
includeAccessInfo

boolean

Para incluir informações sobre o nível de acesso para usuários com acesso indireto aos arquivos, defina como true.

Opções de exportação de Hangouts

Opções de exportação do Chat.

Representação JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

O formato do arquivo das mensagens exportadas.

Opções de exportação de voz

As opções para exportações do Voice.

Representação JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

O formato do arquivo de mensagens de texto exportadas.

Região de exportação

A região de dados da exportação.

Enums
EXPORT_REGION_UNSPECIFIED A região não foi especificada. O padrão é QUALQUER.
ANY Qualquer região.
US região dos Estados Unidos.
EUROPE região da Europa.

Status da exportação

O status da exportação.

Enums
EXPORT_STATUS_UNSPECIFIED O status não foi especificado.
COMPLETED A exportação foi concluída.
FAILED Falha na exportação.
IN_PROGRESS A exportação está em andamento.

Exportar estatísticas

Informações de progresso de uma exportação.

Representação JSON 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Campos
exportedArtifactCount

string (int64 format)

O número de mensagens ou arquivos já processados para exportação.
totalArtifactCount

string (int64 format)

O número de mensagens ou arquivos a serem exportados.
sizeInBytes

string (int64 format)

O tamanho da exportação em bytes.

Coletor do Cloud Storage

Coletor de exportação de arquivos do Cloud Storage.

Representação JSON 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Campos
files[]

object (CloudStorageFile)

Apenas saída. Os arquivos exportados no Cloud Storage.

Arquivo do CloudStorage

O arquivo de exportação no Cloud Storage

Representação JSON 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Campos
bucketName

string

O nome do bucket do Cloud Storage para o arquivo de exportação. É possível usar esse valor nas APIs Cloud Storage ou JSON do Cloud Storage, mas não para listar o conteúdo do bucket. Em vez disso, é possível receber arquivos de exportação individuais por nome de objeto.
objectName

string

O nome do objeto do Cloud Storage para o arquivo de exportação. Use esse valor nas APIs JSON ou XML do Cloud Storage.
size

string (int64 format)

O tamanho do arquivo de exportação.
md5Hash

string

Hash md5 do arquivo.

Métodos

create

 Cria uma exportação.

delete

 Exclui uma exportação.

get

 Recebe uma exportação.

list

 Lista os detalhes sobre as exportações no caso especificado.