ObjectDownloadParams 0.8.0 API

All Implemented Interfaces:

org.veupathdb.lib.s3.s34k.params.RegionRequestParams , org.veupathdb.lib.s3.s34k.params.S3RequestParams
```
public interface ObjectDownloadParams
 implements RegionRequestParams
                    
```
Object download request parameters.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract File`	`getLocalFile()`	Required handle on the local file into which the remote object will be downloaded.
`abstract Unit`	`setLocalFile(File localFile)`	Required handle on the local file into which the remote object will be downloaded.
`abstract Function1<FileObject, Unit>`	`getCallback()`	Optional callback that will be executed on successful completion of the S3 operation.
`abstract Unit`	`setCallback(Function1<FileObject, Unit> callback)`	Optional callback that will be executed on successful completion of the S3 operation.

Methods inherited from class org.veupathdb.lib.s3.s34k.params.RegionRequestParams
getRegion, setRegion
Methods inherited from class org.veupathdb.lib.s3.s34k.params.S3RequestParams
getHeaders, getQueryParams
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getLocalFile
```
 abstract File getLocalFile()
```
    Required handle on the local file into which the remote object will be downloaded.
    This file does not need to already exist.
    This value must be set or an InvalidRequestConfigError will be thrown when the request is attempted.
  - setLocalFile
```
 abstract Unit setLocalFile(File localFile)
```
    Required handle on the local file into which the remote object will be downloaded.
    This file does not need to already exist.
    This value must be set or an InvalidRequestConfigError will be thrown when the request is attempted.
  - getCallback
```
 abstract Function1<FileObject, Unit> getCallback()
```
    Optional callback that will be executed on successful completion of the S3 operation.
    This callback will be passed an FileObject instance representing the file that was downloaded.
  - setCallback
```
 abstract Unit setCallback(Function1<FileObject, Unit> callback)
```
    Optional callback that will be executed on successful completion of the S3 operation.
    This callback will be passed an FileObject instance representing the file that was downloaded.