com.ibm.cloud.objectstorage.services.s3.model

Class PresignedUrlDownloadRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

com.ibm.cloud.objectstorage.services.s3.model.PresignedUrlDownloadRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class PresignedUrlDownloadRequest
extends AmazonWebServiceRequest
implements Serializable

Request class to download objects using presigned urls. The class has options to set the presigned url to download the request from, range headers to download partial objects. If custom headers are used in generating the url, you can set them through AmazonWebServiceRequest.putCustomRequestHeader(String, String) method. If any signed headers or parameters are missing from the request, a Signature mismatch error will be thrown from S3. Ensure you set all the custom headers/parameters that are used for creating the presigned url.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PresignedUrlDownloadRequest(URL presignedUrl)

Method Summary

Modifier and Type	Method and Description
PresignedUrlDownloadRequest	clone() Creates and returns a new copy of the request.
URL	getPresignedUrl()
long[]	getRange() Gets the optional inclusive byte range within the desired object that will be downloaded by this request.
void	setPresignedUrl(URL presignedUrl)
void	setRange(long start, long end) Sets the optional inclusive byte range within the desired object that will be downloaded by this request.
PresignedUrlDownloadRequest	withPresignedUrl(URL presignedUrl)
PresignedUrlDownloadRequest	withRange(long start, long end) Sets the optional inclusive byte range within the desired object that will be downloaded by this request.

Methods inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

PresignedUrlDownloadRequest

public PresignedUrlDownloadRequest(URL presignedUrl)

Method Detail

getPresignedUrl

public URL getPresignedUrl()

Returns:

The presigned url to which the request will be sent

setPresignedUrl

public void setPresignedUrl(URL presignedUrl)

Parameters:

presignedUrl - sets the presigned url to send the request to

withPresignedUrl

public PresignedUrlDownloadRequest withPresignedUrl(URL presignedUrl)

Parameters:

presignedUrl - sets the presigned url to send the request to

Returns:

This object for method chaining

getRange

public long[] getRange()

Gets the optional inclusive byte range within the desired object that will be downloaded by this request.

The range is returned as a two element array, containing the start and end index of the byte range. If no byte range has been specified, the entire object is downloaded and this method returns null.

Returns:

A two element array indicating the inclusive start index and end index within the object being downloaded by this request. Returns null if no range has been specified, and the whole object is to be downloaded.

See Also:

PresignedUrlDownloadRequest.setRange(long, long)

setRange

public void setRange(long start,
                     long end)

Sets the optional inclusive byte range within the desired object that will be downloaded by this request.

The first byte in an object has position 0; as an example, the first ten bytes of an object can be downloaded by specifying a range of 0 to 9.

If no byte range is specified, this request downloads the entire object from Amazon S3.

Parameters:

start - The start of the inclusive byte range to download.

end - The end of the inclusive byte range to download.

See Also:

PresignedUrlDownloadRequest.getRange()

withRange

public PresignedUrlDownloadRequest withRange(long start,
                                             long end)

Sets the optional inclusive byte range within the desired object that will be downloaded by this request. Returns this GetObjectRequest, enabling additional method calls to be chained together.

The first byte in an object has position 0; as an example, the first ten bytes of an object can be downloaded by specifying a range of 0 to 9.

If no byte range is specified, this request downloads the entire object from Amazon S3.

Parameters:

start - The start of the inclusive byte range to download.

end - The end of the inclusive byte range to download.

Returns:

This GetObjectRequest, enabling additional method calls to be chained together.

See Also:

PresignedUrlDownloadRequest.getRange(), PresignedUrlDownloadRequest.setRange(long, long)

clone

public PresignedUrlDownloadRequest clone()

Creates and returns a new copy of the request. This method also copies the internal state of the base AmazonWebServiceRequest class.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()