DownloadFileRequest (Aliyun OSS SDK for Java 2.5.0 API)

java.lang.Object
- com.aliyun.oss.model.WebServiceRequest
- - com.aliyun.oss.model.GenericRequest
  - - com.aliyun.oss.model.DownloadFileRequest

public class DownloadFileRequest
extends GenericRequest

文件分片下载请求

字段概要
- 从类继承的字段 com.aliyun.oss.model.WebServiceRequest
  NOOP

构造器概要

构造器
构造器和说明
`DownloadFileRequest(String bucketName, String key)`
`DownloadFileRequest(String bucketName, String key, String downloadFile, long partSize)`
`DownloadFileRequest(String bucketName, String key, String downloadFile, long partSize, int taskNum, boolean enableCheckpoint)`
`DownloadFileRequest(String bucketName, String key, String downloadFile, long partSize, int taskNum, boolean enableCheckpoint, String checkpointFile)`

方法概要

方法
限定符和类型	方法和说明
`void`	`clearMatchingETagConstraints()`
`void`	`clearNonmatchingETagConstraints()`
`String`	`getCheckpointFile()`
`String`	`getDownloadFile()`
`List<String>`	`getMatchingETagConstraints()` 返回“If-Match”参数，表示：如果传入期望的 ETag 和 object 的 ETag 匹配，正常的发送文件。
`Date`	`getModifiedSinceConstraint()` 返回“If-Modified-Since”参数。
`List<String>`	`getNonmatchingETagConstraints()` 返回“If-None-Match”参数，可以用来检查文件是否有更新。
`long`	`getPartSize()`
`ResponseHeaderOverrides`	`getResponseHeaders()` 返回要重载的返回请求头。
`int`	`getTaskNum()`
`String`	`getTempDownloadFile()`
`Date`	`getUnmodifiedSinceConstraint()` 返回“If-Unmodified-Since”参数。
`boolean`	`isEnableCheckpoint()`
`void`	`setCheckpointFile(String checkpointFile)`
`void`	`setDownloadFile(String downloadFile)`
`void`	`setEnableCheckpoint(boolean enableCheckpoint)`
`void`	`setMatchingETagConstraints(List<String> eTagList)` 返回“If-Match”参数（可选）。
`void`	`setModifiedSinceConstraint(Date date)` 设置“If-Modified-Since”参数（可选）。
`void`	`setNonmatchingETagConstraints(List<String> eTagList)` 返回“If-None-Match”参数，可以用来检查文件是否有更新（可选）。
`void`	`setPartSize(long partSize)`
`void`	`setResponseHeaders(ResponseHeaderOverrides responseHeaders)` 设置要重载的返回请求头（可选）。
`void`	`setTaskNum(int taskNum)`
`void`	`setUnmodifiedSinceConstraint(Date date)` 设置“If-Unmodified-Since”参数（可选）。

从类继承的方法 com.aliyun.oss.model.GenericRequest
getBucketName, getKey, setBucketName, setKey, withBucketName, withKey

从类继承的方法 com.aliyun.oss.model.WebServiceRequest
addHeader, addParameter, getHeaders, getParameters, getProgressListener, setHeaders, setParameters, setProgressListener, withProgressListener

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - DownloadFileRequest
```
public DownloadFileRequest(String bucketName,
                   String key)
```
  - DownloadFileRequest
```
public DownloadFileRequest(String bucketName,
                   String key,
                   String downloadFile,
                   long partSize)
```
  - DownloadFileRequest
```
public DownloadFileRequest(String bucketName,
                   String key,
                   String downloadFile,
                   long partSize,
                   int taskNum,
                   boolean enableCheckpoint)
```
  - DownloadFileRequest
```
public DownloadFileRequest(String bucketName,
                   String key,
                   String downloadFile,
                   long partSize,
                   int taskNum,
                   boolean enableCheckpoint,
                   String checkpointFile)
```
- 方法详细资料
  - getPartSize
```
public long getPartSize()
```
  - setPartSize
```
public void setPartSize(long partSize)
```
  - getTaskNum
```
public int getTaskNum()
```
  - setTaskNum
```
public void setTaskNum(int taskNum)
```
  - getDownloadFile
```
public String getDownloadFile()
```
  - getTempDownloadFile
```
public String getTempDownloadFile()
```
  - setDownloadFile
```
public void setDownloadFile(String downloadFile)
```
  - isEnableCheckpoint
```
public boolean isEnableCheckpoint()
```
  - setEnableCheckpoint
```
public void setEnableCheckpoint(boolean enableCheckpoint)
```
  - getCheckpointFile
```
public String getCheckpointFile()
```
  - setCheckpointFile
```
public void setCheckpointFile(String checkpointFile)
```
  - getMatchingETagConstraints
```
public List<String> getMatchingETagConstraints()
```
    返回“If-Match”参数，表示：如果传入期望的 ETag 和 object 的 ETag 匹配，正常的发送文件。如果不符合，返回错误。
    
    返回:
    表示期望object的ETag与之匹配的ETag列表。
  - setMatchingETagConstraints
```
public void setMatchingETagConstraints(List<String> eTagList)
```
    返回“If-Match”参数（可选）。表示如果传入期望的 ETag 和 Object 的 ETag 匹配，则正常的发送文件。如果不符合，则返回错误。
    
    参数:
    eTagList - 表示期望object的ETag与之匹配的ETag列表。目前OSS支持传入一个ETag，如果传入多于一个ETag，将只有列表中的第一个有效。
  - clearMatchingETagConstraints
```
public void clearMatchingETagConstraints()
```
  - getNonmatchingETagConstraints
```
public List<String> getNonmatchingETagConstraints()
```
    返回“If-None-Match”参数，可以用来检查文件是否有更新。如果传入的 ETag值和Object的ETag 相同，返回错误；否则正常传输文件。
    
    返回:
    表示期望Object的ETag与之不匹配的ETag列表。
  - setNonmatchingETagConstraints
```
public void setNonmatchingETagConstraints(List<String> eTagList)
```
    返回“If-None-Match”参数，可以用来检查文件是否有更新（可选）。如果传入的 ETag值和Object的ETag 相同，返回错误；否则正常传输文件。
    
    参数:
    eTagList - 表示期望Object的ETag与之不匹配的ETag列表。目前OSS支持传入一个ETag，如果传入多于一个ETag，将只有列表中的第一个有效。
  - clearNonmatchingETagConstraints
```
public void clearNonmatchingETagConstraints()
```
  - getUnmodifiedSinceConstraint
```
public Date getUnmodifiedSinceConstraint()
```
    返回“If-Unmodified-Since”参数。表示：如果传入参数中的时间等于或者晚于文件实际修改时间，则传送文件；如果早于实际修改时间，则返回错误。
    
    返回:
    “If-Unmodified-Since”参数。
  - setUnmodifiedSinceConstraint
```
public void setUnmodifiedSinceConstraint(Date date)
```
    设置“If-Unmodified-Since”参数（可选）。表示：如果传入参数中的时间等于或者晚于文件实际修改时间，则传送文件；如果早于实际修改时间，则返回错误。
    
    参数:
    date - “If-Unmodified-Since”参数。
  - getModifiedSinceConstraint
```
public Date getModifiedSinceConstraint()
```
    返回“If-Modified-Since”参数。表示：如果指定的时间早于实际修改时间，则正常传送文件，并返回 200 OK；如果参数中的时间和实际修改时间一样或者更晚，会返回错误。
    
    返回:
    “If-Modified-Since”参数。
  - setModifiedSinceConstraint
```
public void setModifiedSinceConstraint(Date date)
```
    设置“If-Modified-Since”参数（可选）。表示：如果指定的时间早于实际修改时间，则正常传送文件，并返回 200 OK；如果参数中的时间和实际修改时间一样或者更晚，会返回错误。
    
    参数:
    date - “If-Modified-Since”参数。
  - getResponseHeaders
```
public ResponseHeaderOverrides getResponseHeaders()
```
    返回要重载的返回请求头。
    
    返回:
    要重载的返回请求头。
  - setResponseHeaders
```
public void setResponseHeaders(ResponseHeaderOverrides responseHeaders)
```
    设置要重载的返回请求头（可选）。
    
    参数:
    responseHeaders - 要重载的返回请求头。

类 DownloadFileRequest

字段概要

从类继承的字段 com.aliyun.oss.model.WebServiceRequest

构造器概要

方法概要

从类继承的方法 com.aliyun.oss.model.GenericRequest

从类继承的方法 com.aliyun.oss.model.WebServiceRequest

从类继承的方法 java.lang.Object

构造器详细资料

DownloadFileRequest

DownloadFileRequest

DownloadFileRequest

DownloadFileRequest

方法详细资料

getPartSize

setPartSize

getTaskNum

setTaskNum

getDownloadFile

getTempDownloadFile

setDownloadFile

isEnableCheckpoint

setEnableCheckpoint

getCheckpointFile

setCheckpointFile

getMatchingETagConstraints

setMatchingETagConstraints

clearMatchingETagConstraints

getNonmatchingETagConstraints

setNonmatchingETagConstraints

clearNonmatchingETagConstraints

getUnmodifiedSinceConstraint

setUnmodifiedSinceConstraint

getModifiedSinceConstraint

setModifiedSinceConstraint

getResponseHeaders

setResponseHeaders