DXFile.Describe (dnanexus-api 0.1.0-SNAPSHOT API)

java.lang.Object
- com.dnanexus.DXDataObject.Describe
- - com.dnanexus.DXFile.Describe

Enclosing class:: DXFile

public static class DXFile.Describe
extends DXDataObject.Describe

Contains metadata for a file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ArchivalState`	`getArchivalState()`	Returns the archival state of the file.
`Long`	`getChunkSize(int index)`	Returns the size the specified file part in bytes.
`List<Integer>`	`getFilePartsList()`	Returns a list of indices corresponding to parts of the file
`String`	`getMD5(int index)`	Returns the hexadecimal encoded value of MD5 message-digest of the specified file part.
`String`	`getMediaType()`	Returns the Internet Media Type of the file.
`long`	`getSize()`	Returns the size of the file in bytes.

Methods inherited from class com.dnanexus.DXDataObject.Describe
getCreationDate, getDetails, getFolder, getModificationDate, getName, getProject, getProperties, getState, getTags, getTypes, isVisible

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getChunkSize
```
public Long getChunkSize(int index)
```
    Returns the size the specified file part in bytes.
    
    Parameters:
    
    index - part index that was provided to the file upload call
    
    Returns:
    
    size of the file part
    
    Throws:
    
    IllegalArgumentException - when the index supplied is not a file part
  - getFilePartsList
```
public List<Integer> getFilePartsList()
```
    Returns a list of indices corresponding to parts of the file
    
    Returns:
    
    list of file part indices
  - getMD5
```
public String getMD5(int index)
```
    Returns the hexadecimal encoded value of MD5 message-digest of the specified file part.
    
    Parameters:
    
    index - part index that was provided to the file upload call
    
    Returns:
    
    file part md5 digested as a string
    
    Throws:
    
    IllegalArgumentException - when the index supplied is not a file part
  - getMediaType
```
public String getMediaType()
```
    Returns the Internet Media Type of the file.
    
    Returns:
    
    Internet Media Type
  - getSize
```
public long getSize()
```
    Returns the size of the file in bytes.
    
    Returns:
    
    size of file
  - getArchivalState
```
public ArchivalState getArchivalState()
```
    Returns the archival state of the file.
    
    Returns:
    
    archival state of file