FileRequest (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - FileRequest

All Implemented Interfaces:

Serializable
```
public class FileRequest
extends SerializableObject
```
A standard representation of a file request, as returned from any file request API endpoints by default.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FileRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileRequest.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected OffsetDateTime`	`createdAt` The date and time when the file request was created.
`protected UserMini`	`createdBy`
`protected String`	`description` The optional description of this file request.
`protected String`	`etag` The HTTP `etag` of this file.
`protected OffsetDateTime`	`expiresAt` The date after which a file request will no longer accept new submissions.
`protected FolderMini`	`folder`
`protected String`	`id` The unique identifier for this file request.
`protected Boolean`	`isDescriptionRequired` Whether a file request submitter is required to provide a description of the files they are submitting.
`protected Boolean`	`isEmailRequired` Whether a file request submitter is required to provide their email address.
`protected EnumWrapper<FileRequestStatusField>`	`status` The status of the file request.
`protected String`	`title` The title of file request.
`protected EnumWrapper<FileRequestTypeField>`	`type` The value will always be `file_request`.
`protected OffsetDateTime`	`updatedAt` The date and time when the file request was last updated.
`protected UserMini`	`updatedBy`
`protected String`	`url` The generated URL for this file request.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`FileRequest(FileRequest.Builder builder)`
	`FileRequest(String id, FolderMini folder, OffsetDateTime createdAt, OffsetDateTime updatedAt)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`OffsetDateTime`	`getCreatedAt()`
`UserMini`	`getCreatedBy()`
`String`	`getDescription()`
`String`	`getEtag()`
`OffsetDateTime`	`getExpiresAt()`
`FolderMini`	`getFolder()`
`String`	`getId()`
`Boolean`	`getIsDescriptionRequired()`
`Boolean`	`getIsEmailRequired()`
`EnumWrapper<FileRequestStatusField>`	`getStatus()`
`String`	`getTitle()`
`EnumWrapper<FileRequestTypeField>`	`getType()`
`OffsetDateTime`	`getUpdatedAt()`
`UserMini`	`getUpdatedBy()`
`String`	`getUrl()`
`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 this file request.
  - type
```
protected EnumWrapper<FileRequestTypeField> type
```
    The value will always be `file_request`.
  - title
```
protected String title
```
    The title of file request. This is shown in the Box UI to users uploading files.
    This defaults to title of the file request that was copied to create this file request.
  - description
```
protected String description
```
    The optional description of this file request. This is shown in the Box UI to users uploading files.
    This defaults to description of the file request that was copied to create this file request.
  - status
```
protected EnumWrapper<FileRequestStatusField> status
```
    The status of the file request. This defaults to `active`.
    When the status is set to `inactive`, the file request will no longer accept new submissions, and any visitor to the file request URL will receive a `HTTP 404` status code.
    This defaults to status of file request that was copied to create this file request.
  - isEmailRequired
```
protected Boolean isEmailRequired
```
    Whether a file request submitter is required to provide their email address.
    When this setting is set to true, the Box UI will show an email field on the file request form.
    This defaults to setting of file request that was copied to create this file request.
  - isDescriptionRequired
```
protected Boolean isDescriptionRequired
```
    Whether a file request submitter is required to provide a description of the files they are submitting.
    When this setting is set to true, the Box UI will show a description field on the file request form.
    This defaults to setting of file request that was copied to create this file request.
  - expiresAt
```
protected OffsetDateTime expiresAt
```
    The date after which a file request will no longer accept new submissions.
    After this date, the `status` will automatically be set to `inactive`.
  - folder
```
protected final FolderMini folder
```
  - url
```
protected String url
```
    The generated URL for this file request. This URL can be shared with users to let them upload files to the associated folder.
  - etag
```
protected String etag
```
    The HTTP `etag` of this file. This can be used in combination with the `If-Match` header when updating a file request. By providing that header, a change will only be performed on the file request if the `etag` on the file request still matches the `etag` provided in the `If-Match` header.
  - createdBy
```
protected UserMini createdBy
```
  - createdAt
```
protected final OffsetDateTime createdAt
```
    The date and time when the file request was created.
  - updatedBy
```
protected UserMini updatedBy
```
  - updatedAt
```
protected final OffsetDateTime updatedAt
```
    The date and time when the file request was last updated.
- Constructor Detail
  - FileRequest
```
public FileRequest(String id,
                   FolderMini folder,
                   OffsetDateTime createdAt,
                   OffsetDateTime updatedAt)
```
  - FileRequest
```
protected FileRequest(FileRequest.Builder builder)
```
- Method Detail
  - getId
```
public String getId()
```
  - getType
```
public EnumWrapper<FileRequestTypeField> getType()
```
  - getTitle
```
public String getTitle()
```
  - getDescription
```
public String getDescription()
```
  - getStatus
```
public EnumWrapper<FileRequestStatusField> getStatus()
```
  - getIsEmailRequired
```
public Boolean getIsEmailRequired()
```
  - getIsDescriptionRequired
```
public Boolean getIsDescriptionRequired()
```
  - getExpiresAt
```
public OffsetDateTime getExpiresAt()
```
  - getFolder
```
public FolderMini getFolder()
```
  - getUrl
```
public String getUrl()
```
  - getEtag
```
public String getEtag()
```
  - getCreatedBy
```
public UserMini getCreatedBy()
```
  - getCreatedAt
```
public OffsetDateTime getCreatedAt()
```
  - getUpdatedBy
```
public UserMini getUpdatedBy()
```
  - getUpdatedAt
```
public OffsetDateTime getUpdatedAt()
```
  - 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

Class FileRequest

Nested Class Summary

Field Summary

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

id

type

title

description

status

isEmailRequired

isDescriptionRequired

expiresAt

folder

url

etag

createdBy

createdAt

updatedBy

updatedAt

Constructor Detail

FileRequest

FileRequest

Method Detail

getId

getType

getTitle

getDescription

getStatus

getIsEmailRequired

getIsDescriptionRequired

getExpiresAt

getFolder

getUrl

getEtag

getCreatedBy

getCreatedAt

getUpdatedBy

getUpdatedAt

equals

hashCode

toString