com.dnanexus

Enum ArchivalState

java.lang.Object

java.lang.Enum<ArchivalState>

com.dnanexus.ArchivalState

All Implemented Interfaces:

Serializable, Comparable<ArchivalState>

public enum ArchivalState
extends Enum<ArchivalState>

Archival states of file object.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARCHIVAL Archival requested on the current file, but other copies of the same file are in the live state in multiple projects with the same billTo entity.
ARCHIVED The file is in archival storage, such as AWS S3 Glacier or Azure Blob ARCHIVE.
LIVE The file is in standard storage, such as AWS S3 or Azure Blob.
UNARCHIVING Unarchival requested on the current file.

Method Summary

Modifier and Type	Method and Description
static ArchivalState	valueOf(String name) Returns the enum constant of this type with the specified name.
static ArchivalState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ARCHIVED

public static final ArchivalState ARCHIVED

The file is in archival storage, such as AWS S3 Glacier or Azure Blob ARCHIVE.

LIVE

public static final ArchivalState LIVE

The file is in standard storage, such as AWS S3 or Azure Blob.

ARCHIVAL

public static final ArchivalState ARCHIVAL

Archival requested on the current file, but other copies of the same file are in the live state in multiple projects with the same billTo entity. The file is still in standard storage.

UNARCHIVING

public static final ArchivalState UNARCHIVING

Unarchival requested on the current file. The file is in transition from archival storage to standard storage.

Method Detail

values

public static ArchivalState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ArchivalState c : ArchivalState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ArchivalState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null