REST Resource: matters.exports

Recurso: exportação

Uma exportação.

Para trabalhar com 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 o caso, ter recebido o compartilhamento dele ou ter o privilégio Ver todos os casos.

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

string

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

string

Apenas saída. O ID do caso.
parentExportId

string

Apenas saída. Identifica a exportação principal que gerou esta exportação filha. Isso só é definido em exportações filhas.
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 requerente da exportação.
query

object (Query)

Os 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. O horário em que a exportação foi criada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
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.
Campo de união export_sink. Tipo de coletor de exportação. export_sink pode ser apenas de um dos tipos a seguir:
cloudStorageSink

object (CloudStorageSink)

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

UserInfo

Informações do usuário.

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

string

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

string

O nome de exibição do usuário.

ExportOptions

Outras opções de exportação

Representação 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)
  }
}
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 do serviço para exportações. corpus_export_options pode ser apenas de um dos tipos a seguir:
mailOptions

object (MailExportOptions)

Opções para exportações 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 para exportações do Chat.
voiceOptions

object (VoiceExportOptions)

Opções para exportações de voz.
calendarOptions

object (CalendarExportOptions)

Opção disponível para exportação da Agenda.
geminiOptions

object (GeminiExportOptions)

Opção disponível para exportação do Gemini.

MailExportOptions

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

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

enum (ExportFormat)

O formato de arquivo das mensagens exportadas.
showConfidentialModeContent

boolean

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

boolean

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

boolean

Opcional. Para ativar a exportação de arquivos vinculados do Drive, defina como true.

ExportFormat

Formato de exportação de mensagens

Tipos enumerados
EXPORT_FORMAT_UNSPECIFIED Nenhum formato de exportação especificado.
MBOX Exporte como MBOX. Disponível apenas para Gmail, Grupos, Hangouts e Voice.
PST Exporte como PST. Disponível apenas para Gmail, Grupos, Hangouts, Voice e Agenda.
ICS Exporte como ICS. Disponível apenas para o Google Agenda.
XML Exporte como XML. Disponível apenas para o Gemini.

GroupsExportOptions

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

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

enum (ExportFormat)

O formato de arquivo das mensagens exportadas.

DriveExportOptions

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

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

boolean

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

HangoutsChatExportOptions

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

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

enum (ExportFormat)

O formato de arquivo das mensagens exportadas.

VoiceExportOptions

As opções para exportações de voz.

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

enum (ExportFormat)

O formato de arquivo das mensagens de texto exportadas.

CalendarExportOptions

As opções de exportação da Agenda.

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

enum (ExportFormat)

O formato de arquivo das mensagens de texto exportadas.

GeminiExportOptions

As opções de exportação do Gemini.

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

enum (ExportFormat)

O formato de arquivo das mensagens exportadas.

ExportRegion

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

Tipos enumerados
EXPORT_REGION_UNSPECIFIED A região não foi especificada. O padrão é "ANY".
ANY Qualquer região.
US Região dos Estados Unidos.
EUROPE Região da Europa.

ExportStatus

O status da exportação.

Tipos enumerados
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.

ExportStats

Informações de progresso para 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.

CloudStorageSink

Gravador de exportação para arquivos do Cloud Storage.

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

object (CloudStorageFile)

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

CloudStorageFile

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 na API JSON ou na API XML do Cloud Storage, mas não para listar o conteúdo do bucket. Em vez disso, você pode 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. É possível usar esse valor na API JSON ou na API XML do Cloud Storage.
size

string (int64 format)

O tamanho do arquivo de exportação.
md5Hash

string

O hash MD5 do arquivo.

Métodos

create

 Cria uma exportação.

delete

 Exclui uma exportação.

get

 Recebe uma exportação.

list

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