com.box.sdkgen.managers.legalholdpolicyassignments

Class LegalHoldPolicyAssignmentsManager

Object

LegalHoldPolicyAssignmentsManager

public class LegalHoldPolicyAssignmentsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LegalHoldPolicyAssignmentsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LegalHoldPolicyAssignment	createLegalHoldPolicyAssignment(CreateLegalHoldPolicyAssignmentRequestBody requestBody) Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions.
LegalHoldPolicyAssignment	createLegalHoldPolicyAssignment(CreateLegalHoldPolicyAssignmentRequestBody requestBody, CreateLegalHoldPolicyAssignmentHeaders headers) Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions.
void	deleteLegalHoldPolicyAssignmentById(String legalHoldPolicyAssignmentId) Remove a legal hold from an item.
void	deleteLegalHoldPolicyAssignmentById(String legalHoldPolicyAssignmentId, DeleteLegalHoldPolicyAssignmentByIdHeaders headers) Remove a legal hold from an item.
Authentication	getAuth()
LegalHoldPolicyAssignment	getLegalHoldPolicyAssignmentById(String legalHoldPolicyAssignmentId) Retrieve a legal hold policy assignment.
LegalHoldPolicyAssignment	getLegalHoldPolicyAssignmentById(String legalHoldPolicyAssignmentId, GetLegalHoldPolicyAssignmentByIdHeaders headers) Retrieve a legal hold policy assignment.
FilesOnHold	getLegalHoldPolicyAssignmentFileOnHold(String legalHoldPolicyAssignmentId) Get a list of files with current file versions for a legal hold assignment.
FilesOnHold	getLegalHoldPolicyAssignmentFileOnHold(String legalHoldPolicyAssignmentId, GetLegalHoldPolicyAssignmentFileOnHoldHeaders headers) Get a list of files with current file versions for a legal hold assignment.
FilesOnHold	getLegalHoldPolicyAssignmentFileOnHold(String legalHoldPolicyAssignmentId, GetLegalHoldPolicyAssignmentFileOnHoldQueryParams queryParams) Get a list of files with current file versions for a legal hold assignment.
FilesOnHold	getLegalHoldPolicyAssignmentFileOnHold(String legalHoldPolicyAssignmentId, GetLegalHoldPolicyAssignmentFileOnHoldQueryParams queryParams, GetLegalHoldPolicyAssignmentFileOnHoldHeaders headers) Get a list of files with current file versions for a legal hold assignment.
LegalHoldPolicyAssignments	getLegalHoldPolicyAssignments(GetLegalHoldPolicyAssignmentsQueryParams queryParams) Retrieves a list of items a legal hold policy has been assigned to.
LegalHoldPolicyAssignments	getLegalHoldPolicyAssignments(GetLegalHoldPolicyAssignmentsQueryParams queryParams, GetLegalHoldPolicyAssignmentsHeaders headers) Retrieves a list of items a legal hold policy has been assigned to.
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

LegalHoldPolicyAssignmentsManager

public LegalHoldPolicyAssignmentsManager()

LegalHoldPolicyAssignmentsManager

protected LegalHoldPolicyAssignmentsManager(LegalHoldPolicyAssignmentsManager.Builder builder)

Method Detail

getLegalHoldPolicyAssignments

public LegalHoldPolicyAssignments getLegalHoldPolicyAssignments(GetLegalHoldPolicyAssignmentsQueryParams queryParams)

Retrieves a list of items a legal hold policy has been assigned to.

Parameters:

queryParams - Query parameters of getLegalHoldPolicyAssignments method

getLegalHoldPolicyAssignments

public LegalHoldPolicyAssignments getLegalHoldPolicyAssignments(GetLegalHoldPolicyAssignmentsQueryParams queryParams,
                                                                GetLegalHoldPolicyAssignmentsHeaders headers)

Retrieves a list of items a legal hold policy has been assigned to.

Parameters:

queryParams - Query parameters of getLegalHoldPolicyAssignments method

headers - Headers of getLegalHoldPolicyAssignments method

createLegalHoldPolicyAssignment

public LegalHoldPolicyAssignment createLegalHoldPolicyAssignment(CreateLegalHoldPolicyAssignmentRequestBody requestBody)

Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions.

Parameters:

requestBody - Request body of createLegalHoldPolicyAssignment method

createLegalHoldPolicyAssignment

public LegalHoldPolicyAssignment createLegalHoldPolicyAssignment(CreateLegalHoldPolicyAssignmentRequestBody requestBody,
                                                                 CreateLegalHoldPolicyAssignmentHeaders headers)

Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions.

Parameters:

requestBody - Request body of createLegalHoldPolicyAssignment method

headers - Headers of createLegalHoldPolicyAssignment method

getLegalHoldPolicyAssignmentById

public LegalHoldPolicyAssignment getLegalHoldPolicyAssignmentById(String legalHoldPolicyAssignmentId)

Retrieve a legal hold policy assignment.

Parameters:

legalHoldPolicyAssignmentId - The ID of the legal hold policy assignment. Example: "753465"

getLegalHoldPolicyAssignmentById

public LegalHoldPolicyAssignment getLegalHoldPolicyAssignmentById(String legalHoldPolicyAssignmentId,
                                                                  GetLegalHoldPolicyAssignmentByIdHeaders headers)

Retrieve a legal hold policy assignment.

Parameters:

legalHoldPolicyAssignmentId - The ID of the legal hold policy assignment. Example: "753465"

headers - Headers of getLegalHoldPolicyAssignmentById method

deleteLegalHoldPolicyAssignmentById

public void deleteLegalHoldPolicyAssignmentById(String legalHoldPolicyAssignmentId)

Remove a legal hold from an item.

This is an asynchronous process. The policy will not be fully removed yet when the response returns.

Parameters:

legalHoldPolicyAssignmentId - The ID of the legal hold policy assignment. Example: "753465"

deleteLegalHoldPolicyAssignmentById

public void deleteLegalHoldPolicyAssignmentById(String legalHoldPolicyAssignmentId,
                                                DeleteLegalHoldPolicyAssignmentByIdHeaders headers)

Remove a legal hold from an item.

This is an asynchronous process. The policy will not be fully removed yet when the response returns.

Parameters:

legalHoldPolicyAssignmentId - The ID of the legal hold policy assignment. Example: "753465"

headers - Headers of deleteLegalHoldPolicyAssignmentById method

getLegalHoldPolicyAssignmentFileOnHold

public FilesOnHold getLegalHoldPolicyAssignmentFileOnHold(String legalHoldPolicyAssignmentId)

Get a list of files with current file versions for a legal hold assignment.

In some cases you may want to get previous file versions instead. In these cases, use the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API instead to return any previous versions of a file for this legal hold policy assignment.

Due to ongoing re-architecture efforts this API might not return all file versions held for this policy ID. Instead, this API will only return the latest file version held in the newly developed architecture. The `GET /file_version_legal_holds` API can be used to fetch current and past versions of files held within the legacy architecture.

This endpoint does not support returning any content that is on hold due to a Custodian collaborating on a Hub.

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.

Parameters:

legalHoldPolicyAssignmentId - The ID of the legal hold policy assignment. Example: "753465"

getLegalHoldPolicyAssignmentFileOnHold

public FilesOnHold getLegalHoldPolicyAssignmentFileOnHold(String legalHoldPolicyAssignmentId,
                                                          GetLegalHoldPolicyAssignmentFileOnHoldQueryParams queryParams)

Get a list of files with current file versions for a legal hold assignment.

In some cases you may want to get previous file versions instead. In these cases, use the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API instead to return any previous versions of a file for this legal hold policy assignment.

Due to ongoing re-architecture efforts this API might not return all file versions held for this policy ID. Instead, this API will only return the latest file version held in the newly developed architecture. The `GET /file_version_legal_holds` API can be used to fetch current and past versions of files held within the legacy architecture.

This endpoint does not support returning any content that is on hold due to a Custodian collaborating on a Hub.

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.

Parameters:

legalHoldPolicyAssignmentId - The ID of the legal hold policy assignment. Example: "753465"

queryParams - Query parameters of getLegalHoldPolicyAssignmentFileOnHold method

getLegalHoldPolicyAssignmentFileOnHold

public FilesOnHold getLegalHoldPolicyAssignmentFileOnHold(String legalHoldPolicyAssignmentId,
                                                          GetLegalHoldPolicyAssignmentFileOnHoldHeaders headers)

Get a list of files with current file versions for a legal hold assignment.

In some cases you may want to get previous file versions instead. In these cases, use the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API instead to return any previous versions of a file for this legal hold policy assignment.

Due to ongoing re-architecture efforts this API might not return all file versions held for this policy ID. Instead, this API will only return the latest file version held in the newly developed architecture. The `GET /file_version_legal_holds` API can be used to fetch current and past versions of files held within the legacy architecture.

This endpoint does not support returning any content that is on hold due to a Custodian collaborating on a Hub.

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.

Parameters:

legalHoldPolicyAssignmentId - The ID of the legal hold policy assignment. Example: "753465"

headers - Headers of getLegalHoldPolicyAssignmentFileOnHold method

getLegalHoldPolicyAssignmentFileOnHold

public FilesOnHold getLegalHoldPolicyAssignmentFileOnHold(String legalHoldPolicyAssignmentId,
                                                          GetLegalHoldPolicyAssignmentFileOnHoldQueryParams queryParams,
                                                          GetLegalHoldPolicyAssignmentFileOnHoldHeaders headers)

Get a list of files with current file versions for a legal hold assignment.

In some cases you may want to get previous file versions instead. In these cases, use the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API instead to return any previous versions of a file for this legal hold policy assignment.

Due to ongoing re-architecture efforts this API might not return all file versions held for this policy ID. Instead, this API will only return the latest file version held in the newly developed architecture. The `GET /file_version_legal_holds` API can be used to fetch current and past versions of files held within the legacy architecture.

This endpoint does not support returning any content that is on hold due to a Custodian collaborating on a Hub.

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.

Parameters:

legalHoldPolicyAssignmentId - The ID of the legal hold policy assignment. Example: "753465"

queryParams - Query parameters of getLegalHoldPolicyAssignmentFileOnHold method

headers - Headers of getLegalHoldPolicyAssignmentFileOnHold method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()