REST Resource: matters.holds

Recurso: Hold

Una retención. Una 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, compartirlo con ella o 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

El ID inmutable único 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 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".
accounts[]

object (HeldAccount)

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

object (HeldOrgUnit)

Si se establece, la retenció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, establece cuentas.
corpus

enum (CorpusType)

Es el servicio que se buscará.
query

object (CorpusQuery)

Opciones específicas del servicio Si se establece, CorpusQuery debe coincidir con CorpusType.

HeldOrgUnit

La unidad organizativa cubierta por una retención Esta estructura es inmutable.

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

string

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

string (Timestamp format)

Cuándo se puso en espera la unidad organizativa Esta propiedad es inmutable.

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

CorpusQuery

Opciones específicas del servicio para las retenciones

Representación JSON 
{

  // Union field corpus_query can be only one of the following:
  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  }
  // End of list of possible types for union field corpus_query.
}
Campos
Campo de unión corpus_query. Si se establece, debe coincidir con el tipo de servicio. Las direcciones (corpus_query) solo pueden ser una de las siguientes opciones:
driveQuery

object (HeldDriveQuery)

Opciones específicas del servicio para las retenciones de Drive Si se establece, CorpusType debe ser DRIVE.
mailQuery

object (HeldMailQuery)

Opciones específicas del servicio para las retenciones de Gmail Si se establece, CorpusType debe ser MAIL.
groupsQuery

object (HeldGroupsQuery)

Se suspendieron las opciones específicas del servicio para Grupos. Si se establece, CorpusType debe ser GROUPS.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

Opciones específicas del servicio para las retenciones de Chat Si se establece, CorpusType debe ser HANGOUTS_CHAT.
voiceQuery

object (HeldVoiceQuery)

Opciones específicas del servicio para las puestas en espera por voz Si se establece, CorpusType debe ser VOICE.
calendarQuery

object (HeldCalendarQuery)

Opciones específicas del servicio para las retenciones del Calendario Si se establece, CorpusType debe ser CALENDAR.

HeldDriveQuery

Opciones para las retenciones de Drive

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

boolean

Para incluir archivos de Unidades de equipo en la retención, configúralo como true.
includeSharedDriveFiles

boolean

Para incluir archivos de unidades compartidas en la retención, configúralo como true.

HeldMailQuery

Opciones de consulta para las retenciones 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 afectados por la retención
startTime

string (Timestamp format)

La hora de inicio de la consulta. Especifica en GMT. El valor se redondea a las 12 a.m. de la fecha especificada.

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".
endTime

string (Timestamp format)

La hora de finalización de la consulta. Especifica en GMT. El valor se redondea a las 12 a.m. de la fecha especificada.

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

HeldGroupsQuery

Opciones de consulta para las retenciones 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 afectados por la retención
startTime

string (Timestamp format)

La hora de inicio de la consulta. Especifica en GMT. El valor se redondea a las 12 a.m. de la fecha especificada.

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".
endTime

string (Timestamp format)

La hora de finalización de la consulta. Especifica en GMT. El valor se redondea a las 12 a.m. de la fecha especificada.

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

HeldHangoutsChatQuery

Opciones para las retenciones de Chat

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

boolean

Para incluir mensajes en los espacios de Chat de los que era miembro el usuario, configúralo como true.

HeldVoiceQuery

Opciones para las pausas por voz

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

enum (VoiceCoveredData)

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

HeldCalendarQuery

Este tipo no tiene campos.

Opciones para las retenciones del Calendario

Métodos

addHeldAccounts

 Agrega cuentas a una retención.

create

 Crea una retención en el asunto especificado.

delete

 Quita la retención especificada y libera las cuentas o la unidad organizativa que se encuentran retenidas.

get

 Obtiene la retención especificada.

list

 Muestra una lista de las retenciones 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 retención.