GoogleApi.Vault.V1.Model.Hold (google_api_vault v0.25.0)

A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the View All Matters privilege.

Attributes

accounts (type: list(GoogleApi.Vault.V1.Model.HeldAccount.t), default: nil) - If set, the hold applies to the specified accounts and orgUnit must be empty.
corpus (type: String.t, default: nil) - The service to be searched.
holdId (type: String.t, default: nil) - The unique immutable ID of the hold. Assigned during creation.
name (type: String.t, default: nil) - The name of the hold.
orgUnit (type: GoogleApi.Vault.V1.Model.HeldOrgUnit.t, default: nil) - If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For Groups holds, set accounts.
query (type: GoogleApi.Vault.V1.Model.CorpusQuery.t, default: nil) - Service-specific options. If set, CorpusQuery must match CorpusType.
updateTime (type: DateTime.t, default: nil) - The last time this hold was modified.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Vault.V1.Model.Hold{
  accounts: [GoogleApi.Vault.V1.Model.HeldAccount.t()] | nil,
  corpus: String.t() | nil,
  holdId: String.t() | nil,
  name: String.t() | nil,
  orgUnit: GoogleApi.Vault.V1.Model.HeldOrgUnit.t() | nil,
  query: GoogleApi.Vault.V1.Model.CorpusQuery.t() | nil,
  updateTime: DateTime.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.