REST Resource: matters.exports

Recurso: Export

Una exportación.

Para trabajar con los recursos de Vault, la cuenta debe tener los privilegios de Vault necesarios y acceso al asunto. Para acceder a un asunto, la cuenta debe haberlo creado, compartirlo con ella o tener el privilegio Ver todos los asuntos.

Representación 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)
  },

  // Union field export_sink can be only one of the following:
  "cloudStorageSink": {
    object (CloudStorageSink)
  }
  // End of list of possible types for union field export_sink.
}
Campos
id

string

Solo salida. El ID de exportación generado.
matterId

string

Solo salida. El ID del asunto
parentExportId

string

Solo salida. Identifica la exportación superior que generó esta exportación secundaria. Esto solo se establece en las exportaciones secundarias.
name

string

Es el nombre de la exportación. No uses caracteres especiales (~!$'(),;@:/?) en el nombre, ya que pueden impedir que descargues las exportaciones.
requester

object (UserInfo)

Solo salida. Es el solicitante de la exportación.
query

object (Query)

Los parámetros de consulta que se usaron para crear la exportación.
exportOptions

object (ExportOptions)

Opciones de exportación adicionales.
createTime

string (Timestamp format)

Solo salida. Es la hora en la que se creó la exportación.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
status

enum (ExportStatus)

Solo salida. Es el estado de la exportación.
stats

object (ExportStats)

Solo salida. Detalles sobre el progreso y el tamaño de la exportación
Campo de unión export_sink. Tipo de receptor de exportación. Las direcciones (export_sink) solo pueden ser una de las siguientes opciones:
cloudStorageSink

object (CloudStorageSink)

Solo salida. Es el destino para los archivos de exportación en Cloud Storage.

UserInfo

Información del usuario.

Representación JSON 
{
  "email": string,
  "displayName": string
}
Campos
email

string

Es la dirección de correo electrónico del usuario.
displayName

string

Es el nombre visible del usuario.

ExportOptions

Opciones adicionales para las exportaciones

Representación 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)
  },
  "geminiOptions": {
    object (GeminiExportOptions)
  }
  // End of list of possible types for union field corpus_export_options.
}
Campos
region

enum (ExportRegion)

La región de datos solicitada para la exportación.
Campo de unión corpus_export_options. Son opciones específicas del servicio para las exportaciones. Las direcciones (corpus_export_options) solo pueden ser una de las siguientes opciones:
mailOptions

object (MailExportOptions)

Opciones para las exportaciones de Gmail.
groupsOptions

object (GroupsExportOptions)

Opciones para las exportaciones de grupos.
driveOptions

object (DriveExportOptions)

Opciones para exportaciones de Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Opciones para las exportaciones de chat.
voiceOptions

object (VoiceExportOptions)

Opciones para las exportaciones de voz.
calendarOptions

object (CalendarExportOptions)

Opción disponible para la exportación de Calendario.
geminiOptions

object (GeminiExportOptions)

Opción disponible para la exportación de Gemini.

MailExportOptions

Opciones para las exportaciones de Gmail.

Representación JSON 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Campos
exportFormat

enum (ExportFormat)

Es el formato de archivo de los mensajes exportados.
showConfidentialModeContent

boolean

Para exportar contenido del modo confidencial, configúralo como true.
useNewExport

boolean

Para usar el nuevo sistema de exportación, configúralo como true.
exportLinkedDriveFiles

boolean

Opcional. Para habilitar la exportación de archivos de Drive vinculados, configúralo como true.

ExportFormat

Formato de exportación de mensajes

Enumeraciones
EXPORT_FORMAT_UNSPECIFIED No se especificó ningún formato de exportación.
MBOX Exportar como MBOX Solo está disponible para Gmail, Grupos, Hangouts y Voice.
PST Exportar como PST Solo está disponible para Gmail, Grupos, Hangouts, Voice y Calendario.
ICS Exportar como ICS Solo está disponible para el Calendario.
XML Exportar como XML Solo está disponible para Gemini.

GroupsExportOptions

Opciones para las exportaciones de grupos.

Representación JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

Es el formato de archivo de los mensajes exportados.

DriveExportOptions

Opciones para exportaciones de Drive.

Representación JSON 
{
  "includeAccessInfo": boolean
}
Campos
includeAccessInfo

boolean

Para incluir información del nivel de acceso de los usuarios con acceso indirecto a los archivos, configúralo como true.

HangoutsChatExportOptions

Opciones para las exportaciones de Chat.

Representación JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

Es el formato de archivo de los mensajes exportados.

VoiceExportOptions

Las opciones para las exportaciones de voz.

Representación JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

Es el formato de archivo de los mensajes de texto exportados.

CalendarExportOptions

Las opciones para las exportaciones de Calendario.

Representación JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

Es el formato de archivo de los mensajes de texto exportados.

GeminiExportOptions

Las opciones para las exportaciones de Gemini.

Representación JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

Es el formato de archivo de los mensajes exportados.

ExportRegion

La región de datos para la exportación.

Enumeraciones
EXPORT_REGION_UNSPECIFIED La región no se especifica. El valor predeterminado es ANY.
ANY Cualquier región
US Región de Estados Unidos.
EUROPE Región de Europa

ExportStatus

Es el estado de la exportación.

Enumeraciones
EXPORT_STATUS_UNSPECIFIED El estado no se especifica.
COMPLETED Se completó la exportación.
FAILED No se pudo realizar la exportación.
IN_PROGRESS La exportación está en curso.

ExportStats

Información de progreso de una exportación.

Representación JSON 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Campos
exportedArtifactCount

string (int64 format)

Es la cantidad de mensajes o archivos que ya se procesaron para exportarlos.
totalArtifactCount

string (int64 format)

Es la cantidad de mensajes o archivos que se exportarán.
sizeInBytes

string (int64 format)

Es el tamaño de la exportación en bytes.

CloudStorageSink

Export sink para archivos de Cloud Storage.

Representación JSON 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Campos
files[]

object (CloudStorageFile)

Solo salida. Los archivos exportados en Cloud Storage

CloudStorageFile

El archivo de exportación en Cloud Storage

Representación JSON 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Campos
bucketName

string

Es el nombre del bucket de Cloud Storage para el archivo de exportación. Puedes usar este valor en la API de JSON o la API de XML de Cloud Storage, pero no para enumerar el contenido del bucket. En su lugar, puedes obtener archivos de exportación individuales por nombre de objeto.
objectName

string

Es el nombre del objeto de Cloud Storage para el archivo de exportación. Puedes usar este valor en la API de JSON o la API de XML de Cloud Storage.
size

string (int64 format)

El tamaño del archivo de exportación.
md5Hash

string

El hash MD5 del archivo.

Métodos

create

 Crea una exportación.

delete

 Borra una exportación.

get

 Obtiene una exportación.

list

 Muestra detalles sobre las exportaciones en el asunto especificado.