REST Resource: matters.exports

Recurso: Exportar

Una exportación

Para trabajar con los recursos de Vault, la cuenta debe tener los privilegios de Vault necesarios y el acceso al asunto. Para acceder a un asunto, la cuenta debe haber creado el asunto, tenerlo compartido con él 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)
  },
  "cloudStorageSink": {
    object (CloudStorageSink)
  }
}
Campos
id

string

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

string

Solo salida. Es el ID del asunto.
parentExportId

string

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

string

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

object (UserInfo)

Solo salida. 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. La hora en la que se creó la exportación.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
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.
cloudStorageSink

object (CloudStorageSink)

Solo salida. El receptor para los archivos de exportación en Cloud Storage.

UserInfo

Información del usuario.

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

string

La dirección de correo electrónico del usuario.
displayName

string

Es el nombre del usuario que se muestra.

ExportOptions

Opciones adicionales para 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)
  }
  // End of list of possible types for union field corpus_export_options.
}
Campos
region

enum (ExportRegion)

Es la región de datos solicitada para la exportación.
Campo de unión corpus_export_options. 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 de exportación de Gmail.
groupsOptions

object (GroupsExportOptions)

Opciones para exportar grupos.
driveOptions

object (DriveExportOptions)

Opciones para las exportaciones de Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Opciones para las exportaciones de Chat.
voiceOptions

object (VoiceExportOptions)

Opciones para las exportaciones de Voice.

MailExportOptions

Opciones de exportación de Gmail.

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

enum (ExportFormat)

El formato de archivo para los mensajes exportados
showConfidentialModeContent

boolean

Para exportar el contenido en modo confidencial, configúralo en true.
useNewExport

boolean

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

boolean

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

ExportFormat

Formato de exportación de los mensajes

Enumeradores
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.

GroupsExportOptions

Opciones para exportar grupos.

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

enum (ExportFormat)

El formato de archivo para los mensajes exportados

DriveExportOptions

Opciones para las exportaciones de Drive.

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

boolean

Para incluir la información del nivel de acceso de los usuarios con acceso indirecto a los archivos, establécelo en true.

HangoutsChatExportOptions

Opciones para las exportaciones de Chat.

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

enum (ExportFormat)

El formato de archivo para los mensajes exportados

VoiceExportOptions

Opciones de exportación de Voice.

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

enum (ExportFormat)

El formato de archivo para los mensajes de texto exportados

ExportRegion

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

Enumeradores
EXPORT_REGION_UNSPECIFIED No se especificó la región. La configuración predeterminada 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.

Enumeradores
EXPORT_STATUS_UNSPECIFIED El estado no está especificado.
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 del progreso de una exportación.

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

string (int64 format)

La cantidad de mensajes o archivos que ya se procesaron para la exportación.
totalArtifactCount

string (int64 format)

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

string (int64 format)

Tamaño de la exportación expresado en bytes.

CloudStorageSink

Receptor de exportación 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

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

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)

Es el tamaño del archivo de exportación.
md5Hash

string

Es el hash md5 del archivo.

Métodos

create

 Crea una exportación.

delete

 Borra una exportación.

get

 Obtiene una exportación.

list

 Enumera los detalles sobre las exportaciones en el asunto especificado.