Interface TransferStateInterface
State of a multipart upload
- Aws\Common\Model\MultipartUpload\TransferStateInterface implements Countable, IteratorAggregate, Serializable
Direct known implementers
Indirect known implementers
Aws\Glacier\Model\MultipartUpload\TransferState
,
Aws\S3\Model\MultipartUpload\TransferState
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
Get the params used to identify an upload part
Returns
Get the part information of a specific part
Parameters
- $partNumber
integer
$partNumber Part to retrieve
Returns
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
Check if a specific part has been uploaded
Parameters
- $partNumber
integer
$partNumber Part to check
Returns
boolean
Get a list of all of the uploaded part numbers
Returns
array
Set whether or not the transfer has been aborted
Parameters
- $aborted
boolean
$aborted Set to true to mark the transfer as aborted
Returns
Check if the transfer has been marked as aborted
Returns
boolean