Updated on 2024-05-11 GMT+08:00

Overview (SDK for Java)

If you have any questions during development, post them on the Issues page of GitHub.

OBS Java SDK provides abundant APIs for object download in the following methods:

Request Parameters

Parameter

Type

Mandatory (Yes/No)

Description

isEncodeHeaders

boolean

No

Whether to automatically encode the request header. The default value is true.

userHeaders

HashMap<String, String>

No

User's header field.

ifMatchTag

String

No

Returns the object content if the object's ETag is the same as this parameter value. Otherwise, an error is reported.

ifNoneMatchTag

String

No

Returns the object content if the object's ETag is different from this parameter value. Otherwise, an error is reported.

ifModifiedSince

Date

No

Returns the object if it has been modified since the specified time; otherwise, an error is returned.

ifUnmodifiedSince

Date

No

Returns the object if it has not been modified since the specified time; otherwise, an error is returned.

rangeStart

Long

No

Start byte for a partial download.

rangeEnd

Long

No

End byte for a partial download.

replaceMetadata

ObjectRepleaceMetadata

No

Rewrites response headers when objects are downloaded.

sseCHeader

SseCHeader

No

Information about the server-side encryption header.

versionId

String

No

Version number.