com.box.sdkgen.schemas.trashfilerestored

Class TrashFileRestored

Object

NullableFieldTracker

SerializableObject

TrashFileRestored

All Implemented Interfaces:

Serializable

public class TrashFileRestored
extends SerializableObject

Represents a file restored from the trash.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrashFileRestored.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected OffsetDateTime	contentCreatedAt The date and time at which this file was originally created, which might be before it was uploaded to Box.
protected OffsetDateTime	contentModifiedAt The date and time at which this file was last updated, which might be before it was uploaded to Box.
protected OffsetDateTime	createdAt The date and time when the file was created on Box.
protected UserMini	createdBy
protected String	description The optional description of this file.
protected String	etag The HTTP `etag` of this file.
protected FileVersionMini	fileVersion
protected String	id The unique identifier that represent a file.
protected EnumWrapper<TrashFileRestoredItemStatusField>	itemStatus Defines if this item has been deleted or not.
protected OffsetDateTime	modifiedAt The date and time when the file was last updated on Box.
protected UserMini	modifiedBy
protected String	name The name of the file.
protected UserMini	ownedBy
protected FolderMini	parent
protected TrashFileRestoredPathCollectionField	pathCollection
protected String	purgedAt The time at which this file is expected to be purged from the trash - becomes `null` after restore.
protected String	sequenceId
protected String	sha1 The SHA1 hash of the file.
protected String	sharedLink The shared link for this file.
protected long	size The file size in bytes.
protected String	trashedAt The time at which this file was put in the trash - becomes `null` after restore.
protected EnumWrapper<TrashFileRestoredTypeField>	type The value will always be `file`.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	TrashFileRestored(String id, String sequenceId, String sha1, String description, long size, TrashFileRestoredPathCollectionField pathCollection, OffsetDateTime createdAt, OffsetDateTime modifiedAt, UserMini modifiedBy, UserMini ownedBy, EnumWrapper<TrashFileRestoredItemStatusField> itemStatus)
	TrashFileRestored(String id, String sequenceId, String sha1, String description, long size, TrashFileRestoredPathCollectionField pathCollection, OffsetDateTime createdAt, OffsetDateTime modifiedAt, UserMini modifiedBy, UserMini ownedBy, TrashFileRestoredItemStatusField itemStatus)
protected	TrashFileRestored(TrashFileRestored.Builder builder)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
OffsetDateTime	getContentCreatedAt()
OffsetDateTime	getContentModifiedAt()
OffsetDateTime	getCreatedAt()
UserMini	getCreatedBy()
String	getDescription()
String	getEtag()
FileVersionMini	getFileVersion()
String	getId()
EnumWrapper<TrashFileRestoredItemStatusField>	getItemStatus()
OffsetDateTime	getModifiedAt()
UserMini	getModifiedBy()
String	getName()
UserMini	getOwnedBy()
FolderMini	getParent()
TrashFileRestoredPathCollectionField	getPathCollection()
String	getPurgedAt()
String	getSequenceId()
String	getSha1()
String	getSharedLink()
long	getSize()
String	getTrashedAt()
EnumWrapper<TrashFileRestoredTypeField>	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 that represent a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.

etag

protected String etag

The HTTP `etag` of this file. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the file if (no) changes have happened.

type

protected EnumWrapper<TrashFileRestoredTypeField> type

The value will always be `file`.

sequenceId

protected final String sequenceId

name

protected String name

The name of the file.

sha1

protected final String sha1

The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file.

fileVersion

protected FileVersionMini fileVersion

description

protected final String description

The optional description of this file.

size

protected final long size

The file size in bytes. Be careful parsing this integer as it can get very large and cause an integer overflow.

pathCollection

protected final TrashFileRestoredPathCollectionField pathCollection

createdAt

protected final OffsetDateTime createdAt

The date and time when the file was created on Box.

modifiedAt

protected final OffsetDateTime modifiedAt

The date and time when the file was last updated on Box.

trashedAt

protected String trashedAt

The time at which this file was put in the trash - becomes `null` after restore.

purgedAt

protected String purgedAt

The time at which this file is expected to be purged from the trash - becomes `null` after restore.

contentCreatedAt

protected OffsetDateTime contentCreatedAt

The date and time at which this file was originally created, which might be before it was uploaded to Box.

contentModifiedAt

protected OffsetDateTime contentModifiedAt

The date and time at which this file was last updated, which might be before it was uploaded to Box.

createdBy

protected UserMini createdBy

modifiedBy

protected final UserMini modifiedBy

ownedBy

protected final UserMini ownedBy

sharedLink

protected String sharedLink

The shared link for this file. This will be `null` if a file had been trashed, even though the original shared link does become active again.

parent

protected FolderMini parent

itemStatus

protected final EnumWrapper<TrashFileRestoredItemStatusField> itemStatus

Defines if this item has been deleted or not.

* `active` when the item has is not in the trash * `trashed` when the item has been moved to the trash but not deleted * `deleted` when the item has been permanently deleted.

Constructor Detail

TrashFileRestored

public TrashFileRestored(String id,
                         String sequenceId,
                         String sha1,
                         String description,
                         long size,
                         TrashFileRestoredPathCollectionField pathCollection,
                         OffsetDateTime createdAt,
                         OffsetDateTime modifiedAt,
                         UserMini modifiedBy,
                         UserMini ownedBy,
                         TrashFileRestoredItemStatusField itemStatus)

TrashFileRestored

public TrashFileRestored(String id,
                         String sequenceId,
                         String sha1,
                         String description,
                         long size,
                         TrashFileRestoredPathCollectionField pathCollection,
                         OffsetDateTime createdAt,
                         OffsetDateTime modifiedAt,
                         UserMini modifiedBy,
                         UserMini ownedBy,
                         EnumWrapper<TrashFileRestoredItemStatusField> itemStatus)

TrashFileRestored

protected TrashFileRestored(TrashFileRestored.Builder builder)

Method Detail

getId

public String getId()

getEtag

public String getEtag()

getType

public EnumWrapper<TrashFileRestoredTypeField> getType()

getSequenceId

public String getSequenceId()

getName

public String getName()

getSha1

public String getSha1()

getFileVersion

public FileVersionMini getFileVersion()

getDescription

public String getDescription()

getSize

public long getSize()

getPathCollection

public TrashFileRestoredPathCollectionField getPathCollection()

getCreatedAt

public OffsetDateTime getCreatedAt()

getModifiedAt

public OffsetDateTime getModifiedAt()

getTrashedAt

public String getTrashedAt()

getPurgedAt

public String getPurgedAt()

getContentCreatedAt

public OffsetDateTime getContentCreatedAt()

getContentModifiedAt

public OffsetDateTime getContentModifiedAt()

getCreatedBy

public UserMini getCreatedBy()

getModifiedBy

public UserMini getModifiedBy()

getOwnedBy

public UserMini getOwnedBy()

getSharedLink

public String getSharedLink()

getParent

public FolderMini getParent()

getItemStatus

public EnumWrapper<TrashFileRestoredItemStatusField> getItemStatus()

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