com.google.api.services.vault.v1.model

Class Hold

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.vault.v1.model.Hold

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Hold
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Vault API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Hold()

Method Summary

Modifier and Type	Method and Description
Hold	clone()
List<HeldAccount>	getAccounts() If set, the hold applies to the specified accounts and **orgUnit** must be empty.
String	getCorpus() The service to be searched.
String	getHoldId() The unique immutable ID of the hold.
String	getName() The name of the hold.
HeldOrgUnit	getOrgUnit() If set, the hold applies to all members of the organizational unit and **accounts** must be empty.
CorpusQuery	getQuery() Service-specific options.
String	getUpdateTime() The last time this hold was modified.
Hold	set(String fieldName, Object value)
Hold	setAccounts(List<HeldAccount> accounts) If set, the hold applies to the specified accounts and **orgUnit** must be empty.
Hold	setCorpus(String corpus) The service to be searched.
Hold	setHoldId(String holdId) The unique immutable ID of the hold.
Hold	setName(String name) The name of the hold.
Hold	setOrgUnit(HeldOrgUnit orgUnit) If set, the hold applies to all members of the organizational unit and **accounts** must be empty.
Hold	setQuery(CorpusQuery query) Service-specific options.
Hold	setUpdateTime(String updateTime) The last time this hold was modified.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Hold

public Hold()

Method Detail

getAccounts

public List<HeldAccount> getAccounts()

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

Returns:

value or null for none

setAccounts

public Hold setAccounts(List<HeldAccount> accounts)

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

Parameters:

accounts - accounts or null for none

getCorpus

public String getCorpus()

The service to be searched.

Returns:

value or null for none

setCorpus

public Hold setCorpus(String corpus)

The service to be searched.

Parameters:

corpus - corpus or null for none

getHoldId

public String getHoldId()

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

Returns:

value or null for none

setHoldId

public Hold setHoldId(String holdId)

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

Parameters:

holdId - holdId or null for none

getName

public String getName()

The name of the hold.

Returns:

value or null for none

setName

public Hold setName(String name)

The name of the hold.

Parameters:

name - name or null for none

getOrgUnit

public HeldOrgUnit getOrgUnit()

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**.

Returns:

value or null for none

setOrgUnit

public Hold setOrgUnit(HeldOrgUnit orgUnit)

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**.

Parameters:

orgUnit - orgUnit or null for none

getQuery

public CorpusQuery getQuery()

Service-specific options. If set, **CorpusQuery** must match **CorpusType**.

Returns:

value or null for none

setQuery

public Hold setQuery(CorpusQuery query)

Service-specific options. If set, **CorpusQuery** must match **CorpusType**.

Parameters:

query - query or null for none

getUpdateTime

public String getUpdateTime()

The last time this hold was modified.

Returns:

value or null for none

setUpdateTime

public Hold setUpdateTime(String updateTime)

The last time this hold was modified.

Parameters:

updateTime - updateTime or null for none

set

public Hold set(String fieldName,
                Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Hold clone()

Overrides:

clone in class com.google.api.client.json.GenericJson