MattersHolds
class MattersHolds extends Resource (View source)
The "holds" collection of methods.
Typical usage is:
$vaultService = new Google\Service\Vault(...);
$holds = $vaultService->matters_holds;Methods
Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold. (holds.addHeldAccounts)
Removes the specified hold and releases the accounts or organizational unit covered by the hold. If the data is not preserved by another hold or retention rule, it might be purged. (holds.delete)
Gets the specified hold. (holds.get)
Lists the holds in a matter. (holds.listMattersHolds)
Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request. (holds.removeHeldAccounts)
Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored. (holds.update)
Details
AddHeldAccountsResponse
addHeldAccounts(string $matterId, string $holdId, AddHeldAccountsRequest $postBody, array $optParams = [])
Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold. (holds.addHeldAccounts)
Hold
create(string $matterId, Hold $postBody, array $optParams = [])
Creates a hold in the specified matter. (holds.create)
VaultEmpty
delete(string $matterId, string $holdId, array $optParams = [])
Removes the specified hold and releases the accounts or organizational unit covered by the hold. If the data is not preserved by another hold or retention rule, it might be purged. (holds.delete)
Hold
get(string $matterId, string $holdId, array $optParams = [])
Gets the specified hold. (holds.get)
ListHoldsResponse
listMattersHolds(string $matterId, array $optParams = [])
Lists the holds in a matter. (holds.listMattersHolds)
RemoveHeldAccountsResponse
removeHeldAccounts(string $matterId, string $holdId, RemoveHeldAccountsRequest $postBody, array $optParams = [])
Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request. (holds.removeHeldAccounts)
Hold
update(string $matterId, string $holdId, Hold $postBody, array $optParams = [])
Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored. (holds.update)