Package com.dnanexus

Class DXProject.ArchiveRequestBuilder

java.lang.Object

com.dnanexus.DXProject.ArchiveRequestBuilder

Enclosing class:

DXProject

public class DXProject.ArchiveRequestBuilder
extends Object

Builder for archive requests.

Constructor Summary

Constructors

Constructor	Description
ArchiveRequestBuilder()

Method Summary

Modifier and Type	Method	Description
DXProject.ArchiveRequestBuilder	addFile(DXFile file)	Adds the file to the list of files for archival.
DXProject.ArchiveRequestBuilder	addFiles(DXFile... files)	Adds the files to the list of files for archival.
DXProject.ArchiveRequestBuilder	addFiles(Collection<DXFile> files)	Adds the files to the list of files for archival.
DXProject.ArchiveResults	execute()	Executes the request.
DXProject.ArchiveRequestBuilder	setAllCopies(Boolean allCopies)	Sets flag to enforce the transition of files into ArchivalState.ARCHIVED state.
DXProject.ArchiveRequestBuilder	setFolder(String folder)	Sets folder for archival.
DXProject.ArchiveRequestBuilder	setFolder(String folder, Boolean recurse)	Sets folder for archival.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveRequestBuilder

public ArchiveRequestBuilder()

Method Detail

addFile

public DXProject.ArchiveRequestBuilder addFile(DXFile file)

Adds the file to the list of files for archival.

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 archived

Returns:

the same builder object

addFiles

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

Adds the files to the list of files for archival.

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 archived

Returns:

the same builder object

addFiles

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

Adds the files to the list of files for archival.

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 archived

Returns:

the same builder object

setFolder

public DXProject.ArchiveRequestBuilder setFolder(String folder)

Sets folder for archival.

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 archived

Returns:

the same builder object

setFolder

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

Sets folder for archival.

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 archived

recurse - whether to archive all files in subfolders of folder

Returns:

the same builder object

setAllCopies

public DXProject.ArchiveRequestBuilder setAllCopies(Boolean allCopies)

Sets flag to enforce the transition of files into ArchivalState.ARCHIVED state. If true, archive all the copies of files in projects with the same billTo org. If false, archive only the copy of the file in the current project, while other copies of the file in the rest projects with the same billTo org will stay in the live state.

Parameters:

allCopies - whether to enforce archival of all copies of files within the same billTo org

Returns:

the same builder object

execute

public DXProject.ArchiveResults execute()

Executes the request.

Returns:

execution results