com.box.sdkgen.managers.files

Class UpdateFileByIdRequestBody

Object

NullableFieldTracker

SerializableObject

UpdateFileByIdRequestBody

All Implemented Interfaces:

Serializable

public class UpdateFileByIdRequestBody
extends SerializableObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateFileByIdRequestBody.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected List<UpdateFileByIdRequestBodyCollectionsField>	collections An array of collections to make this file a member of.
protected String	description The description for a file.
protected OffsetDateTime	dispositionAt The retention expiration timestamp for the given file.
protected UpdateFileByIdRequestBodyLockField	lock Defines a lock on an item.
protected String	name An optional different name for the file.
protected UpdateFileByIdRequestBodyParentField	parent
protected UpdateFileByIdRequestBodyPermissionsField	permissions Defines who can download a file.
protected UpdateFileByIdRequestBodySharedLinkField	sharedLink
protected List<String>	tags The tags for this item.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<UpdateFileByIdRequestBodyCollectionsField>	getCollections()
String	getDescription()
OffsetDateTime	getDispositionAt()
UpdateFileByIdRequestBodyLockField	getLock()
String	getName()
UpdateFileByIdRequestBodyParentField	getParent()
UpdateFileByIdRequestBodyPermissionsField	getPermissions()
UpdateFileByIdRequestBodySharedLinkField	getSharedLink()
List<String>	getTags()
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

name

protected String name

An optional different name for the file. This can be used to rename the file.

File names must be unique within their parent folder. The name check is case-insensitive, so a file named `New File` cannot be created in a parent folder that already contains a folder named `new file`.

description

protected String description

The description for a file. This can be seen in the right-hand sidebar panel when viewing a file in the Box web app. Additionally, this index is used in the search index of the file, allowing users to find the file by the content in the description.

parent

protected UpdateFileByIdRequestBodyParentField parent

sharedLink

protected UpdateFileByIdRequestBodySharedLinkField sharedLink

lock

protected UpdateFileByIdRequestBodyLockField lock

Defines a lock on an item. This prevents the item from being moved, renamed, or otherwise changed by anyone other than the user who created the lock.

Set this to `null` to remove the lock.

dispositionAt

protected OffsetDateTime dispositionAt

The retention expiration timestamp for the given file. This date cannot be shortened once set on a file.

permissions

protected UpdateFileByIdRequestBodyPermissionsField permissions

Defines who can download a file.

collections

protected List<UpdateFileByIdRequestBodyCollectionsField> collections

An array of collections to make this file a member of. Currently we only support the `favorites` collection.

To get the ID for a collection, use the [List all collections][1] endpoint.

Passing an empty array `[]` or `null` will remove the file from all collections.

[1]: https://developer.box.com/reference/get-collections

tags

protected List<String> tags

The tags for this item. These tags are shown in the Box web app and mobile apps next to an item.

To add or remove a tag, retrieve the item's current tags, modify them, and then update this field.

There is a limit of 100 tags per item, and 10,000 unique tags per enterprise.

Constructor Detail

UpdateFileByIdRequestBody

public UpdateFileByIdRequestBody()

UpdateFileByIdRequestBody

protected UpdateFileByIdRequestBody(UpdateFileByIdRequestBody.Builder builder)

Method Detail

getName

public String getName()

getDescription

public String getDescription()

getParent

public UpdateFileByIdRequestBodyParentField getParent()

getSharedLink

public UpdateFileByIdRequestBodySharedLinkField getSharedLink()

getLock

public UpdateFileByIdRequestBodyLockField getLock()

getDispositionAt

public OffsetDateTime getDispositionAt()

getPermissions

public UpdateFileByIdRequestBodyPermissionsField getPermissions()

getCollections

public List<UpdateFileByIdRequestBodyCollectionsField> getCollections()

getTags

public List<String> getTags()

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