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

# Interface TransferStateInterface

State of a multipart upload

  Aws\Common\Model\MultipartUpload\TransferStateInterface implements Countable, IteratorAggregate, Serializable

### Direct known implementers

`Aws\Common\Model\MultipartUpload\AbstractTransferState`

### Indirect known implementers

`Aws\Glacier\Model\MultipartUpload\TransferState`, `Aws\S3\Model\MultipartUpload\TransferState`

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

## Methods summary

- `public static` `fromUploadId ( Aws\Common\Client\AwsClientInterface $client, Aws\Common\Model\MultipartUpload\UploadIdInterface $uploadId )`

  Create the transfer state from the results of list parts request

- `public` `getUploadId ( )`

  Get the params used to identify an upload part

- `public` `getPart ( int $partNumber )`

  Get the part information of a specific part

- `public` `addPart ( Aws\Common\Model\MultipartUpload\UploadPartInterface $part )`

  Add a part to the transfer state

- `public` `hasPart ( int $partNumber )`

  Check if a specific part has been uploaded

- `public` `getPartNumbers ( )`

  Get a list of all of the uploaded part numbers

- `public` `setAborted ( bool $aborted )`

  Set whether or not the transfer has been aborted

- `public` `isAborted ( )`

  Check if the transfer has been marked as aborted

## Methods detail

# `public static `Aws\Common\Model\MultipartUpload\TransferStateInterface``
`fromUploadId( `Aws\Common\Client\AwsClientInterface` $client, `Aws\Common\Model\MultipartUpload\UploadIdInterface` $uploadId )`

Create the transfer state from the results of list parts request

#### Parameters

$client
  ``Aws\Common\Client\AwsClientInterface``
  $client Client used to send the request
$uploadId
  ``Aws\Common\Model\MultipartUpload\UploadIdInterface``
  $uploadId Params needed to identify the upload and form the request

#### Returns

``Aws\Common\Model\MultipartUpload\TransferStateInterface``
# `public `Aws\Common\Model\MultipartUpload\UploadIdInterface``
`getUploadId( )`

Get the params used to identify an upload part

#### Returns

``Aws\Common\Model\MultipartUpload\UploadIdInterface``
# `public `Aws\Common\Model\MultipartUpload\UploadPartInterface``
`getPart( integer $partNumber )`

Get the part information of a specific part

#### Parameters

$partNumber
  `integer`
  $partNumber Part to retrieve

#### Returns

``Aws\Common\Model\MultipartUpload\UploadPartInterface``
# `public `Aws\Common\Model\MultipartUpload\TransferStateInterface``
`addPart( `Aws\Common\Model\MultipartUpload\UploadPartInterface` $part )`

Add a part to the transfer state

#### Parameters

$part
  ``Aws\Common\Model\MultipartUpload\UploadPartInterface``
  $part The part to add

#### Returns

``Aws\Common\Model\MultipartUpload\TransferStateInterface``
# `public boolean`
`hasPart( integer $partNumber )`

Check if a specific part has been uploaded

#### Parameters

$partNumber
  `integer`
  $partNumber Part to check

#### Returns

`boolean`
# `public array`
`getPartNumbers( )`

Get a list of all of the uploaded part numbers

#### Returns

`array`
# `public `Aws\Common\Model\MultipartUpload\TransferStateInterface``
`setAborted( boolean $aborted )`

Set whether or not the transfer has been aborted

#### Parameters

$aborted
  `boolean`
  $aborted Set to true to mark the transfer as aborted

#### Returns

``Aws\Common\Model\MultipartUpload\TransferStateInterface``
# `public boolean`
`isAborted( )`

Check if the transfer has been marked as aborted

#### Returns

`boolean`

### Methods inherited from Countable

`count()`

### Methods inherited from IteratorAggregate

`getIterator()`

### Methods inherited from Serializable

`serialize()`, `unserialize()`

### Magic methods summary