TransferBuilder
in package
Factory which creates Transfer objects, either ConcurrentTransfer or ConsecutiveTransfer.
Table of Contents
- $container : Container
- $entityBody : EntityBody
- $options : array<string|int, mixed>
- build() : mixed
- Build the transfer.
- newInstance() : TransferBuilder
- setContainer() : $this
- setEntityBody() : $this
- setOption() : $this
- setOptions() : UploadBuilder
Properties
$container
protected
Container
$container
The container being uploaded to
$entityBody
protected
EntityBody
$entityBody
The data payload.
$options
protected
array<string|int, mixed>
$options
= array()
A key/value pair of options.
Methods
build()
Build the transfer.
public
build() : mixed
Tags
Return values
mixed —newInstance()
public
static newInstance() : TransferBuilder
Return values
TransferBuilder —setContainer()
public
setContainer(Container $container) : $this
Parameters
- $container : Container
Return values
$this —setEntityBody()
public
setEntityBody(EntityBody $entityBody) : $this
Parameters
- $entityBody : EntityBody
Return values
$this —setOption()
public
setOption( $key, $value) : $this
Parameters
Return values
$this —setOptions()
public
setOptions(type $options) : UploadBuilder
Parameters
- $options : type
-
Available configuration options:
- `concurrency'
The number of concurrent workers. - `partSize'
The size, in bytes, for the chunk - `doPartChecksum'
Enable or disable MD5 checksum in request (ETag)
If you are uploading FooBar, its chunks will have the following naming structure:
FooBar/1 FooBar/2 FooBar/3
- `concurrency'