Team Drives-related fields in the Vault API are being replaced. Learn more.

REST Resource: matters.holds

Resource: Hold

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.

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

string

The unique immutable ID of the hold. Assigned during creation.

name

string

The name of the hold.

updateTime

string (Timestamp format)

The last time this hold was modified.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

accounts[]

object (HeldAccount)

If set, the hold applies to the enumerated accounts and orgUnit must be empty.

orgUnit

object (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.

corpus

enum (CorpusType)

The corpus to be searched.

query

object (CorpusQuery)

The corpus-specific query. If set, the corpusQuery must match corpus type.

HeldOrgUnit

A organizational unit being held in a particular hold. This structure is immutable.

JSON representation
{
  "orgUnitId": string,
  "holdTime": string
}
Fields
orgUnitId

string

The org unit's immutable ID as provided by the Admin SDK.

holdTime

string (Timestamp format)

When the org unit was put on hold. This property is immutable.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

CorpusQuery

Corpus specific queries.

JSON representation
{

  // Union field corpus_query can be only one of the following:
  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  }
  // End of list of possible types for union field corpus_query.
}
Fields
Union field corpus_query. If set, this must match the corpus type. corpus_query can be only one of the following:
driveQuery

object (HeldDriveQuery)

Details pertaining to Drive holds. If set, corpus must be Drive.

mailQuery

object (HeldMailQuery)

Details pertaining to mail holds. If set, corpus must be mail.

groupsQuery

object (HeldGroupsQuery)

Details pertaining to Groups holds. If set, corpus must be Groups.

hangoutsChatQuery

object (HeldHangoutsChatQuery)

Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.

HeldDriveQuery

Query options for Drive holds.

JSON representation
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
Fields
includeTeamDriveFiles
(deprecated)

boolean

If true, include files in Team Drives in the hold.

includeSharedDriveFiles

boolean

If true, include files in shared drives in the hold.

HeldMailQuery

Query options for mail holds.

JSON representation
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Fields
terms

string

The search terms for the hold.

startTime

string (Timestamp format)

The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

HeldGroupsQuery

Query options for group holds.

JSON representation
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Fields
terms

string

The search terms for the hold.

startTime

string (Timestamp format)

The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

HeldHangoutsChatQuery

Query options for hangouts chat holds.

JSON representation
{
  "includeRooms": boolean
}
Fields
includeRooms

boolean

If true, include rooms the user has participated in.

Methods

addHeldAccounts

Adds HeldAccounts to a hold.

create

Creates a hold in the given matter.

delete

Removes a hold by ID.

get

Gets a hold by ID.

list

Lists holds within a matter.

removeHeldAccounts

Removes HeldAccounts from a hold.

update

Updates the OU and/or query parameters of a hold.