REST Resource: matters.exports

Recurso: Exportar

Una exportación.

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

Representación 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

Solo salida. El ID de exportación que se generó.
matterId

string

Solo salida. El ID del asunto.
name

string

El nombre de la exportación. No uses caracteres especiales (~!$'(),;@:/?), ya que pueden impedirte descargar exportaciones.
requester

object (UserInfo)

Solo salida. El solicitante de la exportación.
query

object (Query)

Los parámetros de consulta que se usan 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 decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
status

enum (ExportStatus)

Solo salida. 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 de 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

El nombre visible del usuario.

Opciones de exportación

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)

La región de datos solicitada para la exportación.
Campo de unión corpus_export_options. Opciones de exportación de servicios específicos. 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 de Google.
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.

Opciones de MailExport

Opciones para las exportaciones de Gmail.

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

enum (ExportFormat)

El formato de archivo de los mensajes exportados.
showConfidentialModeContent

boolean

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

boolean

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

Formato de exportación

Formato de exportación de mensajes

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

Opciones de exportación de grupos

Opciones para las exportaciones de Grupos de Google.

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

enum (ExportFormat)

El formato de archivo de los mensajes exportados.

Opciones de DriveExport

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 que tienen acceso indirecto a los archivos, configúrelo como true.

Opciones de Hangouts Chat Export

Opciones para las exportaciones de Chat.

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

enum (ExportFormat)

El formato de archivo de los mensajes exportados.

Opciones de VoiceExport

Opciones para las exportaciones de Voice

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

enum (ExportFormat)

El formato de archivo para los mensajes de texto exportados.

Región de exportación

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

Enumeradores
EXPORT_REGION_UNSPECIFIED La región no está especificada. La configuración predeterminada es ANY.
ANY Cualquier región.
US Región de los Estados Unidos.
EUROPE Región de Europa.

Estado de exportación

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.

Estadísticas de exportación

Información de 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 ya procesados para exportar
totalArtifactCount

string (int64 format)

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

string (int64 format)

El tamaño de la exportación en bytes.

Receptor de Cloud Storage

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.

Archivo de Cloud Storage

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 las API de JSON o 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 las API de JSON o 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

 Enumera los detalles sobre las exportaciones en el asunto especificado.