com.box.sdkgen.schemas.retentionpolicyassignment

Class RetentionPolicyAssignment

Object

NullableFieldTracker

SerializableObject

RetentionPolicyAssignment

All Implemented Interfaces:

Serializable

public class RetentionPolicyAssignment
extends SerializableObject

A retention assignment represents a rule specifying the files a retention policy retains. Assignments can retain files based on their folder or metadata, or hold all files in the enterprise.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RetentionPolicyAssignment.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected OffsetDateTime	assignedAt When the retention policy assignment object was created.
protected UserMini	assignedBy
protected RetentionPolicyAssignmentAssignedToField	assignedTo The `type` and `id` of the content that is under retention.
protected List<RetentionPolicyAssignmentFilterFieldsField>	filterFields An array of field objects.
protected String	id The unique identifier for a retention policy assignment.
protected RetentionPolicyMini	retentionPolicy
protected String	startDateField The date the retention policy assignment begins.
protected EnumWrapper<RetentionPolicyAssignmentTypeField>	type The value will always be `retention_policy_assignment`.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RetentionPolicyAssignment(RetentionPolicyAssignment.Builder builder)
	RetentionPolicyAssignment(String id)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
OffsetDateTime	getAssignedAt()
UserMini	getAssignedBy()
RetentionPolicyAssignmentAssignedToField	getAssignedTo()
List<RetentionPolicyAssignmentFilterFieldsField>	getFilterFields()
String	getId()
RetentionPolicyMini	getRetentionPolicy()
String	getStartDateField()
EnumWrapper<RetentionPolicyAssignmentTypeField>	getType()
int	hashCode()
String	toString()

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected final String id

The unique identifier for a retention policy assignment.

type

protected EnumWrapper<RetentionPolicyAssignmentTypeField> type

The value will always be `retention_policy_assignment`.

retentionPolicy

protected RetentionPolicyMini retentionPolicy

assignedTo

protected RetentionPolicyAssignmentAssignedToField assignedTo

The `type` and `id` of the content that is under retention. The `type` can either be `folder` `enterprise`, or `metadata_template`.

filterFields

protected List<RetentionPolicyAssignmentFilterFieldsField> filterFields

An array of field objects. Values are only returned if the `assigned_to` type is `metadata_template`. Otherwise, the array is blank.

assignedBy

protected UserMini assignedBy

assignedAt

protected OffsetDateTime assignedAt

When the retention policy assignment object was created.

startDateField

protected String startDateField

The date the retention policy assignment begins. If the `assigned_to` type is `metadata_template`, this field can be a date field's metadata attribute key id.

Constructor Detail

RetentionPolicyAssignment

public RetentionPolicyAssignment(String id)

RetentionPolicyAssignment

protected RetentionPolicyAssignment(RetentionPolicyAssignment.Builder builder)

Method Detail

getId

public String getId()

getType

public EnumWrapper<RetentionPolicyAssignmentTypeField> getType()

getRetentionPolicy

public RetentionPolicyMini getRetentionPolicy()

getAssignedTo

public RetentionPolicyAssignmentAssignedToField getAssignedTo()

getFilterFields

public List<RetentionPolicyAssignmentFilterFieldsField> getFilterFields()

getAssignedBy

public UserMini getAssignedBy()

getAssignedAt

public OffsetDateTime getAssignedAt()

getStartDateField

public String getStartDateField()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object