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

# Interface TransferInterface

Interface for transferring the contents of a data source to an AWS service via a multipart upload interface

  Aws\Common\Model\MultipartUpload\TransferInterface implements Guzzle\Common\HasDispatcherInterface

### Direct known implementers

`Aws\Common\Model\MultipartUpload\AbstractTransfer`

### Indirect known implementers

`Aws\Glacier\Model\MultipartUpload\AbstractTransfer`, `Aws\Glacier\Model\MultipartUpload\ParallelTransfer`, `Aws\Glacier\Model\MultipartUpload\SerialTransfer`, `Aws\S3\Model\MultipartUpload\AbstractTransfer`, `Aws\S3\Model\MultipartUpload\ParallelTransfer`, `Aws\S3\Model\MultipartUpload\SerialTransfer`

Namespace: Aws\Common\Model\MultipartUpload
Located at Aws/Common/Model/MultipartUpload/TransferInterface.php

## Methods summary

- `public` `upload ( )`

  Upload the source to using a multipart upload

- `public` `abort ( )`

  Abort the upload

- `public` `getState ( )`

  Get the current state of the upload

- `public` `stop ( )`

  Stop the transfer and retrieve the current state.

- `public` `setOption ( string $option, mixed $value )`

  Set an option on the transfer object

## Methods detail

# `public `Guzzle\Service\Resource\Model`|null`
`upload( )`

Upload the source to using a multipart upload

#### Returns

``Guzzle\Service\Resource\Model`|null`
Result of the complete multipart upload command or null if uploading was stopped
# `public `Guzzle\Service\Resource\Model``
`abort( )`

Abort the upload

#### Returns

``Guzzle\Service\Resource\Model``
Returns the result of the abort multipart upload command
# `public `Aws\Common\Model\MultipartUpload\TransferStateInterface``
`getState( )`

Get the current state of the upload

#### Returns

``Aws\Common\Model\MultipartUpload\TransferStateInterface``
# `public `Aws\Common\Model\MultipartUpload\TransferStateInterface``
`stop( )`

Stop the transfer and retrieve the current state.

This allows you to stop and later resume a long running transfer if needed.

#### Returns

``Aws\Common\Model\MultipartUpload\TransferStateInterface``
# `public `Aws\Common\Model\MultipartUpload\TransferInterface``
`setOption( string $option, mixed $value )`

Set an option on the transfer object

#### Parameters

$option
  `string`
  $option Option to set
$value
  `mixed`
  $value The value to set

#### Returns

``Aws\Common\Model\MultipartUpload\TransferInterface``

### Methods inherited from Guzzle\Common\HasDispatcherInterface

`addSubscriber()`, `dispatch()`, `getAllEvents()`, `getEventDispatcher()`, `setEventDispatcher()`

### Magic methods summary