Class UploadBuilder
Easily create a multipart uploader used to quickly and reliably upload a large file or data stream to Amazon Glacier using multipart uploads
- Aws\Common\Model\MultipartUpload\AbstractUploadBuilder
-
Aws\Glacier\Model\MultipartUpload\UploadBuilder
Located at Aws/Glacier/Model/MultipartUpload/UploadBuilder.php
Methods summary
-
publicsetAccountId ( string $accountId )Set the account ID to upload the part to
-
publicsetVaultName ( string $vaultName )Set the vault name to upload the part to
-
publicsetPartSize ( int $partSize )Set the upload part size
-
publicsetArchiveDescription ( string $archiveDescription )Set the archive description
-
publicsetConcurrency ( int $concurrency )Set the concurrency level to use when uploading parts. This affects how many parts are uploaded in parallel. You must use a local file as your data source when using a concurrency greater than 1
-
publicsetPartGenerator ( Aws\Glacier\Model\MultipartUpload\UploadPartGenerator $partGenerator )Sets the Glacier upload helper object that pre-calculates hashes and sizes for all upload parts
-
publicbuild ( )Build the appropriate uploader based on the builder options
-
protectedinitiateMultipartUpload ( )Initiate the multipart upload
Methods detail
Set the account ID to upload the part to
Parameters
- $accountId
string
$accountId ID of the account
Returns
mixed$this
Set the vault name to upload the part to
Parameters
- $vaultName
string
$vaultName Name of the vault
Returns
mixed$this
Set the upload part size
Parameters
- $partSize
integer
$partSize Upload part size
Returns
mixed$this
Set the archive description
Parameters
- $archiveDescription
string
$archiveDescription Archive description
Returns
mixed$this
Set the concurrency level to use when uploading parts. This affects how many parts are uploaded in parallel. You must use a local file as your data source when using a concurrency greater than 1
Parameters
- $concurrency
integer
$concurrency Concurrency level
Returns
mixed$this
public
mixed
setPartGenerator( Aws\Glacier\Model\MultipartUpload\UploadPartGenerator $partGenerator )
Sets the Glacier upload helper object that pre-calculates hashes and sizes for all upload parts
Parameters
- $partGenerator
Aws\Glacier\Model\MultipartUpload\UploadPartGenerator
$partGenerator Glacier upload helper object
Returns
mixed$this
Build the appropriate uploader based on the builder options
Returns
TransferInterfaceThrows
Aws\Common\Exception\InvalidArgumentExceptionwhen attempting to resume a transfer using a non-seekable stream
Aws\Common\Exception\InvalidArgumentExceptionwhen missing required properties (bucket, key, client, source)
Initiate the multipart upload
Returns
TransferStateInterfaceMethods inherited from Aws\Common\Model\MultipartUpload\AbstractUploadBuilder
newInstance(),
resumeFrom(),
setClient(),
setHeaders(),
setSource()
Magic methods summary
Properties summary
protected
string
|
$accountId |
#
Account ID to upload to |
protected
string
|
$vaultName |
#
Name of the vault to upload to |
protected
integer
|
$concurrency |
#
Concurrency level to transfer the parts |
protected
integer
|
$partSize |
#
Size of upload parts |
protected
string
|
$archiveDescription |
#
Archive description |
protected
|
$partGenerator |
#
Glacier upload helper object |