com.box.sdkgen.schemas.zipdownload

Class ZipDownload

Object

NullableFieldTracker

SerializableObject

ZipDownload

All Implemented Interfaces:

Serializable

public class ZipDownload
extends SerializableObject

Represents a successful request to create a `zip` archive of a list of files and folders.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZipDownload.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected String	downloadUrl The URL that can be used to download the `zip` archive.
protected OffsetDateTime	expiresAt The time and date when this archive will expire.
protected List<List<ZipDownloadNameConflictsField>>	nameConflicts A list of conflicts that occurred when trying to create the archive.
protected String	statusUrl The URL that can be used to get the status of the `zip` archive being downloaded.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDownloadUrl()
OffsetDateTime	getExpiresAt()
List<List<ZipDownloadNameConflictsField>>	getNameConflicts()
String	getStatusUrl()
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

downloadUrl

protected String downloadUrl

The URL that can be used to download the `zip` archive. A `Get` request to this URL will start streaming the items requested. By default, this URL is only valid for a few seconds, until the `expires_at` time, unless a download is started after which it is valid for the duration of the download.

It is important to note that the domain and path of this URL might change between API calls, and therefore it's important to use this URL as-is.

statusUrl

protected String statusUrl

The URL that can be used to get the status of the `zip` archive being downloaded. A `Get` request to this URL will return the number of files in the archive as well as the number of items already downloaded or skipped. By default, this URL is only valid for a few seconds, until the `expires_at` time, unless a download is started after which the URL is valid for 12 hours from the start of the download.

It is important to note that the domain and path of this URL might change between API calls, and therefore it's important to use this URL as-is.

expiresAt

protected OffsetDateTime expiresAt

The time and date when this archive will expire. After this time the `status_url` and `download_url` will return an error.

By default, these URLs are only valid for a few seconds, unless a download is started after which the `download_url` is valid for the duration of the download, and the `status_url` is valid for 12 hours from the start of the download.

nameConflicts

protected List<List<ZipDownloadNameConflictsField>> nameConflicts

A list of conflicts that occurred when trying to create the archive. This would occur when multiple items have been requested with the same name.

To solve these conflicts, the API will automatically rename an item and return a mapping between the original item's name and its new name.

For every conflict, both files will be renamed and therefore this list will always be a multiple of 2.

Constructor Detail

ZipDownload

public ZipDownload()

ZipDownload

protected ZipDownload(ZipDownload.Builder builder)

Method Detail

getDownloadUrl

public String getDownloadUrl()

getStatusUrl

public String getStatusUrl()

getExpiresAt

public OffsetDateTime getExpiresAt()

getNameConflicts

public List<List<ZipDownloadNameConflictsField>> getNameConflicts()

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