REST Resource: matters.holds

Recurso: Retener

Una llamada en espera. Una conservación impide que el servicio de Google Workspace especificado borre definitivamente 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 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 
{
  "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 conservación. Asignado durante la creación.
name

string

El nombre de la conservación.
updateTime

string (Timestamp format)

La última vez que se modificó esta conservació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".
accounts[]

object (HeldAccount)

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

object (HeldOrgUnit)

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

enum (CorpusType)

El servicio que se buscará.
query

object (CorpusQuery)

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

HeldOrgUnit

La unidad organizativa cubierta por una conservació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)

Cuando se puso en espera la unidad organizativa. Esta propiedad es inmutable.

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

CorpusQuery

Opciones específicas del servicio para las conservaciones.

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)
  }
  // End of list of possible types for union field corpus_query.
}
Campos
Campo de unión corpus_query. Si se configura, 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 conservaciones de Drive Si se configura, CorpusType debe ser DRIVE.
mailQuery

object (HeldMailQuery)

Opciones específicas del servicio para las conservaciones de Gmail Si se establece, CorpusType debe ser CORREO ELECTRÓNICO.
groupsQuery

object (HeldGroupsQuery)

Opciones específicas del servicio para las conservaciones de Grupos Si se establece, CorpusType debe ser GRUPOS.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

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

object (HeldVoiceQuery)

Opciones específicas del servicio para las conservaciones por voz Si se configura, CorpusType debe ser VOICE.

HeldDriveQuery

Opciones para las conservaciones de Drive.

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

boolean

Para incluir los archivos de las unidades de equipo en la conservación, configúralo como true.
includeSharedDriveFiles

boolean

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

HeldMailQuery

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 que abarca la conservación
startTime

string (Timestamp format)

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

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

string (Timestamp format)

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

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

HeldGroupsQuery

Opciones de consulta para 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 que abarca la conservación
startTime

string (Timestamp format)

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

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

string (Timestamp format)

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

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

HeldHangoutsChatQuery

Opciones para las conservaciones 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 conservaciones por voz

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

enum (VoiceCoveredData)

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

Métodos

addHeldAccounts

 Agrega cuentas a una conservación.

create

 Crea una conservación en el asunto especificado.

delete

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

get

 Obtiene la conservación especificada.

list

 Enumera las conservaciones de un asunto.

removeHeldAccounts

 Quita las cuentas especificadas de una conservación.

update

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