Package com.dnanexus

Class DXProject.UnarchiveRequestBuilder

java.lang.Object

com.dnanexus.DXProject.UnarchiveRequestBuilder

Enclosing class:

DXProject

public class DXProject.UnarchiveRequestBuilder
extends Object

Builder for unarchive requests.

Constructor Summary

Constructors

Constructor	Description
UnarchiveRequestBuilder()

Method Summary

Modifier and Type	Method	Description
DXProject.UnarchiveRequestBuilder	addFile(DXFile file)	Adds the file to the list of files for unarchiving.
DXProject.UnarchiveRequestBuilder	addFiles(DXFile... files)	Adds the files to the list of files for unarchiving.
DXProject.UnarchiveRequestBuilder	addFiles(Collection<DXFile> files)	Adds the files to the list of files for unarchiving.
DXProject.UnarchiveResults	execute()	Executes the request.
DXProject.UnarchiveRequestBuilder	setDryRun(Boolean dryRun)	Sets dry-run mode.
DXProject.UnarchiveRequestBuilder	setFolder(String folder)	Sets folder for unarchiving.
DXProject.UnarchiveRequestBuilder	setFolder(String folder, Boolean recurse)	Sets folder for unarchiving.
DXProject.UnarchiveRequestBuilder	setRate(UnarchivingRate rate)	Sets the speed at which the files in this request are unarchived.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnarchiveRequestBuilder

public UnarchiveRequestBuilder()

Method Detail

addFile

public DXProject.UnarchiveRequestBuilder addFile(DXFile file)

Adds the file to the list of files for unarchiving.

This method may be called multiple times during the construction of a request, and is mutually exclusive with setFolder(String) and setFolder(String, Boolean).

Parameters:

file - DXFile instance to be unarchived

Returns:

the same builder object

addFiles

public DXProject.UnarchiveRequestBuilder addFiles(DXFile... files)

Adds the files to the list of files for unarchiving.

This method may be called multiple times during the construction of a request, and is mutually exclusive with setFolder(String) and setFolder(String, Boolean).

Parameters:

files - list of DXFile instances to be unarchived

Returns:

the same builder object

addFiles

public DXProject.UnarchiveRequestBuilder addFiles(Collection<DXFile> files)

Adds the files to the list of files for unarchiving.

This method may be called multiple times during the construction of a request, and is mutually exclusive with setFolder(String) and setFolder(String, Boolean).

Parameters:

files - collection of DXFile instances to be unarchived

Returns:

the same builder object

setFolder

public DXProject.UnarchiveRequestBuilder setFolder(String folder)

Sets folder for unarchiving.

This method may only be called once during the construction of a request, and is mutually exclusive with addFile(DXFile), addFiles(DXFile...), and addFiles(Collection).

Parameters:

folder - path to folder to be unarchived

Returns:

the same builder object

setFolder

public DXProject.UnarchiveRequestBuilder setFolder(String folder,
                                                   Boolean recurse)

Sets folder for unarchiving.

This method may only be called once during the construction of a request, and is mutually exclusive with addFile(DXFile), addFiles(DXFile...), and addFiles(Collection).

Parameters:

folder - path to folder to be unarchived

recurse - whether to unarchive all files in subfolders of folder

Returns:

the same builder object

setRate

public DXProject.UnarchiveRequestBuilder setRate(UnarchivingRate rate)

Sets the speed at which the files in this request are unarchived.

Valid only for AWS.

Parameters:

rate - speed of unarchiving

Returns:

the same builder object

setDryRun

public DXProject.UnarchiveRequestBuilder setDryRun(Boolean dryRun)

Sets dry-run mode. If true, only display the output of the API call without executing the unarchival process.

Parameters:

dryRun - whether the unarchival process should be actually executed or not

Returns:

the same builder object

execute

public DXProject.UnarchiveResults execute()

Executes the request.

Returns:

execution results