The "holds" collection of methods. Typical usage is:
$vaultService = new Google_Service_Vault(...);
$holds = $vaultService->holds;
Methods summary
public
Google_Service_Vault_AddHeldAccountsResponse
|
#
addHeldAccounts( string $matterId, string $holdId, Google_Service_Vault_AddHeldAccountsRequest $postBody, array $optParams = array() )
Adds HeldAccounts to a hold. Returns a list of accounts that have been
successfully added. Accounts can only be added to an existing account-based
hold. (holds.addHeldAccounts)
Adds HeldAccounts to a hold. Returns a list of accounts that have been
successfully added. Accounts can only be added to an existing account-based
hold. (holds.addHeldAccounts)
Parameters
- $matterId
- The matter ID.
- $holdId
- The hold ID.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Vault_Hold
|
#
create( string $matterId, Google_Service_Vault_Hold $postBody, array $optParams = array() )
Creates a hold in the given matter. (holds.create)
Creates a hold in the given matter. (holds.create)
Parameters
- $matterId
- The matter ID.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Vault_VaultEmpty
|
#
delete( string $matterId, string $holdId, array $optParams = array() )
Removes a hold by ID. This will release any HeldAccounts on this Hold.
(holds.delete)
Removes a hold by ID. This will release any HeldAccounts on this Hold.
(holds.delete)
Parameters
- $matterId
- The matter ID.
- $holdId
- The hold ID.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Vault_Hold
|
#
get( string $matterId, string $holdId, array $optParams = array() )
Gets a hold by ID. (holds.get)
Gets a hold by ID. (holds.get)
Parameters
- $matterId
- The matter ID.
- $holdId
- The hold ID.
- $optParams
- Optional parameters.
Returns
Opt_param
string view Specifies which parts of the Hold to return.
|
public
Google_Service_Vault_ListHoldsResponse
|
#
listMattersHolds( string $matterId, array $optParams = array() )
Lists holds within a matter. An empty page token in ListHoldsResponse denotes
no more holds to list. (holds.listMattersHolds)
Lists holds within a matter. An empty page token in ListHoldsResponse denotes
no more holds to list. (holds.listMattersHolds)
Parameters
- $matterId
- The matter ID.
- $optParams
- Optional parameters.
Returns
Opt_param
string pageToken The pagination token as returned in the response. An empty
token means start from the beginning.
int pageSize The number of holds to return in the response, between 0 and 100
inclusive. Leaving this empty, or as 0, is the same as page_size = 100.
string view Specifies which parts of the Hold to return.
|
public
Google_Service_Vault_RemoveHeldAccountsResponse
|
#
removeHeldAccounts( string $matterId, string $holdId, Google_Service_Vault_RemoveHeldAccountsRequest $postBody, array $optParams = array() )
Removes HeldAccounts from a hold. Returns a list of statuses in the same
order as the request. If this request leaves the hold with no held accounts, the
hold will not apply to any accounts. (holds.removeHeldAccounts)
Removes HeldAccounts from a hold. Returns a list of statuses in the same
order as the request. If this request leaves the hold with no held accounts, the
hold will not apply to any accounts. (holds.removeHeldAccounts)
Parameters
- $matterId
- The matter ID.
- $holdId
- The hold ID.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Vault_Hold
|
#
update( string $matterId, string $holdId, Google_Service_Vault_Hold $postBody, array $optParams = array() )
Updates the OU and/or query parameters of a hold. You cannot add accounts to
a hold that covers an OU, nor can you add OUs to a hold that covers individual
accounts. Accounts listed in the hold will be ignored. (holds.update)
Updates the OU and/or query parameters of a hold. You cannot add accounts to
a hold that covers an OU, nor can you add OUs to a hold that covers individual
accounts. Accounts listed in the hold will be ignored. (holds.update)
Parameters
- $matterId
- The matter ID.
- $holdId
- The ID of the hold.
- $postBody
- $optParams
- Optional parameters.
Returns
|
Google_Service_Vault_MattersHolds_Resource