REST Resource: matters.holds

Recurso: espera

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

Para trabalhar com os recursos do Vault, a conta precisa ter os privilégios necessários e acesso ao caso. Para acessar um caso, a conta precisa ter criado o caso, ter recebido o compartilhamento do caso ou ter o privilégio Acessar 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 a retenção foi modificada.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" 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 as contas precisarão estar vazias. 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 coberta por uma suspensã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 RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" 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 retenções.

Representação 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ã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 as guardas de retenção do Gmail. Se definido, CorpusType precisa ser MAIL.
groupsQuery

object (HeldGroupsQuery)

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

object (HeldHangoutsChatQuery)

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

object (HeldVoiceQuery)

Opções específicas do serviço para chamadas em espera do Voice. Se definido, o 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.

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 retenções do Gmail.

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

string

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

string (Timestamp format)

O horário de início da consulta. Especifique em GMT. O valor é arredondado para 0h da data especificada.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" 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 0h da data especificada.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" 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 guardas de documentos do grupo.

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

string

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

string (Timestamp format)

O horário de início da consulta. Especifique em GMT. O valor é arredondado para 0h da data especificada.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" 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 0h da data especificada.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" 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 para guardas de documentos no Chat.

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

boolean

Para incluir mensagens em espaços do Chat em que o usuário era membro, defina como true.

HeldVoiceQuery

Opções para chamadas em espera do Voice.

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

enum (VoiceCoveredData)

Uma lista de tipos de dados cobertos pela retenção. Precisa não estar vazio. A ordem não importa, e as duplicatas são ignoradas.

HeldCalendarQuery

Esse tipo não tem campos.

Opções para retenções da Agenda.

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 coberta por ela.

get

 Recebe a retençã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 guarda.