REST Resource: matters.holds

Recurso: Hold

Uma espera. Uma guarda de documentos impede que o serviço especificado do Google Workspace exclua dados de contas específicas ou de todos os membros de uma unidade organizacional.

Para trabalhar com recursos do Vault, a conta precisa ter os privilégios necessários do Vault e acesso ao caso. Para acessar um caso, a conta precisa ter criado o caso, ter recebido o compartilhamento dele ou ter o privilégio Ver todos os casos.

Representação JSON 
{
  "holdId": string,
  "name": string,
  "updateTime": string,
  "accounts": [
    {
      object (HeldAccount)
    }
  ],
  "orgUnit": {
    object (HeldOrgUnit)
  },
  "corpus": enum (CorpusType),
  "query": {
    object (CorpusQuery)
  }
}
Campos
holdId

string

O ID exclusivo e imutável da retenção. Atribuído durante a criação.
name

string

O nome da retenção.
updateTime

string (Timestamp format)

A última vez que essa retenção foi modificada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
accounts[]

object (HeldAccount)

Se definido, a guarda de documentos será aplicada às contas especificadas, e orgUnit precisará estar vazio.
orgUnit

object (HeldOrgUnit)

Se definido, a guarda de documentos será aplicada a todos os membros da unidade organizacional, e o campo accounts precisa estar vazio. Essa propriedade é mutável. Para guardas de documentos de grupos, defina contas.
corpus

enum (CorpusType)

O serviço a ser pesquisado.
query

object (CorpusQuery)

Opções específicas do serviço. Se definido, CorpusQuery precisa corresponder a CorpusType.

HeldOrgUnit

A unidade organizacional abrangida por uma retenção. Essa estrutura é imutável.

Representação JSON 
{
  "orgUnitId": string,
  "holdTime": string
}
Campos
orgUnitId

string

O ID imutável da unidade organizacional fornecido pelo SDK Admin.
holdTime

string (Timestamp format)

Quando a unidade organizacional foi colocada em guarda de documentos. Essa propriedade é imutável.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

CorpusQuery

Opções específicas do serviço para suspensões.

Representação 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ão corpus_query. Se definido, precisa corresponder ao tipo de serviço. corpus_query pode ser apenas de um dos tipos a seguir:
driveQuery

object (HeldDriveQuery)

Opções específicas do serviço para retenções do Drive. Se definido, CorpusType precisa ser DRIVE.
mailQuery

object (HeldMailQuery)

Opções específicas do serviço para guardas de retenção do Gmail. Se definido, CorpusType precisa ser MAIL.
groupsQuery

object (HeldGroupsQuery)

Opções específicas do serviço para retenções de grupos. Se definido, CorpusType precisa ser GROUPS.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

Opções específicas do serviço para guardas de retenção do Chat. Se definido, CorpusType precisa ser HANGOUTS_CHAT.
voiceQuery

object (HeldVoiceQuery)

Opções específicas do serviço para retenções de voz. Se definido, CorpusType precisa ser VOICE.
calendarQuery

object (HeldCalendarQuery)

Opções específicas do serviço para retenções da Agenda. Se definido, CorpusType precisa ser CALENDAR.
geminiQuery

object (HeldGeminiQuery)

Opções específicas do serviço para retenções do Gemini. Se definido, CorpusType precisa ser GEMINI.

HeldDriveQuery

Opções para guardas de documentos do Drive.

Representação JSON 
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
Campos
includeTeamDriveFiles
(deprecated)

boolean

Para incluir arquivos em Drives de equipe na retenção, defina como true.
includeSharedDriveFiles

boolean

Para incluir arquivos em drives compartilhados na retenção, defina como true.

HeldMailQuery

Opções de consulta para guardas de retenção do Gmail.

Representação JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Campos
terms

string

Os operadores de pesquisa usados para refinar as mensagens abrangidas pela retenção.
startTime

string (Timestamp format)

O horário de início da consulta. Especifique em GMT. O valor é arredondado para meia-noite na data especificada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

O horário de término da consulta. Especifique em GMT. O valor é arredondado para meia-noite na data especificada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

HeldGroupsQuery

Opções de consulta para suspensões de grupo.

Representação JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Campos
terms

string

Os operadores de pesquisa usados para refinar as mensagens abrangidas pela retenção.
startTime

string (Timestamp format)

O horário de início da consulta. Especifique em GMT. O valor é arredondado para meia-noite na data especificada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

O horário de término da consulta. Especifique em GMT. O valor é arredondado para meia-noite na data especificada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

HeldHangoutsChatQuery

Opções de retenção do Chat.

Representação JSON 
{
  "includeRooms": boolean
}
Campos
includeRooms

boolean

Defina como true para incluir mensagens dos espaços do Chat de que o usuário participou.

HeldVoiceQuery

Opções para retenções de voz.

Representação JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Campos
coveredData[]

enum (VoiceCoveredData)

Uma lista de tipos de dados cobertos pela retenção. Não pode estar vazio. A ordem não importa e os duplicados são ignorados.

HeldCalendarQuery

Esse tipo não tem campos.

Opções de retenção do Google Agenda.

HeldGeminiQuery

Esse tipo não tem campos.

Opções para retenções do Gemini.

Métodos

addHeldAccounts

 Adiciona contas a uma guarda de documentos.

create

 Cria uma guarda de documentos no caso especificado.

delete

 Remove a guarda de documentos especificada e libera as contas ou a unidade organizacional cobertas por ela.

get

 Recebe a suspensão especificada.

list

 Lista as guardas de documentos em um caso.

removeHeldAccounts

 Remove as contas especificadas de uma suspensão.

update

 Atualiza o escopo (unidade organizacional ou contas) e os parâmetros de consulta de uma retenção.