com.box.sdkgen.managers.fileversionlegalholds

Class FileVersionLegalHoldsManager

Object

FileVersionLegalHoldsManager

public class FileVersionLegalHoldsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileVersionLegalHoldsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	FileVersionLegalHoldsManager()
protected	FileVersionLegalHoldsManager(FileVersionLegalHoldsManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
Authentication	getAuth()
FileVersionLegalHold	getFileVersionLegalHoldById(String fileVersionLegalHoldId) Retrieves information about the legal hold policies assigned to a file version.
FileVersionLegalHold	getFileVersionLegalHoldById(String fileVersionLegalHoldId, GetFileVersionLegalHoldByIdHeaders headers) Retrieves information about the legal hold policies assigned to a file version.
FileVersionLegalHolds	getFileVersionLegalHolds(GetFileVersionLegalHoldsQueryParams queryParams) Get a list of file versions on legal hold for a legal hold assignment.
FileVersionLegalHolds	getFileVersionLegalHolds(GetFileVersionLegalHoldsQueryParams queryParams, GetFileVersionLegalHoldsHeaders headers) Get a list of file versions on legal hold for a legal hold assignment.
NetworkSession	getNetworkSession()

Methods inherited from class Object

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

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

FileVersionLegalHoldsManager

public FileVersionLegalHoldsManager()

FileVersionLegalHoldsManager

protected FileVersionLegalHoldsManager(FileVersionLegalHoldsManager.Builder builder)

Method Detail

getFileVersionLegalHoldById

public FileVersionLegalHold getFileVersionLegalHoldById(String fileVersionLegalHoldId)

Retrieves information about the legal hold policies assigned to a file version.

Parameters:

fileVersionLegalHoldId - The ID of the file version legal hold. Example: "2348213"

getFileVersionLegalHoldById

public FileVersionLegalHold getFileVersionLegalHoldById(String fileVersionLegalHoldId,
                                                        GetFileVersionLegalHoldByIdHeaders headers)

Retrieves information about the legal hold policies assigned to a file version.

Parameters:

fileVersionLegalHoldId - The ID of the file version legal hold. Example: "2348213"

headers - Headers of getFileVersionLegalHoldById method

getFileVersionLegalHolds

public FileVersionLegalHolds getFileVersionLegalHolds(GetFileVersionLegalHoldsQueryParams queryParams)

Get a list of file versions on legal hold for a legal hold assignment.

Due to ongoing re-architecture efforts this API might not return all file versions for this policy ID.

Instead, this API will only return file versions held in the legacy architecture. Two new endpoints will available to request any file versions held in the new architecture.

For file versions held in the new architecture, the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API can be used to return all past file versions available for this policy assignment, and the `GET /legal_hold_policy_assignments/:id/files_on_hold` API can be used to return any current (latest) versions of a file under legal hold.

The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to find a list of policy assignments for a given policy ID.

Once the re-architecture is completed this API will be deprecated.

Parameters:

queryParams - Query parameters of getFileVersionLegalHolds method

getFileVersionLegalHolds

public FileVersionLegalHolds getFileVersionLegalHolds(GetFileVersionLegalHoldsQueryParams queryParams,
                                                      GetFileVersionLegalHoldsHeaders headers)

Get a list of file versions on legal hold for a legal hold assignment.

Due to ongoing re-architecture efforts this API might not return all file versions for this policy ID.

Instead, this API will only return file versions held in the legacy architecture. Two new endpoints will available to request any file versions held in the new architecture.

For file versions held in the new architecture, the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API can be used to return all past file versions available for this policy assignment, and the `GET /legal_hold_policy_assignments/:id/files_on_hold` API can be used to return any current (latest) versions of a file under legal hold.

The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to find a list of policy assignments for a given policy ID.

Once the re-architecture is completed this API will be deprecated.

Parameters:

queryParams - Query parameters of getFileVersionLegalHolds method

headers - Headers of getFileVersionLegalHolds method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()