com.google.api.services.vault.v1

Class Vault.Matters.Holds

java.lang.Object

com.google.api.services.vault.v1.Vault.Matters.Holds

Enclosing class:

Vault.Matters

public class Vault.Matters.Holds
extends Object

The "holds" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Vault.Matters.Holds.Accounts The "accounts" collection of methods.
class	Vault.Matters.Holds.AddHeldAccounts
class	Vault.Matters.Holds.Create
class	Vault.Matters.Holds.Delete
class	Vault.Matters.Holds.Get
class	Vault.Matters.Holds.List
class	Vault.Matters.Holds.RemoveHeldAccounts
class	Vault.Matters.Holds.Update

Constructor Summary

Constructors

Constructor and Description
Holds()

Method Summary

Modifier and Type	Method and Description
Vault.Matters.Holds.Accounts	accounts() An accessor for creating requests from the Accounts collection.
Vault.Matters.Holds.AddHeldAccounts	addHeldAccounts(String matterId, String holdId, AddHeldAccountsRequest content) Adds accounts to a hold.
Vault.Matters.Holds.Create	create(String matterId, Hold content) Creates a hold in the specified matter.
Vault.Matters.Holds.Delete	delete(String matterId, String holdId) Removes the specified hold and releases the accounts or organizational unit covered by the hold.
Vault.Matters.Holds.Get	get(String matterId, String holdId) Gets the specified hold.
Vault.Matters.Holds.List	list(String matterId) Lists the holds in a matter.
Vault.Matters.Holds.RemoveHeldAccounts	removeHeldAccounts(String matterId, String holdId, RemoveHeldAccountsRequest content) Removes the specified accounts from a hold.
Vault.Matters.Holds.Update	update(String matterId, String holdId, Hold content) Updates the scope (organizational unit or accounts) and query parameters of a hold.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Holds

public Holds()

Method Detail

addHeldAccounts

public Vault.Matters.Holds.AddHeldAccounts addHeldAccounts(String matterId,
                                                           String holdId,
                                                           AddHeldAccountsRequest content)
                                                    throws IOException

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. Create a request for the method "holds.addHeldAccounts". This request holds the parameters needed by the vault server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matterId - The matter ID.

holdId - The hold ID.

content - the AddHeldAccountsRequest

Returns:

the request

Throws:

IOException

create

public Vault.Matters.Holds.Create create(String matterId,
                                         Hold content)
                                  throws IOException

Creates a hold in the specified matter. Create a request for the method "holds.create". This request holds the parameters needed by the vault server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matterId - The matter ID.

content - the Hold

Returns:

the request

Throws:

IOException

delete

public Vault.Matters.Holds.Delete delete(String matterId,
                                         String holdId)
                                  throws IOException

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. Create a request for the method "holds.delete". This request holds the parameters needed by the vault server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matterId - The matter ID.

holdId - The hold ID.

Returns:

the request

Throws:

IOException

get

public Vault.Matters.Holds.Get get(String matterId,
                                   String holdId)
                            throws IOException

Gets the specified hold. Create a request for the method "holds.get". This request holds the parameters needed by the vault server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matterId - The matter ID.

holdId - The hold ID.

Returns:

the request

Throws:

IOException

list

public Vault.Matters.Holds.List list(String matterId)
                              throws IOException

Lists the holds in a matter. Create a request for the method "holds.list". This request holds the parameters needed by the vault server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matterId - The matter ID.

Returns:

the request

Throws:

IOException

removeHeldAccounts

public Vault.Matters.Holds.RemoveHeldAccounts removeHeldAccounts(String matterId,
                                                                 String holdId,
                                                                 RemoveHeldAccountsRequest content)
                                                          throws IOException

Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request. Create a request for the method "holds.removeHeldAccounts". This request holds the parameters needed by the vault server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matterId - The matter ID.

holdId - The hold ID.

content - the RemoveHeldAccountsRequest

Returns:

the request

Throws:

IOException

update

public Vault.Matters.Holds.Update update(String matterId,
                                         String holdId,
                                         Hold content)
                                  throws IOException

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. Create a request for the method "holds.update". This request holds the parameters needed by the vault server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matterId - The matter ID.

holdId - The ID of the hold.

content - the Hold

Returns:

the request

Throws:

IOException

accounts

public Vault.Matters.Holds.Accounts accounts()

An accessor for creating requests from the Accounts collection.

The typical use is:

    Vault vault = new Vault(...);
    Vault.Accounts.List request = vault.accounts().list(parameters ...)
 

Returns:

the resource collection