com.box.sdkgen.managers.retentionpolicies

Class GetRetentionPoliciesQueryParams

Object

GetRetentionPoliciesQueryParams

public class GetRetentionPoliciesQueryParams
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetRetentionPoliciesQueryParams.Builder

Field Summary

Fields

Modifier and Type	Field and Description
String	createdByUserId Filters results by the ID of the user who created policy.
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	policyName Filters results by a case sensitive prefix of the name of retention policies.
EnumWrapper<GetRetentionPoliciesQueryParamsPolicyTypeField>	policyType Filters results by the type of retention policy.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getCreatedByUserId()
List<String>	getFields()
Long	getLimit()
String	getMarker()
String	getPolicyName()
EnumWrapper<GetRetentionPoliciesQueryParamsPolicyTypeField>	getPolicyType()

Methods inherited from class Object

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

Field Detail

policyName

public String policyName

Filters results by a case sensitive prefix of the name of retention policies.

policyType

public EnumWrapper<GetRetentionPoliciesQueryParamsPolicyTypeField> policyType

Filters results by the type of retention policy.

createdByUserId

public String createdByUserId

Filters results by the ID of the user who created policy.

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.

limit

public Long limit

The maximum number of items to return per page.

marker

public String marker

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

Constructor Detail

GetRetentionPoliciesQueryParams

public GetRetentionPoliciesQueryParams()

GetRetentionPoliciesQueryParams

protected GetRetentionPoliciesQueryParams(GetRetentionPoliciesQueryParams.Builder builder)

Method Detail

getPolicyName

public String getPolicyName()

getPolicyType

public EnumWrapper<GetRetentionPoliciesQueryParamsPolicyTypeField> getPolicyType()

getCreatedByUserId

public String getCreatedByUserId()

getFields

public List<String> getFields()

getLimit

public Long getLimit()

getMarker

public String getMarker()