Documentation

Google_Service_Vault_Resource_MattersHolds extends Google_Service_Resource
in package

Application

The "holds" collection of methods.

Typical usage is: $vaultService = new Google_Service_Vault(...); $holds = $vaultService->holds;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
addHeldAccounts() : Google_Service_Vault_AddHeldAccountsResponse: 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)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_Vault_Hold: Creates a hold in the given matter. (holds.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Vault_VaultEmpty: Removes a hold by ID. This will release any HeldAccounts on this Hold.
get() : Google_Service_Vault_Hold: Gets a hold by ID. (holds.get)
listMattersHolds() : Google_Service_Vault_ListHoldsResponse: Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list. (holds.listMattersHolds)
removeHeldAccounts() : Google_Service_Vault_RemoveHeldAccountsResponse: 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)
update() : Google_Service_Vault_Hold: 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.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

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)


    public
                addHeldAccounts(string $matterId, string $holdId, Google_Service_Vault_AddHeldAccountsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_AddHeldAccountsResponse

Parameters

$matterId : string: The matter ID.
$holdId : string: The hold ID.
$postBody : Google_Service_Vault_AddHeldAccountsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_AddHeldAccountsResponse —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a hold in the given matter. (holds.create)


    public
                create(string $matterId, Google_Service_Vault_Hold $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_Hold

Parameters

$matterId : string: The matter ID.
$postBody : Google_Service_Vault_Hold
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_Hold —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Removes a hold by ID. This will release any HeldAccounts on this Hold.


    public
                delete(string $matterId, string $holdId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_VaultEmpty

(holds.delete)

Parameters

$matterId : string: The matter ID.
$holdId : string: The hold ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_VaultEmpty —

get()

Gets a hold by ID. (holds.get)


    public
                get(string $matterId, string $holdId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_Hold

Parameters

$matterId : string: The matter ID.
$holdId : string: The hold ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_Hold —

listMattersHolds()

Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list. (holds.listMattersHolds)


    public
                listMattersHolds(string $matterId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_ListHoldsResponse

Parameters

$matterId : string: The matter ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_ListHoldsResponse —

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)


    public
                removeHeldAccounts(string $matterId, string $holdId, Google_Service_Vault_RemoveHeldAccountsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_RemoveHeldAccountsResponse

Parameters

$matterId : string: The matter ID.
$holdId : string: The hold ID.
$postBody : Google_Service_Vault_RemoveHeldAccountsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_RemoveHeldAccountsResponse —

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.


    public
                update(string $matterId, string $holdId, Google_Service_Vault_Hold $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vault_Hold

(holds.update)

Parameters

$matterId : string: The matter ID.
$holdId : string: The ID of the hold.
$postBody : Google_Service_Vault_Hold
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Vault_Hold —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —