com.obs.services.model

Class GetObjectRequest

java.lang.Object

com.obs.services.model.GenericRequest

com.obs.services.model.BaseObjectRequest

com.obs.services.model.GetObjectMetadataRequest

com.obs.services.model.GetObjectRequest

Direct Known Subclasses:

ReadFileRequest

public class GetObjectRequest
extends GetObjectMetadataRequest

Parameters in an object download request

Field Summary

Fields inherited from class com.obs.services.model.GetObjectMetadataRequest

sseCHeader, versionId

Fields inherited from class com.obs.services.model.BaseObjectRequest

encodeHeaders, objectKey

Fields inherited from class com.obs.services.model.GenericRequest

bucketName, httpMethod, userHeaders

Constructor Summary

Constructors

Constructor and Description
GetObjectRequest()
GetObjectRequest(String bucketName, String objectKey) Constructor
GetObjectRequest(String bucketName, String objectKey, String versionId) Constructor

Method Summary

Modifier and Type	Method and Description
CacheOptionEnum	getCacheOption() Obtain the control option of the read-ahead cache.
String	getIfMatchTag() Obtain the ETag verification condition for downloading the object.
Date	getIfModifiedSince() Obtain the time condition set for downloading the object.
String	getIfNoneMatchTag() Obtain the ETag verification condition for downloading the object.
Date	getIfUnmodifiedSince() Obtain the time condition for downloading the object.
String	getImageProcess() Obtain image processing parameters.
long	getProgressInterval() Obtain the callback threshold of the data transfer listener.
ProgressListener	getProgressListener() Obtain the data transfer listener.
Long	getRangeEnd() Obtain the end position for object download.
Long	getRangeStart() Obtain the start position for object download.
ObjectRepleaceMetadata	getReplaceMetadata() Obtain the request headers that need to be rewritten during object download.
Map<String,String>	getRequestParameters()
SseCHeader	getSseCHeader() Obtain SSE-C decryption headers.
long	getTtl() Obtain the cache data expiration time.
String	getVersionId() Obtain the object version ID.
boolean	isAutoUnzipResponse() Obtain the response to whether to automatically decompress the object compressed using gzip.
boolean	isEncodeHeaders() Specifies whether to encode and decode the returned header fields.
void	setAutoUnzipResponse(boolean autoUnzipResponse) Set the response to whether to automatically decompress the object compressed using gzip.
void	setCacheOption(CacheOptionEnum cacheOption) Set the control option of the read-ahead cache.
void	setIfMatchTag(String ifMatchTag) Set the ETag verification condition for downloading the object.
void	setIfModifiedSince(Date ifModifiedSince) Set the time condition set for downloading the object.
void	setIfNoneMatchTag(String ifNoneMatchTag) Set the ETag verification condition for downloading the object.
void	setIfUnmodifiedSince(Date ifUnmodifiedSince) Set the time condition for downloading the object.
void	setImageProcess(String imageProcess) Set image processing parameters.
void	setIsEncodeHeaders(boolean encodeHeaders) Specifies whether to encode and decode the returned header fields.
void	setProgressInterval(long progressInterval) Set the callback threshold of the data transfer listener.
void	setProgressListener(ProgressListener progressListener) Set the data transfer listener.
void	setRangeEnd(Long rangeEnd) Set the end position for object download.
void	setRangeStart(Long rangeStart) Set the start position for object download.
void	setReplaceMetadata(ObjectRepleaceMetadata replaceMetadata) Set the request headers that need to be rewritten during object download.
void	setRequestParameters(Map<String,String> requestParameters)
void	setSseCHeader(SseCHeader sseCHeader) Set SSE-C decryption headers.
void	setTtl(long ttl) Set the cache data expiration time.
void	setVersionId(String versionId) Set the version ID of the object.
String	toString()

Methods inherited from class com.obs.services.model.GetObjectMetadataRequest

getObjectKey, setObjectKey

Methods inherited from class com.obs.services.model.GenericRequest

addUserHeaders, getBucketName, getHttpMethod, getUserHeaders, isRequesterPays, setBucketName, setRequesterPays, setUserHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GetObjectRequest

public GetObjectRequest()

GetObjectRequest

public GetObjectRequest(String bucketName,
                        String objectKey)

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

GetObjectRequest

public GetObjectRequest(String bucketName,
                        String objectKey,
                        String versionId)

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

versionId - Version ID of the object

Method Detail

getReplaceMetadata

public ObjectRepleaceMetadata getReplaceMetadata()

Obtain the request headers that need to be rewritten during object download.

Returns:

Rewritten response headers

setReplaceMetadata

public void setReplaceMetadata(ObjectRepleaceMetadata replaceMetadata)

Set the request headers that need to be rewritten during object download.

Parameters:

replaceMetadata - Rewritten response headers

getSseCHeader

public SseCHeader getSseCHeader()

Obtain SSE-C decryption headers.

Overrides:

getSseCHeader in class GetObjectMetadataRequest

Returns:

SSE-C decryption headers

setSseCHeader

public void setSseCHeader(SseCHeader sseCHeader)

Set SSE-C decryption headers.

Overrides:

setSseCHeader in class GetObjectMetadataRequest

Parameters:

sseCHeader - SSE-C decryption headers

getRangeStart

public Long getRangeStart()

Obtain the start position for object download.

Returns:

Start position for object download

setRangeStart

public void setRangeStart(Long rangeStart)

Set the start position for object download.

Parameters:

rangeStart - Start position for object download

getRangeEnd

public Long getRangeEnd()

Obtain the end position for object download.

Returns:

End position for object download

setRangeEnd

public void setRangeEnd(Long rangeEnd)

Set the end position for object download.

Parameters:

rangeEnd - End position for object download

getVersionId

public String getVersionId()

Obtain the object version ID.

Overrides:

getVersionId in class GetObjectMetadataRequest

Returns:

Version ID of the object

setVersionId

public void setVersionId(String versionId)

Set the version ID of the object.

Overrides:

setVersionId in class GetObjectMetadataRequest

Parameters:

versionId - Version ID of the object

getIfModifiedSince

public Date getIfModifiedSince()

Obtain the time condition set for downloading the object. Only when the object is modified after the point in time specified by this parameter, it will be downloaded. Otherwise, "304 Not Modified" will be returned.

Returns:

Time condition set for downloading the object

setIfModifiedSince

public void setIfModifiedSince(Date ifModifiedSince)

Set the time condition set for downloading the object. Only when the object is modified after the point in time specified by this parameter, it will be downloaded. Otherwise, "304 Not Modified" will be returned.

Parameters:

ifModifiedSince - Time condition set for downloading the object

getIfUnmodifiedSince

public Date getIfUnmodifiedSince()

Obtain the time condition for downloading the object. Only when the object remains unchanged after the point in time specified by this parameter, it will be downloaded; otherwise, "412 Precondition Failed" will be returned.

Returns:

Time condition set for downloading the object

setIfUnmodifiedSince

public void setIfUnmodifiedSince(Date ifUnmodifiedSince)

Set the time condition for downloading the object. Only when the object remains unchanged after the point in time specified by this parameter, it will be downloaded; otherwise, "412 Precondition Failed" will be returned.

Parameters:

ifUnmodifiedSince - Time condition set for downloading the object

getIfMatchTag

public String getIfMatchTag()

Obtain the ETag verification condition for downloading the object. Only when the ETag of the object is the same as that specified by this parameter, the object will be downloaded. Otherwise, "412 Precondition Failed" will be returned.

Returns:

ETag verification condition set for downloading the object

setIfMatchTag

public void setIfMatchTag(String ifMatchTag)

Set the ETag verification condition for downloading the object. Only when the ETag of the object is the same as that specified by this parameter, the object will be downloaded. Otherwise, "412 Precondition Failed" will be returned.

Parameters:

ifMatchTag - ETag verification condition set for downloading the object

getIfNoneMatchTag

public String getIfNoneMatchTag()

Obtain the ETag verification condition for downloading the object. Only when the ETag of the object is different from that specified by this parameter, the object will be downloaded. Otherwise, "304 Not Modified" will be returned.

Returns:

ETag verification condition set for downloading the object

setIfNoneMatchTag

public void setIfNoneMatchTag(String ifNoneMatchTag)

Set the ETag verification condition for downloading the object. Only when the ETag of the object is different from that specified by this parameter, the object will be downloaded. Otherwise, "304 Not Modified" will be returned.

Parameters:

ifNoneMatchTag - ETag verification condition set for downloading the object

getImageProcess

public String getImageProcess()

Obtain image processing parameters.

Returns:

Image processing parameters

setImageProcess

public void setImageProcess(String imageProcess)

Set image processing parameters.

Parameters:

imageProcess - Image processing parameters

getProgressListener

public ProgressListener getProgressListener()

Obtain the data transfer listener.

Returns:

Data transfer listener

setProgressListener

public void setProgressListener(ProgressListener progressListener)

Set the data transfer listener.

Parameters:

progressListener - Data transfer listener

getProgressInterval

public long getProgressInterval()

Obtain the callback threshold of the data transfer listener. The default value is 100 KB.

Returns:

Callback threshold of the data transfer listener

setProgressInterval

public void setProgressInterval(long progressInterval)

Set the callback threshold of the data transfer listener. The default value is 100 KB.

Parameters:

progressInterval - Callback threshold of the data transfer listener

getRequestParameters

public Map<String,String> getRequestParameters()

getCacheOption

public CacheOptionEnum getCacheOption()

Obtain the control option of the read-ahead cache.

Returns:

Control option of the read-ahead cache

setCacheOption

public void setCacheOption(CacheOptionEnum cacheOption)

Set the control option of the read-ahead cache.

Parameters:

cacheOption - Control option of the read-ahead cache

getTtl

public long getTtl()

Obtain the cache data expiration time.

Returns:

Cache data expiration time

setTtl

public void setTtl(long ttl)

Set the cache data expiration time.

Parameters:

ttl - Cache data expiration time

setRequestParameters

public void setRequestParameters(Map<String,String> requestParameters)

isAutoUnzipResponse

public boolean isAutoUnzipResponse()

Obtain the response to whether to automatically decompress the object compressed using gzip. The default response is false, indicating that the object is not automatically decompressed.
Description: OBS SDK uses okhttp. If Accept-Encoding is not set in a request, okhttp automatically adds the Accept-Encoding:gzip header and decompresses the object after receiving the request.
If the Accept-Encoding header is manually set in a request, the object will not be automatically decompressed.

Returns:

Since:

3.20.5

See Also:

okhttp3.internal.http.BridgeInterceptor

setAutoUnzipResponse

public void setAutoUnzipResponse(boolean autoUnzipResponse)

Set the response to whether to automatically decompress the object compressed using gzip. The default response is false, indicating that the object is not automatically decompressed.
Description: OBS SDK uses okhttp. If Accept-Encoding is not set in a request, okhttp automatically adds the Accept-Encoding:gzip header and decompresses the object after receiving the request.
If the Accept-Encoding header is manually set in a request, the object will not be automatically decompressed.

Parameters:

autoUnzipResponse -

Since:

3.20.5

See Also:

okhttp3.internal.http.BridgeInterceptor

setIsEncodeHeaders

public void setIsEncodeHeaders(boolean encodeHeaders)

Specifies whether to encode and decode the returned header fields.

Overrides:

setIsEncodeHeaders in class BaseObjectRequest

Parameters:

encodeHeaders - Specifies whether to encode and decode header fields.

isEncodeHeaders

public boolean isEncodeHeaders()

Specifies whether to encode and decode the returned header fields.

Overrides:

isEncodeHeaders in class BaseObjectRequest

Returns:

Specifies whether to encode and decode header fields.

toString

public String toString()

Overrides:

toString in class GetObjectMetadataRequest