Class MattersResource.HoldsResource

The "holds" collection of methods.

Inheritance

object

MattersResource.HoldsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Vault.v1

Assembly: Google.Apis.Vault.v1.dll

Syntax

public class MattersResource.HoldsResource

Constructors

HoldsResource(IClientService)

Constructs a new resource.

Declaration

public HoldsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Accounts

Gets the Accounts resource.

Declaration

public virtual MattersResource.HoldsResource.AccountsResource Accounts { get; }

Property Value

Type	Description
MattersResource.HoldsResource.AccountsResource

Methods

AddHeldAccounts(AddHeldAccountsRequest, string, string)

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.

Declaration

public virtual MattersResource.HoldsResource.AddHeldAccountsRequest AddHeldAccounts(AddHeldAccountsRequest body, string matterId, string holdId)

Parameters

Type	Name	Description
AddHeldAccountsRequest	body	The body of the request.
string	matterId	The matter ID.
string	holdId	The hold ID.

Returns

Type	Description
MattersResource.HoldsResource.AddHeldAccountsRequest

Create(Hold, string)

Creates a hold in the specified matter.

Declaration

public virtual MattersResource.HoldsResource.CreateRequest Create(Hold body, string matterId)

Parameters

Type	Name	Description
Hold	body	The body of the request.
string	matterId	The matter ID.

Returns

Type	Description
MattersResource.HoldsResource.CreateRequest

Delete(string, string)

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.

Declaration

public virtual MattersResource.HoldsResource.DeleteRequest Delete(string matterId, string holdId)

Parameters

Type	Name	Description
string	matterId	The matter ID.
string	holdId	The hold ID.

Returns

Type	Description
MattersResource.HoldsResource.DeleteRequest

Get(string, string)

Gets the specified hold.

Declaration

public virtual MattersResource.HoldsResource.GetRequest Get(string matterId, string holdId)

Parameters

Type	Name	Description
string	matterId	The matter ID.
string	holdId	The hold ID.

Returns

Type	Description
MattersResource.HoldsResource.GetRequest

List(string)

Lists the holds in a matter.

Declaration

public virtual MattersResource.HoldsResource.ListRequest List(string matterId)

Parameters

Type	Name	Description
string	matterId	The matter ID.

Returns

Type	Description
MattersResource.HoldsResource.ListRequest

RemoveHeldAccounts(RemoveHeldAccountsRequest, string, string)

Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.

Declaration

public virtual MattersResource.HoldsResource.RemoveHeldAccountsRequest RemoveHeldAccounts(RemoveHeldAccountsRequest body, string matterId, string holdId)

Parameters

Type	Name	Description
RemoveHeldAccountsRequest	body	The body of the request.
string	matterId	The matter ID.
string	holdId	The hold ID.

Returns

Type	Description
MattersResource.HoldsResource.RemoveHeldAccountsRequest

Update(Hold, string, string)

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.

Declaration

public virtual MattersResource.HoldsResource.UpdateRequest Update(Hold body, string matterId, string holdId)

Parameters

Type	Name	Description
Hold	body	The body of the request.
string	matterId	The matter ID.
string	holdId	The ID of the hold.

Returns

Type	Description
MattersResource.HoldsResource.UpdateRequest