NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# Class ResumableDownload

Allows you to resume the download of a partially downloaded object.

Downloads objects from Amazon S3 in using "Range" downloads. This allows a partially downloaded object to be resumed so that only the remaining portion of the object is downloaded.

Namespace: Aws\S3
Located at Aws/S3/ResumableDownload.php

## Methods summary

- `public` `__construct ( Aws\S3\S3Client $client, string $bucket, string $key, string|resource|EntityBodyInterface $target, array $params = array() )`
- `public` `getBucket ( )`

  Get the bucket of the download

- `public` `getKey ( )`

  Get the key of the download

- `public` `getFilename ( )`

  Get the file to which the contents are downloaded

- `public` `__invoke ( )`

  Download the remainder of the object from Amazon S3

- `protected` `getRemaining ( )`

  Send the command to get the remainder of the object

- `protected` `checkIntegrity ( )`

  Performs an MD5 message integrity check if possible

## Methods detail

# `public`
`__construct( `Aws\S3\S3Client` $client, string $bucket, string $key, string|resource|`Guzzle\Http\EntityBodyInterface` $target, array $params = array() )`

#### Parameters

$client
  ``Aws\S3\S3Client``
  $client Client to use when executing requests
$bucket
  `string`
  $bucket Bucket that holds the object
$key
  `string`
  $key Key of the object
$target
  `string|resource|`Guzzle\Http\EntityBodyInterface``
  $target Where the object should be downloaded to. Pass a string to save the object to a file, pass a resource returned by fopen() to save the object to a stream resource, or pass a Guzzle EntityBody object to save the contents to an EntityBody.
$params
  `array`
  $params Any additional GetObject or HeadObject parameters to use with each command issued by the client. (e.g. pass "Version" to download a specific version of an object)

#### Throws

``Aws\Common\Exception\RuntimeException``
if the target variable points to a file that cannot be opened
# `public string`
`getBucket( )`

Get the bucket of the download

#### Returns

`string`
# `public string`
`getKey( )`

Get the key of the download

#### Returns

`string`
# `public string`
`getFilename( )`

Get the file to which the contents are downloaded

#### Returns

`string`
# `public `Guzzle\Service\Resource\Model``
`__invoke( )`

Download the remainder of the object from Amazon S3

Performs a message integrity check if possible

#### Returns

``Guzzle\Service\Resource\Model``
# `protected `Guzzle\Service\Resource\Model``
`getRemaining( )`

Send the command to get the remainder of the object

#### Returns

``Guzzle\Service\Resource\Model``
# `protected`
`checkIntegrity( )`

Performs an MD5 message integrity check if possible

#### Throws

``Aws\Common\Exception\UnexpectedValueException``
if the message does not validate

### Magic methods summary

## Properties summary

`protected `Aws\S3\S3Client`` | $client | # The S3 client to use to download objects and issue HEAD requests
`protected `Guzzle\Service\Resource\Model`` | $meta | # Model object returned when the initial HeadObject operation was called
`protected array` | $params | # Array of parameters to pass to a GetObject operation
`protected `Guzzle\Http\EntityBody`` | $target | # Where the object will be downloaded