REST Resource: matters.holds

Ressource: Hold

Une retenue. Une obligation de conservation empêche le service Google Workspace spécifié de purger les données pour des comptes spécifiques ou pour tous les membres d'une unité organisationnelle.

Pour utiliser les ressources Vault, le compte doit disposer des droits Vault requis et avoir accès au litige. Pour accéder à un litige, le compte doit l'avoir créé, l'avoir partagé avec lui ou disposer du droit Afficher tous les litiges.

Représentation JSON 
{
  "holdId": string,
  "name": string,
  "updateTime": string,
  "accounts": [
    {
      object (HeldAccount)
    }
  ],
  "orgUnit": {
    object (HeldOrgUnit)
  },
  "corpus": enum (CorpusType),
  "query": {
    object (CorpusQuery)
  }
}
Champs
holdId

string

Identifiant unique et immuable de la retenue. Attribué lors de la création.
name

string

Nom de la retenue.
updateTime

string (Timestamp format)

Date de la dernière modification de cette retenue.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
accounts[]

object (HeldAccount)

Si ce champ est défini, l'obligation de conservation s'applique aux comptes spécifiés et orgUnit doit être vide.
orgUnit

object (HeldOrgUnit)

Si elle est définie, l'obligation de conservation s'applique à tous les membres de l'unité organisationnelle et le champ comptes doit être vide. Cette propriété est modifiable. Pour les obligations de conservation appliquées aux groupes, définissez comptes.
corpus

enum (CorpusType)

Service à rechercher.
query

object (CorpusQuery)

Options spécifiques au service. Si elle est définie, CorpusQuery doit correspondre à CorpusType.

HeldOrgUnit

Unité organisationnelle soumise à une obligation de conservation. Cette structure est immuable.

Représentation JSON 
{
  "orgUnitId": string,
  "holdTime": string
}
Champs
orgUnitId

string

ID immuable de l'unité organisationnelle fourni par le SDK Admin.
holdTime

string (Timestamp format)

Date à laquelle l'unité organisationnelle a été mise en attente. Cette propriété est immuable.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

CorpusQuery

Options spécifiques au service pour les réservations.

Représentation 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.
}
Champs
Champ d'union corpus_query. S'il est défini, il doit correspondre au type de service. corpus_query ne peut être qu'un des éléments suivants :
driveQuery

object (HeldDriveQuery)

Options spécifiques au service pour les retenues Drive Si défini, CorpusType doit être DRIVE.
mailQuery

object (HeldMailQuery)

Options spécifiques au service pour les procédures de préservation à titre conservatoire Gmail Si défini, CorpusType doit être MAIL.
groupsQuery

object (HeldGroupsQuery)

Options spécifiques au service pour les réservations Groups Si elle est définie, CorpusType doit être GROUPS.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

Options spécifiques au service pour les obligations de conservation Chat. Si défini, CorpusType doit être HANGOUTS_CHAT.
voiceQuery

object (HeldVoiceQuery)

Options spécifiques au service pour les mises en attente Voice. Si défini, CorpusType doit être VOICE.
calendarQuery

object (HeldCalendarQuery)

Options spécifiques au service pour les réservations Agenda. Si défini, CorpusType doit être CALENDAR.

HeldDriveQuery

Options pour les obligations de conservation Drive

Représentation JSON 
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
Champs
includeTeamDriveFiles
(deprecated)

boolean

Pour inclure les fichiers de Drive d'équipe dans la retenue, définissez la valeur sur true.
includeSharedDriveFiles

boolean

Pour inclure les fichiers des Drive partagés dans la retenue, définissez la valeur sur true.

HeldMailQuery

Options de requête pour les procédures de préservation à titre conservatoire Gmail.

Représentation JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Champs
terms

string

Les opérateurs de recherche utilisés pour affiner les messages concernés par la conservation.
startTime

string (Timestamp format)

Heure de début de la requête. Spécifiez le fuseau horaire GMT. La valeur est arrondie à minuit pour la date spécifiée.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Heure de fin de la requête. Spécifiez le fuseau horaire GMT. La valeur est arrondie à minuit pour la date spécifiée.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

HeldGroupsQuery

Options de requête pour les procédures de préservation à titre conservatoire appliquées aux groupes.

Représentation JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Champs
terms

string

Les opérateurs de recherche utilisés pour affiner les messages concernés par la conservation.
startTime

string (Timestamp format)

Heure de début de la requête. Spécifiez le fuseau horaire GMT. La valeur est arrondie à minuit pour la date spécifiée.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Heure de fin de la requête. Spécifiez le fuseau horaire GMT. La valeur est arrondie à minuit pour la date spécifiée.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

HeldHangoutsChatQuery

Options pour les obligations de conservation Chat.

Représentation JSON 
{
  "includeRooms": boolean
}
Champs
includeRooms

boolean

Pour inclure les messages des espaces Chat dont l'utilisateur était membre, définissez la valeur sur true.

HeldVoiceQuery

Options pour les mises en attente Voice.

Représentation JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Champs
coveredData[]

enum (VoiceCoveredData)

Liste des types de données concernés par la retenue. Ne doit pas être vide. L'ordre n'a pas d'importance et les doublons sont ignorés.

HeldCalendarQuery

Ce type ne comporte aucun champ.

Options pour les réservations dans Agenda.

Méthodes

addHeldAccounts

 Ajoute des comptes à une obligation de conservation.

create

 Crée une obligation de conservation dans le litige spécifié.

delete

 Supprime l'obligation de conservation spécifiée et libère les comptes ou l'unité organisationnelle concernés.

get

 Récupère la retenue spécifiée.

list

 Répertorie les obligations de conservation associées à un litige.

removeHeldAccounts

 Supprime les comptes spécifiés d'une retenue.

update

 Met à jour le champ d'application (unité organisationnelle ou comptes) et les paramètres de requête d'une retenue.