ZipDownloadsManager (Box Java SDK)

Object
- ZipDownloadsManager

public class ZipDownloadsManager
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ZipDownloadsManager.Builder

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

Field Summary

Fields
Modifier and Type Field and Description

Authentication auth

NetworkSession networkSession

Fields
Modifier and Type	Field and Description
`Authentication`	`auth`
`NetworkSession`	`networkSession`

Constructor Summary

Constructors
Modifier Constructor and Description

ZipDownloadsManager()

protected ZipDownloadsManager(ZipDownloadsManager.Builder builder)

Constructors
Modifier	Constructor and Description
	`ZipDownloadsManager()`
`protected`	`ZipDownloadsManager(ZipDownloadsManager.Builder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ZipDownload`	`createZipDownload(ZipDownloadRequest requestBody)` Creates a request to download multiple files and folders as a single `zip` archive file.
`ZipDownload`	`createZipDownload(ZipDownloadRequest requestBody, CreateZipDownloadHeaders headers)` Creates a request to download multiple files and folders as a single `zip` archive file.
`InputStream`	`downloadZip(ZipDownloadRequest requestBody)` Creates a zip and downloads its content
`InputStream`	`downloadZip(ZipDownloadRequest requestBody, DownloadZipHeaders headers)` Creates a zip and downloads its content
`Authentication`	`getAuth()`
`NetworkSession`	`getNetworkSession()`
`InputStream`	`getZipDownloadContent(String downloadUrl)` Returns the contents of a `zip` archive in binary format.
`InputStream`	`getZipDownloadContent(String downloadUrl, GetZipDownloadContentHeaders headers)` Returns the contents of a `zip` archive in binary format.
`ZipDownloadStatus`	`getZipDownloadStatus(String statusUrl)` Returns the download status of a `zip` archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped.
`ZipDownloadStatus`	`getZipDownloadStatus(String statusUrl, GetZipDownloadStatusHeaders headers)` Returns the download status of a `zip` archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - auth
```
public Authentication auth
```
  - networkSession
```
public NetworkSession networkSession
```
- Constructor Detail
  - ZipDownloadsManager
```
public ZipDownloadsManager()
```
  - ZipDownloadsManager
```
protected ZipDownloadsManager(ZipDownloadsManager.Builder builder)
```
- Method Detail
  - createZipDownload
```
public ZipDownload createZipDownload(ZipDownloadRequest requestBody)
```
    Creates a request to download multiple files and folders as a single `zip` archive file. This API does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a `download_url` and a `status_url` that can be used to download the archive.
    The limit for an archive is either the Account's upload limit or 10,000 files, whichever is met first.
    **Note**: Downloading a large file can be affected by various factors such as distance, network latency, bandwidth, and congestion, as well as packet loss ratio and current server load. For these reasons we recommend that a maximum ZIP archive total size does not exceed 25GB.
    
    Parameters:
    
    requestBody - Request body of createZipDownload method
  - createZipDownload
```
public ZipDownload createZipDownload(ZipDownloadRequest requestBody,
                                     CreateZipDownloadHeaders headers)
```
    Creates a request to download multiple files and folders as a single `zip` archive file. This API does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a `download_url` and a `status_url` that can be used to download the archive.
    The limit for an archive is either the Account's upload limit or 10,000 files, whichever is met first.
    **Note**: Downloading a large file can be affected by various factors such as distance, network latency, bandwidth, and congestion, as well as packet loss ratio and current server load. For these reasons we recommend that a maximum ZIP archive total size does not exceed 25GB.
    
    Parameters:
    
    requestBody - Request body of createZipDownload method
    
    headers - Headers of createZipDownload method
  - getZipDownloadContent
```
public InputStream getZipDownloadContent(String downloadUrl)
```
    Returns the contents of a `zip` archive in binary format. This URL does not require any form of authentication and could be used in a user's browser to download the archive to a user's device.
    By default, this URL is only valid for a few seconds from the creation of the request for this archive. Once a download has started it can not be stopped and resumed, instead a new request for a zip archive would need to be created.
    The URL of this endpoint should not be considered as fixed. Instead, use the [Create zip download](https://developer.box.com/reference/post-zip-downloads) API to request to create a `zip` archive, and then follow the `download_url` field in the response to this endpoint.
    
    Parameters:
    
    downloadUrl - The URL that can be used to download created `zip` archive. Example: `https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content`
  - getZipDownloadContent
```
public InputStream getZipDownloadContent(String downloadUrl,
                                         GetZipDownloadContentHeaders headers)
```
    Returns the contents of a `zip` archive in binary format. This URL does not require any form of authentication and could be used in a user's browser to download the archive to a user's device.
    By default, this URL is only valid for a few seconds from the creation of the request for this archive. Once a download has started it can not be stopped and resumed, instead a new request for a zip archive would need to be created.
    The URL of this endpoint should not be considered as fixed. Instead, use the [Create zip download](https://developer.box.com/reference/post-zip-downloads) API to request to create a `zip` archive, and then follow the `download_url` field in the response to this endpoint.
    
    Parameters:
    
    downloadUrl - The URL that can be used to download created `zip` archive. Example: `https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content`
    
    headers - Headers of getZipDownloadContent method
  - getZipDownloadStatus
```
public ZipDownloadStatus getZipDownloadStatus(String statusUrl)
```
    Returns the download status of a `zip` archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped.
    This endpoint can only be accessed once the download has started. Subsequently this endpoint is valid for 12 hours from the start of the download.
    The URL of this endpoint should not be considered as fixed. Instead, use the [Create zip download](https://developer.box.com/reference/post-zip-downloads) API to request to create a `zip` archive, and then follow the `status_url` field in the response to this endpoint.
    
    Parameters:
    
    statusUrl - The URL that can be used to get the status of the `zip` archive being downloaded. Example: `https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status`
  - getZipDownloadStatus
```
public ZipDownloadStatus getZipDownloadStatus(String statusUrl,
                                              GetZipDownloadStatusHeaders headers)
```
    Returns the download status of a `zip` archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped.
    This endpoint can only be accessed once the download has started. Subsequently this endpoint is valid for 12 hours from the start of the download.
    The URL of this endpoint should not be considered as fixed. Instead, use the [Create zip download](https://developer.box.com/reference/post-zip-downloads) API to request to create a `zip` archive, and then follow the `status_url` field in the response to this endpoint.
    
    Parameters:
    
    statusUrl - The URL that can be used to get the status of the `zip` archive being downloaded. Example: `https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status`
    
    headers - Headers of getZipDownloadStatus method
  - downloadZip
```
public InputStream downloadZip(ZipDownloadRequest requestBody)
```
    Creates a zip and downloads its content
    
    Parameters:
    
    requestBody - Zip download request body
  - downloadZip
```
public InputStream downloadZip(ZipDownloadRequest requestBody,
                               DownloadZipHeaders headers)
```
    Creates a zip and downloads its content
    
    Parameters:
    
    requestBody - Zip download request body
    
    headers - Headers of zip download method
  - getAuth
```
public Authentication getAuth()
```
  - getNetworkSession
```
public NetworkSession getNetworkSession()
```

Class ZipDownloadsManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

auth

networkSession

Constructor Detail

ZipDownloadsManager

ZipDownloadsManager

Method Detail

createZipDownload

createZipDownload

getZipDownloadContent

getZipDownloadContent

getZipDownloadStatus

getZipDownloadStatus

downloadZip

downloadZip

getAuth

getNetworkSession