google_api_vault v0.3.0 GoogleApi.Vault.V1.Model.Hold View Source

Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.

Attributes

  • accounts ([HeldAccount]): If set, the hold applies to the enumerated accounts and org_unit must be empty. Defaults to: null.
  • corpus (String.t): The corpus to be searched. Defaults to: null.

    • Enum - one of [CORPUS_TYPE_UNSPECIFIED, DRIVE, MAIL, GROUPS, HANGOUTS_CHAT]
  • holdId (String.t): The unique immutable ID of the hold. Assigned during creation. Defaults to: null.
  • name (String.t): The name of the hold. Defaults to: null.
  • orgUnit (HeldOrgUnit): 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 the accounts field. Defaults to: null.
  • query (CorpusQuery): The corpus-specific query. If set, the corpusQuery must match corpus type. Defaults to: null.
  • updateTime (DateTime.t): The last time this hold was modified. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.Vault.V1.Model.Hold{
  accounts: [GoogleApi.Vault.V1.Model.HeldAccount.t()],
  corpus: any(),
  holdId: any(),
  name: any(),
  orgUnit: GoogleApi.Vault.V1.Model.HeldOrgUnit.t(),
  query: GoogleApi.Vault.V1.Model.CorpusQuery.t(),
  updateTime: DateTime.t()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.