REST Resource: matters.exports

Risorsa: Export

Un'esportazione.

Per utilizzare le risorse di Vault, l'account deve disporre dei privilegi di Vault richiesti e dell'accesso alla pratica. Per accedere a una pratica, l'account deve averla creata, deve averla condivisa o deve disporre del privilegio Visualizzazione di tutte le pratiche.

Rappresentazione 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)
  }
}
Campi
id

string

Solo output. L'ID esportazione generato.
matterId

string

Solo output. L'ID pratica.
parentExportId

string

Solo output. Identifica l'esportazione principale che ha generato questa esportazione secondaria. Questo valore viene impostato solo nelle esportazioni secondarie.
name

string

Il nome dell'esportazione. Non utilizzare caratteri speciali (~!$'(),;@:/?) nel nome: se lo fai, potresti non riuscire a scaricare le esportazioni.
requester

object (UserInfo)

Solo output. Il richiedente dell'esportazione.
query

object (Query)

I parametri di query utilizzati per creare l'esportazione.
exportOptions

object (ExportOptions)

Opzioni di esportazione aggiuntive.
createTime

string (Timestamp format)

Solo output. L'ora in cui è stata creata l'esportazione.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
status

enum (ExportStatus)

Solo output. Lo stato dell'esportazione.
stats

object (ExportStats)

Solo output. Dettagli sullo stato di avanzamento e sulle dimensioni dell'esportazione.
Campo unione export_sink. Tipo di sink di esportazione. export_sink può essere solo uno dei seguenti tipi:
cloudStorageSink

object (CloudStorageSink)

Solo output. Il sink per i file di esportazione in Cloud Storage.

UserInfo

Informazioni dell'utente.

Rappresentazione JSON 
{
  "email": string,
  "displayName": string
}
Campi
email

string

L'indirizzo email dell'utente.
displayName

string

Il nome visualizzato dell'utente.

ExportOptions

Opzioni aggiuntive per le esportazioni

Rappresentazione 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)
  }
}
Campi
region

enum (ExportRegion)

La regione di dati richiesta per l'esportazione.
Campo unione corpus_export_options. Opzioni specifiche per servizio per le esportazioni. corpus_export_options può essere solo uno dei seguenti tipi:
mailOptions

object (MailExportOptions)

Opzioni per le esportazioni di Gmail.
groupsOptions

object (GroupsExportOptions)

Opzioni per le esportazioni dei gruppi.
driveOptions

object (DriveExportOptions)

Opzioni per le esportazioni di Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Opzioni per le esportazioni di Chat.
voiceOptions

object (VoiceExportOptions)

Opzioni per le esportazioni di Voice.
calendarOptions

object (CalendarExportOptions)

Opzione disponibile per l'esportazione di Calendar.
geminiOptions

object (GeminiExportOptions)

Opzione disponibile per l'esportazione di Gemini.

MailExportOptions

Opzioni per le esportazioni di Gmail.

Rappresentazione JSON 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Campi
exportFormat

enum (ExportFormat)

Il formato file per i messaggi esportati.
showConfidentialModeContent

boolean

Per esportare i contenuti della modalità riservata, imposta il valore su true.
useNewExport

boolean

Per utilizzare il nuovo sistema di esportazione, imposta il valore su true.
exportLinkedDriveFiles

boolean

Facoltativo. Per abilitare l'esportazione dei file di Drive collegati, imposta il valore su true.

ExportFormat

Formato di esportazione per i messaggi

Enum
EXPORT_FORMAT_UNSPECIFIED Nessun formato di esportazione specificato.
MBOX Esporta come MBOX. Disponibile solo per Gmail, Gruppi, Hangouts e Voice.
PST Esporta come PST. Disponibile solo per Gmail, Gruppi, Hangouts, Voice e Calendar.
ICS Esporta come ICS. Disponibile solo per Calendar.
XML Esporta come XML. Disponibile solo per Gemini.

GroupsExportOptions

Opzioni per le esportazioni dei gruppi.

Rappresentazione JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campi
exportFormat

enum (ExportFormat)

Il formato file per i messaggi esportati.

DriveExportOptions

Opzioni per le esportazioni di Drive.

Rappresentazione JSON 
{
  "includeAccessInfo": boolean
}
Campi
includeAccessInfo

boolean

Per includere le informazioni sul livello di accesso per gli utenti con accesso indiretto ai file, imposta il valore su true.

HangoutsChatExportOptions

Opzioni per le esportazioni di Chat.

Rappresentazione JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campi
exportFormat

enum (ExportFormat)

Il formato file per i messaggi esportati.

VoiceExportOptions

Le opzioni per le esportazioni di Voice.

Rappresentazione JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campi
exportFormat

enum (ExportFormat)

Il formato dei file per i messaggi di testo esportati.

CalendarExportOptions

Opzioni per le esportazioni di Calendar.

Rappresentazione JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campi
exportFormat

enum (ExportFormat)

Il formato dei file per i messaggi di testo esportati.

GeminiExportOptions

Le opzioni per le esportazioni di Gemini.

Rappresentazione JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campi
exportFormat

enum (ExportFormat)

Il formato file per i messaggi esportati.

ExportRegion

La regione di dati per l'esportazione.

Enum
EXPORT_REGION_UNSPECIFIED La regione non è specificata. Il valore predefinito è ANY.
ANY Qualsiasi regione.
US Regione Stati Uniti.
EUROPE Regione Europa.

ExportStatus

Lo stato dell'esportazione.

Enum
EXPORT_STATUS_UNSPECIFIED Lo stato non è specificato.
COMPLETED L'esportazione è stata completata.
FAILED Esportazione non riuscita.
IN_PROGRESS L'esportazione è in corso.

ExportStats

Informazioni sullo stato di avanzamento di un'esportazione.

Rappresentazione JSON 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Campi
exportedArtifactCount

string (int64 format)

Il numero di messaggi o file già elaborati per l'esportazione.
totalArtifactCount

string (int64 format)

Il numero di messaggi o file da esportare.
sizeInBytes

string (int64 format)

Le dimensioni dell'esportazione in byte.

CloudStorageSink

Sink di esportazione per i file Cloud Storage.

Rappresentazione JSON 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Campi
files[]

object (CloudStorageFile)

Solo output. I file esportati in Cloud Storage.

CloudStorageFile

Il file di esportazione in Cloud Storage

Rappresentazione JSON 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Campi
bucketName

string

Il nome del bucket Cloud Storage per il file di esportazione. Puoi utilizzare questo valore nell'API JSON o nell'API XML di Cloud Storage, ma non per elencare i contenuti del bucket. Puoi invece ottenere singoli file di esportazione in base al nome dell'oggetto.
objectName

string

Il nome dell'oggetto Cloud Storage per il file di esportazione. Puoi utilizzare questo valore nell'API JSON o nell'API XML di Cloud Storage.
size

string (int64 format)

Le dimensioni del file di esportazione.
md5Hash

string

L'hash MD5 del file.

Metodi

create

 Crea un'esportazione.

delete

 Elimina un'esportazione.

get

 Recupera un'esportazione.

list

 Elenca i dettagli delle esportazioni nella pratica specificata.