com.aliyun.odps.tunnel

Class VolumeTunnel.DownloadSession

java.lang.Object

com.aliyun.odps.tunnel.VolumeTunnel.DownloadSession

Enclosing class:

VolumeTunnel

public class VolumeTunnel.DownloadSession
extends Object

此类表示一个向ODPS中下载Volume的会话

向ODPS下载Volume的流程如下:
1) 创建DownloadSession
2) 下载数据

Constructor Summary

Constructors

Constructor and Description
DownloadSession(String projectName, String volumeName, String partitionSpec, String fileName) 构造一个新的VolumeTunnel.DownloadSession。
DownloadSession(String projectName, String volumeName, String partitionSpec, String fileName, String downloadId) 根据已有downloadId构造一个VolumeTunnel.DownloadSession对象。

Method Summary

Modifier and Type	Method and Description
long	getFileLength() 获取当前VolumeTunnel.DownloadSession操作的File的长度。
String	getId() 获取当前VolumeTunnel.DownloadSession的唯一标识符
VolumeTunnel.DownloadStatus	getStatus() 获取当前VolumeTunnel.DownloadSession的Status
InputStream	openInputStream() 创建InputStream用来将指定File以数据流的形式输出。
InputStream	openInputStream(boolean compress) 创建InputStream用来将指定File以数据流的形式输出。
InputStream	openInputStream(long start, long length) 创建InputStream用来将指定File以数据流的形式输出。
InputStream	openInputStream(long start, long length, boolean compress) 创建InputStream用来将指定File以数据流的形式输出。

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadSession

public DownloadSession(String projectName,
                       String volumeName,
                       String partitionSpec,
                       String fileName)
                throws TunnelException

构造一个新的VolumeTunnel.DownloadSession。

Parameters:

projectName - 下载File所在project名称

volumeName - 下载File所在volume名称

partitionSpec - 下载File的partition描述，格式如下: pt=xxx,dt=xxx

fileName - 下载File的名称

Throws:

TunnelException

DownloadSession

public DownloadSession(String projectName,
                       String volumeName,
                       String partitionSpec,
                       String fileName,
                       String downloadId)
                throws TunnelException

根据已有downloadId构造一个VolumeTunnel.DownloadSession对象。

Parameters:

projectName - 下载File所在project名称

volumeName - 下载File所在volume名称

partitionSpec - 下载File的partition描述，格式如下: pt=xxx,dt=xxx

fileName - 下载File的名称

downloadId - DownloadSession的唯一标识符

Throws:

TunnelException

Method Detail

openInputStream

public InputStream openInputStream()
                            throws TunnelException,
                                   IOException

创建InputStream用来将指定File以数据流的形式输出。

Throws:

TunnelException

IOException

openInputStream

public InputStream openInputStream(boolean compress)
                            throws TunnelException,
                                   IOException

创建InputStream用来将指定File以数据流的形式输出。

Parameters:

compress - 压缩选项,即使设置了压缩选项，如果server 不支持压缩，传输数据也不会被压缩

Throws:

TunnelException

IOException

openInputStream

public InputStream openInputStream(long start,
                                   long length)
                            throws TunnelException,
                                   IOException

创建InputStream用来将指定File以数据流的形式输出。

Parameters:

start - 本次要读的起始位置。

length - 本次要读的字节数量。

Throws:

TunnelException

IOException

openInputStream

public InputStream openInputStream(long start,
                                   long length,
                                   boolean compress)
                            throws TunnelException,
                                   IOException

创建InputStream用来将指定File以数据流的形式输出。

Parameters:

start - 本次要读的起始位置。

length - 本次要读的字节数量。

compress - 压缩选项,即使设置了压缩选项，如果server 不支持压缩，传输数据也不会被压缩

Throws:

TunnelException

IOException

getFileLength

public long getFileLength()

获取当前VolumeTunnel.DownloadSession操作的File的长度。

getId

public String getId()

获取当前VolumeTunnel.DownloadSession的唯一标识符

getStatus

public VolumeTunnel.DownloadStatus getStatus()
                                      throws TunnelException,
                                             IOException

获取当前VolumeTunnel.DownloadSession的Status

Throws:

TunnelException

IOException