GetObjectRequest (Aliyun OSS SDK for Java 2.0.4 API)

java.lang.Object
- com.aliyun.oss.model.WebServiceRequest
- - com.aliyun.oss.model.GetObjectRequest

public class GetObjectRequest
extends WebServiceRequest

指定从OSS下载Object的请求参数。

构造器概要

构造器
构造器和说明
`GetObjectRequest(String bucketName, String key)` 构造函数。
`GetObjectRequest(URL absoluteUrl, Map<String,String> requestHeaders)` 使用URL签名及用户自定义头作为参数的构造函数。

方法概要

方法
限定符和类型	方法和说明
`void`	`clearMatchingETagConstraints()`
`void`	`clearNonmatchingETagConstraints()`
`URL`	`getAbsoluteUri()`
`String`	`getBucketName()` 返回Bucket名称。
`String`	`getKey()` 返回Object Key。
`List<String>`	`getMatchingETagConstraints()` 返回“If-Match”参数，表示：如果传入期望的 ETag 和 object 的 ETag 匹配，正常的发送文件。
`Date`	`getModifiedSinceConstraint()` 返回“If-Modified-Since”参数。
`List<String>`	`getNonmatchingETagConstraints()` 返回“If-None-Match”参数，可以用来检查文件是否有更新。
`long[]`	`getRange()` 返回一个值表示请求应当返回Object内容的字节范围。
`ResponseHeaderOverrides`	`getResponseHeaders()` 返回要重载的返回请求头。
`Date`	`getUnmodifiedSinceConstraint()` 返回“If-Unmodified-Since”参数。
`boolean`	`isUseUrlSignature()`
`void`	`setAbsoluteUri(URL absoluteUri)`
`void`	`setBucketName(String bucketName)` 设置Bucket名称。
`void`	`setKey(String key)` 设置Object Key。
`void`	`setMatchingETagConstraints(List<String> eTagList)` 返回“If-Match”参数（可选）。
`void`	`setModifiedSinceConstraint(Date date)` 设置“If-Modified-Since”参数（可选）。
`void`	`setNonmatchingETagConstraints(List<String> eTagList)` 返回“If-None-Match”参数，可以用来检查文件是否有更新（可选）。
`void`	`setRange(long start, long end)` 设置一个值表示请求应当返回Object内容的字节范围（可选）。
`void`	`setResponseHeaders(ResponseHeaderOverrides responseHeaders)` 设置要重载的返回请求头（可选）。
`void`	`setUnmodifiedSinceConstraint(Date date)` 设置“If-Unmodified-Since”参数（可选）。
`void`	`setUseUrlSignature(boolean useUrlSignature)`

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

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

- 构造器详细资料
  - GetObjectRequest
```
public GetObjectRequest(String bucketName,
                String key)
```
    构造函数。
    
    参数:
    bucketName - Bucket名称。
    key - Object Key。
  - GetObjectRequest
```
public GetObjectRequest(URL absoluteUrl,
                Map<String,String> requestHeaders)
```
    使用URL签名及用户自定义头作为参数的构造函数。
    
    参数:
    absoluteUri - URL签名。
    requestHeaders - 请求头。
- 方法详细资料
  - getBucketName
```
public String getBucketName()
```
    返回Bucket名称。
    
    返回:
    Bucket名称。
  - setBucketName
```
public void setBucketName(String bucketName)
```
    设置Bucket名称。
    
    参数:
    bucketName -
  - getKey
```
public String getKey()
```
    返回Object Key。
    
    返回:
    Object Key。
  - setKey
```
public void setKey(String key)
```
    设置Object Key。
    
    参数:
    key - Object Key。
  - getRange
```
public long[] getRange()
```
    返回一个值表示请求应当返回Object内容的字节范围。
    
    返回:
    一个值表示请求应当返回Object内容的字节范围。
  - setRange
```
public void setRange(long start,
            long end)
```
    设置一个值表示请求应当返回Object内容的字节范围（可选）。
    
    参数:
    start -
    范围的起始值。
    
    当值大于或等于0时，表示起始的字节位置。当值为-1时，表示不设置起始的字节位置，此时end参数不能-1，例如end为100，Range请求头的值为bytes=-100，表示获取最后100个字节。
    end -
    范围的结束值。
    
    当值小于或等于0时，表示结束的字节位或最后的字节数。当值为-1时，表示不设置结束的字节位置，此时start参数不能为-1，例如start为99，Range请求头的值为bytes=99-，表示获取第100个字节及以后的所有内容。
  - 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 - 要重载的返回请求头。
  - getAbsoluteUri
```
public URL getAbsoluteUri()
```
  - setAbsoluteUri
```
public void setAbsoluteUri(URL absoluteUri)
```
  - isUseUrlSignature
```
public boolean isUseUrlSignature()
```
  - setUseUrlSignature
```
public void setUseUrlSignature(boolean useUrlSignature)
```

类 GetObjectRequest

构造器概要

方法概要

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

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

构造器详细资料

GetObjectRequest

GetObjectRequest

方法详细资料

getBucketName

setBucketName

getKey

setKey

getRange

setRange

getMatchingETagConstraints

setMatchingETagConstraints

clearMatchingETagConstraints

getNonmatchingETagConstraints

setNonmatchingETagConstraints

clearNonmatchingETagConstraints

getUnmodifiedSinceConstraint

setUnmodifiedSinceConstraint

getModifiedSinceConstraint

setModifiedSinceConstraint

getResponseHeaders

setResponseHeaders

getAbsoluteUri

setAbsoluteUri

isUseUrlSignature

setUseUrlSignature