REST Resource: matters.holds

Recurso: Hold

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

Para usar 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 ou compartilhado o caso 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 imutável da retenção. Atribuído durante a criação.
name

string

O nome da guarda de documentos.
updateTime

string (Timestamp format)

Mostra a última vez que esta retenção foi modificada.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
accounts[]

object (HeldAccount)

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

object (HeldOrgUnit)

Se definida, a guarda de documentos é aplicável a todos os membros da unidade organizacional e as contas precisam estar vazias. Esta propriedade é mutável. Para guardas de documentos do 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 guarda de documentos. Essa estrutura é imutável.

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

string

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

string (Timestamp format)

Quando a unidade organizacional foi colocada em espera. Esta propriedade é imutável.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

CorpusQuery

Opções específicas do serviço para guardas de documentos.

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)
  }
  // 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 guardas de documentos do Drive. Se definido, CorpusType precisará ser DRIVE.
mailQuery

object (HeldMailQuery)

Opções específicas do serviço para guardas de documentos do Gmail. Se definido, CorpusType precisará ser MAIL.
groupsQuery

object (HeldGroupsQuery)

Opções específicas do serviço para guardas de documentos do Grupos Se definido, CorpusType precisará ser GROUPS.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

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

object (HeldVoiceQuery)

Opções específicas do serviço para guardas de documentos do Voice. Se definido, CorpusType precisará ser VOICE.

HeldDriveQuery

Opções de guardas de documentos do Drive.

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

boolean

Para incluir arquivos em Drives de equipe na guarda de documentos, defina como true.
includeSharedDriveFiles

boolean

Para incluir arquivos em drives compartilhados na guarda de documentos, defina como true.

HeldMailQuery

Opções de consulta para guardas de documentos 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 guarda de documentos.
startTime

string (Timestamp format)

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

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

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

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

HeldGroupsQuery

Opções de consulta para guardas de documentos de grupo.

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

string

Os operadores de pesquisa usados para refinar as mensagens cobertas pela guarda de documentos.
startTime

string (Timestamp format)

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

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

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

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

HeldHangoutsChatQuery

Opções de guardas de documentos do Chat.

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

boolean

Para incluir mensagens nos espaços do Chat de que o usuário participava, defina como true.

HeldVoiceQuery

Opções de guardas de documentos do Voice.

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

enum (VoiceCoveredData)

Uma lista dos tipos de dados cobertos pela guarda de documentos. Não pode estar em branco. A ordem não importa, e duplicatas são ignoradas.

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.

get

 Recebe a retenção especificada.

list

 Lista as guardas de documentos em um caso.

removeHeldAccounts

 Remove as contas especificadas da guarda de documentos.

update

 Atualiza o escopo (unidade organizacional ou contas) e parâmetros de consulta de uma guarda de documentos.