DownloadParams

class DownloadParams(val file: String? = null, val returnEtag: Boolean? = null, val volume: String? = null)

This interface defines the options that can be sent into the download data set function

Constructors

Link copied to clipboard
fun DownloadParams(file: String? = null, returnEtag: Boolean? = null, volume: String? = null)

Properties

Link copied to clipboard
val file: String? = null

The local file to download the data set to, e.g. "./path/to/file.txt"

Link copied to clipboard
val returnEtag: Boolean? = null

The indicator to force return of ETag. If set to 'true' it forces the response to include an "ETag" header, regardless of the size of the response data. If it is not present, the default is to only send an Etag for data sets smaller than a system determined length, which is at least 8 MB.

Link copied to clipboard
val volume: String? = null

The volume on which the data set is stored