Class DownloadSyncBuilder
- Aws\S3\Sync\AbstractSyncBuilder
-
Aws\S3\Sync\DownloadSyncBuilder
Methods summary
-
publicsetDirectory ( string $directory )Set the directory where the objects from be downloaded to
-
publicallowResumableDownloads ( )Call this function to allow partial downloads to be resumed if the download was previously interrupted
-
protectedspecificBuild ( )Hook to implement in subclasses
-
protectedgetTargetIterator ( ) -
protectedgetDefaultSourceConverter ( ) -
protectedgetDefaultTargetConverter ( ) -
protectedassertFileIteratorSet ( )Ensure that the base file iterator has been provided
-
protectedaddDebugListener ( Aws\S3\Sync\AbstractSync $sync, resource $resource )Add a listener to the sync object to output debug information while transferring
Methods detail
Set the directory where the objects from be downloaded to
Parameters
- $directory
string
$directory Directory
Returns
mixed$this
Call this function to allow partial downloads to be resumed if the download was previously interrupted
Returns
Ensure that the base file iterator has been provided
Throws
Overrides
Add a listener to the sync object to output debug information while transferring
Parameters
- $sync
Aws\S3\Sync\AbstractSync
$sync Sync object to listen to- $resource
resource
$resource Where to write debug messages
Methods inherited from Aws\S3\Sync\AbstractSyncBuilder
addCustomParamListener(),
addRegexFilter(),
build(),
createS3Iterator(),
enableDebugOutput(),
filterIterator(),
force(),
getInstance(),
setBaseDir(),
setBucket(),
setClient(),
setConcurrency(),
setDelimiter(),
setKeyPrefix(),
setOperationParams(),
setSourceFilenameConverter(),
setSourceIterator(),
setTargetFilenameConverter(),
validateRequirements()
Magic methods summary
Properties summary
protected
boolean
|
$resumable | |
protected
string
|
$directory | |
protected
integer
|
$concurrency |
#
Number of files that can be transferred concurrently |
Properties inherited from Aws\S3\Sync\AbstractSyncBuilder
$baseDir,
$bucket,
$client,
$debug,
$delimiter,
$forcing,
$keyPrefix,
$params,
$sourceConverter,
$sourceIterator,
$targetConverter