com.box.sdkgen.schemas.uploadsession

Class UploadSession

Object

NullableFieldTracker

SerializableObject

UploadSession

All Implemented Interfaces:

Serializable

public class UploadSession
extends SerializableObject

An upload session for chunk uploading a file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UploadSession.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id The unique identifier for this session.
protected Integer	numPartsProcessed The number of parts that have been uploaded and processed by the server.
protected Long	partSize The size in bytes that must be used for all parts of of the upload.
protected UploadSessionSessionEndpointsField	sessionEndpoints
protected OffsetDateTime	sessionExpiresAt The date and time when this session expires.
protected Integer	totalParts The total number of parts expected in this upload session, as determined by the file size and part size.
protected EnumWrapper<UploadSessionTypeField>	type The value will always be `upload_session`.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getId()
Integer	getNumPartsProcessed()
Long	getPartSize()
UploadSessionSessionEndpointsField	getSessionEndpoints()
OffsetDateTime	getSessionExpiresAt()
Integer	getTotalParts()
EnumWrapper<UploadSessionTypeField>	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 String id

The unique identifier for this session.

type

protected EnumWrapper<UploadSessionTypeField> type

The value will always be `upload_session`.

sessionExpiresAt

protected OffsetDateTime sessionExpiresAt

The date and time when this session expires.

partSize

protected Long partSize

The size in bytes that must be used for all parts of of the upload.

Only the last part is allowed to be of a smaller size.

totalParts

protected Integer totalParts

The total number of parts expected in this upload session, as determined by the file size and part size.

numPartsProcessed

protected Integer numPartsProcessed

The number of parts that have been uploaded and processed by the server. This starts at `0`.

When committing a file files, inspecting this property can provide insight if all parts have been uploaded correctly.

sessionEndpoints

protected UploadSessionSessionEndpointsField sessionEndpoints

Constructor Detail

UploadSession

public UploadSession()

UploadSession

protected UploadSession(UploadSession.Builder builder)

Method Detail

getId

public String getId()

getType

public EnumWrapper<UploadSessionTypeField> getType()

getSessionExpiresAt

public OffsetDateTime getSessionExpiresAt()

getPartSize

public Long getPartSize()

getTotalParts

public Integer getTotalParts()

getNumPartsProcessed

public Integer getNumPartsProcessed()

getSessionEndpoints

public UploadSessionSessionEndpointsField getSessionEndpoints()

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