Class AbstractTransferState
State of a multipart upload
- Aws\Common\Model\MultipartUpload\AbstractTransferState implements Aws\Common\Model\MultipartUpload\TransferStateInterface
Direct known subclasses
Aws\Glacier\Model\MultipartUpload\TransferState,
Aws\S3\Model\MultipartUpload\TransferState
Namespace: Aws\Common\Model\MultipartUpload
Located at Aws/Common/Model/MultipartUpload/AbstractTransferState.php
Methods summary
-
public__construct ( Aws\Common\Model\MultipartUpload\UploadIdInterface $uploadId )Construct a new transfer state object
-
publicgetUploadId ( )Get the params used to identify an upload part
-
publicgetFromId ( string $key )Get a data value from the transfer state's uploadId
-
publicgetPart ( int $partNumber )Get the part information of a specific part
-
publicaddPart ( Aws\Common\Model\MultipartUpload\UploadPartInterface $part )Add a part to the transfer state
-
publichasPart ( int $partNumber )Check if a specific part has been uploaded
-
publicgetPartNumbers ( )Get a list of all of the uploaded part numbers
-
publicsetAborted ( bool $aborted )Set whether or not the transfer has been aborted
-
publicisAborted ( )Check if the transfer has been marked as aborted
-
publiccount ( ) -
publicgetIterator ( ) -
publicserialize ( ) -
publicunserialize ( mixed $serialized )
Methods detail
Construct a new transfer state object
Parameters
- $uploadId
Aws\Common\Model\MultipartUpload\UploadIdInterface
$uploadId Upload identifier object
Get the params used to identify an upload part
Returns
Implementation of
Get a data value from the transfer state's uploadId
Parameters
- $key
string
$key Key to retrieve (e.g. Bucket, Key, UploadId, etc)
Returns
string|nullGet the part information of a specific part
Parameters
- $partNumber
integer
$partNumber Part to retrieve
Returns
Implementation of
public
Aws\Common\Model\MultipartUpload\AbstractTransferState
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
Implementation of
Check if a specific part has been uploaded
Parameters
- $partNumber
integer
$partNumber Part to check
Returns
booleanImplementation of
Get a list of all of the uploaded part numbers
Returns
arrayImplementation of
Set whether or not the transfer has been aborted
Parameters
- $aborted
boolean
$aborted Set to true to mark the transfer as aborted
Returns
Implementation of
Check if the transfer has been marked as aborted
Returns
booleanImplementation of
Implementation of
Implementation of
Implementation of
Implementation of
Methods inherited from Aws\Common\Model\MultipartUpload\TransferStateInterface
Magic methods summary
Properties summary
protected
|
$uploadId |
#
Object holding params used to identity the upload part |
protected
array
|
$parts |
#
Array of parts where the part number is the index |
protected
boolean
|
$aborted |
#
Whether or not the transfer was aborted |