REST Resource: matters.holds

Recurso: Hold

Es una retención. La retención impide que el servicio de Google Workspace especificado borre los datos de cuentas específicas o de todos los miembros de una unidad organizativa.

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, debe tenerlo compartido o debe tener el privilegio Ver todos los asuntos.

Representación JSON 
{
  "holdId": string,
  "name": string,
  "updateTime": string,
  "accounts": [
    {
      object (HeldAccount)
    }
  ],
  "orgUnit": {
    object (HeldOrgUnit)
  },
  "corpus": enum (CorpusType),
  "query": {
    object (CorpusQuery)
  }
}
Campos
holdId

string

Es el ID único e inmutable de la retención. Se asigna durante la creación.
name

string

Es el nombre de la retención.
updateTime

string (Timestamp format)

Es la última vez que se modificó esta retención.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
accounts[]

object (HeldAccount)

Si se configura, la retención se aplica a las cuentas especificadas y orgUnit debe estar vacío.
orgUnit

object (HeldOrgUnit)

Si se configura, la suspensión se aplica a todos los miembros de la unidad organizativa y las cuentas deben estar vacías. Esta propiedad es mutable. Para las suspensiones de Grupos, configura cuentas.
corpus

enum (CorpusType)

Es el servicio en el que se realizará la búsqueda.
query

object (CorpusQuery)

Son opciones específicas del servicio. Si se configura, CorpusQuery debe coincidir con CorpusType.

HeldOrgUnit

Es la unidad organizativa a la que se aplica una conservación. Esta estructura es inmutable.

Representación JSON 
{
  "orgUnitId": string,
  "holdTime": string
}
Campos
orgUnitId

string

Es el ID inmutable de la unidad organizativa que proporciona el SDK de Admin.
holdTime

string (Timestamp format)

Fecha y hora en que se aplicó la conservación a la unidad organizativa. Esta propiedad es inmutable.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

CorpusQuery

Son opciones específicas del servicio para las retenciones.

Representación JSON 
{

  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  },
  "geminiQuery": {
    object (HeldGeminiQuery)
  }
}
Campos
Campo de unión corpus_query. Si se configura, debe coincidir con el tipo de servicio. corpus_query puede ser solo uno de los parámetros siguientes:
driveQuery

object (HeldDriveQuery)

Son opciones específicas del servicio para las retenciones de Drive. Si se configura, CorpusType debe ser DRIVE.
mailQuery

object (HeldMailQuery)

Son opciones específicas del servicio para las retenciones de Gmail. Si se configura, CorpusType debe ser MAIL.
groupsQuery

object (HeldGroupsQuery)

Son opciones específicas del servicio para las retenciones de Grupos. Si se configura, CorpusType debe ser GROUPS.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

Son opciones específicas del servicio para las conservaciones de Chat. Si se configura, CorpusType debe ser HANGOUTS_CHAT.
voiceQuery

object (HeldVoiceQuery)

Son opciones específicas del servicio para las llamadas en espera por voz. Si se configura, CorpusType debe ser VOICE.
calendarQuery

object (HeldCalendarQuery)

Son opciones específicas del servicio para las retenciones del Calendario. Si se configura, CorpusType debe ser CALENDAR.
geminiQuery

object (HeldGeminiQuery)

Son opciones específicas del servicio para las retenciones de Gemini. Si se configura, CorpusType debe ser GEMINI.

HeldDriveQuery

Son las opciones para las retenciones de Drive.

Representación JSON 
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
Campos
includeTeamDriveFiles
(deprecated)

boolean

Se debe establecer en true para incluir los archivos de las unidades de equipo en la retención.
includeSharedDriveFiles

boolean

Se debe establecer en true para incluir archivos en unidades compartidas en la retención.

HeldMailQuery

Son opciones de consulta para las conservaciones de Gmail.

Representación JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Campos
terms

string

Los operadores de búsqueda que se usan para definir mejor los mensajes sujetos a la conservación.
startTime

string (Timestamp format)

Es la hora de inicio de la búsqueda. Especifica en GMT. El valor se redondea a las 12 a.m. de la fecha especificada.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Es la hora de finalización de la búsqueda. Especifica en GMT. El valor se redondea a las 12 a.m. de la fecha especificada.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

HeldGroupsQuery

Son las opciones de consulta para las conservaciones grupales.

Representación JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Campos
terms

string

Los operadores de búsqueda que se usan para definir mejor los mensajes sujetos a la conservación.
startTime

string (Timestamp format)

Es la hora de inicio de la búsqueda. Especifica en GMT. El valor se redondea a las 12 a.m. de la fecha especificada.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Es la hora de finalización de la búsqueda. Especifica en GMT. El valor se redondea a las 12 a.m. de la fecha especificada.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

HeldHangoutsChatQuery

Son las opciones para las conservaciones de Chat.

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

boolean

Se debe establecer en true para incluir los mensajes de los espacios de Chat de los que el usuario era miembro.

HeldVoiceQuery

Son las opciones para las retenciones de voz.

Representación JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Campos
coveredData[]

enum (VoiceCoveredData)

Es una lista de los tipos de datos que abarca la conservación. No debe estar vacío. El orden no importa y se ignoran los duplicados.

HeldCalendarQuery

Este tipo no tiene campos.

Son las opciones para las retenciones del calendario.

HeldGeminiQuery

Este tipo no tiene campos.

Son las opciones para las retenciones de Gemini.

Métodos

addHeldAccounts

 Agrega cuentas a una conservación.

create

 Crea una conservación en el asunto especificado.

delete

 Quita la retención especificada y libera las cuentas o la unidad organizativa que abarca la retención.

get

 Obtiene la retención especificada.

list

 Enumera las conservaciones de un asunto.

removeHeldAccounts

 Quita las cuentas especificadas de una retención.

update

 Actualiza el alcance (unidad organizativa o cuentas) y los parámetros de consulta de una conservación.