$autoFlush
$autoFlush : boolean
Builder used to create custom batch objects
$transferStrategy : \Guzzle\Batch\BatchTransferInterface
$divisorStrategy : \Guzzle\Batch\BatchDivisorInterface
factory() : \Guzzle\Batch\BatchBuilder
Create a new instance of the BatchBuilder
autoFlushAt( $threshold) : \Guzzle\Batch\BatchBuilder
Automatically flush the batch when the size of the queue reaches a certain threshold. Adds {@see FlushingBatch}.
| $threshold | Number of items to allow in the queue before a flush |
keepHistory() : \Guzzle\Batch\BatchBuilder
Maintain a history of all items that have been transferred using the batch. Adds {@see HistoryBatch}.
bufferExceptions() : \Guzzle\Batch\BatchBuilder
Buffer exceptions thrown during transfer so that you can transfer as much as possible, and after a transfer completes, inspect each exception that was thrown. Enables the {@see ExceptionBufferingBatch} decorator.
notify(mixed $callable) : \Guzzle\Batch\BatchBuilder
Notify a callable each time a batch flush completes. Enables the {@see NotifyingBatch} decorator.
| mixed | $callable | Callable function to notify |
if the argument is not callable
transferRequests(integer $batchSize = 50) : \Guzzle\Batch\BatchBuilder
Configures the batch to transfer batches of requests. Associates a {@see \Guzzle\Http\BatchRequestTransfer} object as both the transfer and divisor strategy.
| integer | $batchSize | Batch size for each batch of requests |
transferCommands(integer $batchSize = 50) : \Guzzle\Batch\BatchBuilder
Configures the batch to transfer batches commands. Associates as {@see \Guzzle\Service\Command\BatchCommandTransfer} as both the transfer and divisor strategy.
| integer | $batchSize | Batch size for each batch of commands |
createBatchesWith(\Guzzle\Batch\BatchDivisorInterface $divisorStrategy) : \Guzzle\Batch\BatchBuilder
Specify the strategy used to divide the queue into an array of batches
| \Guzzle\Batch\BatchDivisorInterface | $divisorStrategy | Strategy used to divide a batch queue into batches |
transferWith(\Guzzle\Batch\BatchTransferInterface $transferStrategy) : \Guzzle\Batch\BatchBuilder
Specify the strategy used to transport the items when flush is called
| \Guzzle\Batch\BatchTransferInterface | $transferStrategy | How items are transferred |
build() : \Guzzle\Batch\BatchInterface
Create and return the instantiated batch
if no transfer strategy has been specified