Overview

Classes

  • Google_Service_Vault
  • Google_Service_Vault_AccountInfo
  • Google_Service_Vault_AddHeldAccountResult
  • Google_Service_Vault_AddHeldAccountsRequest
  • Google_Service_Vault_AddHeldAccountsResponse
  • Google_Service_Vault_AddMatterPermissionsRequest
  • Google_Service_Vault_CloseMatterRequest
  • Google_Service_Vault_CloseMatterResponse
  • Google_Service_Vault_CloudStorageFile
  • Google_Service_Vault_CloudStorageSink
  • Google_Service_Vault_CorpusQuery
  • Google_Service_Vault_DriveExportOptions
  • Google_Service_Vault_DriveOptions
  • Google_Service_Vault_Export
  • Google_Service_Vault_ExportOptions
  • Google_Service_Vault_ExportStats
  • Google_Service_Vault_GroupsExportOptions
  • Google_Service_Vault_HangoutsChatExportOptions
  • Google_Service_Vault_HangoutsChatInfo
  • Google_Service_Vault_HangoutsChatOptions
  • Google_Service_Vault_HeldAccount
  • Google_Service_Vault_HeldDriveQuery
  • Google_Service_Vault_HeldGroupsQuery
  • Google_Service_Vault_HeldHangoutsChatQuery
  • Google_Service_Vault_HeldMailQuery
  • Google_Service_Vault_HeldOrgUnit
  • Google_Service_Vault_Hold
  • Google_Service_Vault_ListExportsResponse
  • Google_Service_Vault_ListHeldAccountsResponse
  • Google_Service_Vault_ListHoldsResponse
  • Google_Service_Vault_ListMattersResponse
  • Google_Service_Vault_ListSavedQueriesResponse
  • Google_Service_Vault_MailExportOptions
  • Google_Service_Vault_MailOptions
  • Google_Service_Vault_Matter
  • Google_Service_Vault_MatterPermission
  • Google_Service_Vault_Matters_Resource
  • Google_Service_Vault_MattersExports_Resource
  • Google_Service_Vault_MattersHolds_Resource
  • Google_Service_Vault_MattersHoldsAccounts_Resource
  • Google_Service_Vault_MattersSavedQueries_Resource
  • Google_Service_Vault_Operations_Resource
  • Google_Service_Vault_OrgUnitInfo
  • Google_Service_Vault_Query
  • Google_Service_Vault_RemoveHeldAccountsRequest
  • Google_Service_Vault_RemoveHeldAccountsResponse
  • Google_Service_Vault_RemoveMatterPermissionsRequest
  • Google_Service_Vault_ReopenMatterRequest
  • Google_Service_Vault_ReopenMatterResponse
  • Google_Service_Vault_SavedQuery
  • Google_Service_Vault_SharedDriveInfo
  • Google_Service_Vault_Status
  • Google_Service_Vault_TeamDriveInfo
  • Google_Service_Vault_UndeleteMatterRequest
  • Google_Service_Vault_UserInfo
  • Google_Service_Vault_VaultEmpty
  • Overview
  • Class
  • Tree

Class Google_Service_Vault_MattersHolds_Resource

The "holds" collection of methods. Typical usage is:

 $vaultService = new Google_Service_Vault(...);
 $holds = $vaultService->holds;
Google_Service_Resource
Extended by Google_Service_Vault_MattersHolds_Resource
Located at Vault.php
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

Google_Service_Vault_AddHeldAccountsResponse
Google_Service_Vault_AddHeldAccountsResponse
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

Google_Service_Vault_Hold
Google_Service_Vault_Hold
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

Google_Service_Vault_VaultEmpty
Google_Service_Vault_VaultEmpty
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

Google_Service_Vault_Hold
Google_Service_Vault_Hold

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

Google_Service_Vault_ListHoldsResponse
Google_Service_Vault_ListHoldsResponse

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

Google_Service_Vault_RemoveHeldAccountsResponse
Google_Service_Vault_RemoveHeldAccountsResponse
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_Hold
Google_Service_Vault_Hold
© 2020 Google Inc.
G Suite Vault API documentation generated by ApiGen 2.8.0