com.box.sdkgen.managers.legalholdpolicyassignments

Class GetLegalHoldPolicyAssignmentsQueryParams

Object

GetLegalHoldPolicyAssignmentsQueryParams

public class GetLegalHoldPolicyAssignmentsQueryParams
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetLegalHoldPolicyAssignmentsQueryParams.Builder

Field Summary

Fields

Modifier and Type	Field and Description
String	assignToId Filters the results by the ID of item the policy was applied to.
EnumWrapper<GetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField>	assignToType Filters the results by the type of item the policy was applied to.
List<String>	fields A comma-separated list of attributes to include in the response.
Long	limit The maximum number of items to return per page.
String	marker Defines the position marker at which to begin returning results.
String	policyId The ID of the legal hold policy.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetLegalHoldPolicyAssignmentsQueryParams(GetLegalHoldPolicyAssignmentsQueryParams.Builder builder)
	GetLegalHoldPolicyAssignmentsQueryParams(String policyId)

Method Summary

Modifier and Type	Method and Description
String	getAssignToId()
EnumWrapper<GetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField>	getAssignToType()
List<String>	getFields()
Long	getLimit()
String	getMarker()
String	getPolicyId()

Methods inherited from class Object

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

Field Detail

policyId

public final String policyId

The ID of the legal hold policy.

assignToType

public EnumWrapper<GetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField> assignToType

Filters the results by the type of item the policy was applied to.

assignToId

public String assignToId

Filters the results by the ID of item the policy was applied to.

marker

public String marker

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires `usemarker` to be set to `true`.

limit

public Long limit

The maximum number of items to return per page.

fields

public List<String> fields

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Constructor Detail

GetLegalHoldPolicyAssignmentsQueryParams

public GetLegalHoldPolicyAssignmentsQueryParams(String policyId)

GetLegalHoldPolicyAssignmentsQueryParams

protected GetLegalHoldPolicyAssignmentsQueryParams(GetLegalHoldPolicyAssignmentsQueryParams.Builder builder)

Method Detail

getPolicyId

public String getPolicyId()

getAssignToType

public EnumWrapper<GetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField> getAssignToType()

getAssignToId

public String getAssignToId()

getMarker

public String getMarker()

getLimit

public Long getLimit()

getFields

public List<String> getFields()