com.box.sdkgen.schemas.fileversionretention

Class FileVersionRetention

Object

NullableFieldTracker

SerializableObject

FileVersionRetention

All Implemented Interfaces:

Serializable

public class FileVersionRetention
extends SerializableObject

A retention policy blocks permanent deletion of content for a specified amount of time. Admins can apply policies to specified folders, or an entire enterprise. A file version retention is a record for a retained file version. To use this feature, you must have the manage retention policies scope enabled for your API key in your application management console.

**Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileVersionRetention.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected OffsetDateTime	appliedAt When this file version retention object was created.
protected OffsetDateTime	dispositionAt When the retention expires on this file version retention.
protected FileMini	file
protected FileVersionMini	fileVersion
protected String	id The unique identifier for this file version retention.
protected EnumWrapper<FileVersionRetentionTypeField>	type The value will always be `file_version_retention`.
protected RetentionPolicyMini	winningRetentionPolicy

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
OffsetDateTime	getAppliedAt()
OffsetDateTime	getDispositionAt()
FileMini	getFile()
FileVersionMini	getFileVersion()
String	getId()
EnumWrapper<FileVersionRetentionTypeField>	getType()
RetentionPolicyMini	getWinningRetentionPolicy()
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 String id

The unique identifier for this file version retention.

type

protected EnumWrapper<FileVersionRetentionTypeField> type

The value will always be `file_version_retention`.

fileVersion

protected FileVersionMini fileVersion

file

protected FileMini file

appliedAt

protected OffsetDateTime appliedAt

When this file version retention object was created.

dispositionAt

protected OffsetDateTime dispositionAt

When the retention expires on this file version retention.

winningRetentionPolicy

protected RetentionPolicyMini winningRetentionPolicy

Constructor Detail

FileVersionRetention

public FileVersionRetention()

FileVersionRetention

protected FileVersionRetention(FileVersionRetention.Builder builder)

Method Detail

getId

public String getId()

getType

public EnumWrapper<FileVersionRetentionTypeField> getType()

getFileVersion

public FileVersionMini getFileVersion()

getFile

public FileMini getFile()

getAppliedAt

public OffsetDateTime getAppliedAt()

getDispositionAt

public OffsetDateTime getDispositionAt()

getWinningRetentionPolicy

public RetentionPolicyMini getWinningRetentionPolicy()

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