Overview
  • Namespace
  • Class

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CDN
      • Resource
    • CloudMonitoring
      • Collection
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Log
      • Resource
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Collection
      • Resource
    • Identity
      • Constants
      • Resource
    • Image
      • Enum
      • Resource
        • JsonPatch
        • Schema
    • LoadBalancer
      • Collection
      • Enum
      • Resource
    • Networking
      • Resource
    • ObjectStore
      • Constants
      • Enum
      • Exception
      • Resource
      • Upload
    • Orchestration
      • Resource
    • Queues
      • Collection
      • Exception
      • Resource
    • Volume
      • Resource

Classes

  • AbstractTransfer
  • ConcurrentTransfer
  • ConsecutiveTransfer
  • ContainerMigration
  • DirectorySync
  • TransferBuilder
  • TransferPart
  • TransferState

Class TransferBuilder

Factory which creates Transfer objects, either ConcurrentTransfer or ConsecutiveTransfer.

Namespace: OpenCloud\ObjectStore\Upload
Located at OpenCloud/ObjectStore/Upload/TransferBuilder.php

Methods summary

public static OpenCloud\ObjectStore\Upload\TransferBuilder
# newInstance( )

Returns

OpenCloud\ObjectStore\Upload\TransferBuilder
public OpenCloud\ObjectStore\Upload\UploadBuilder
# setOptions( type $options )

Parameters

$options

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

Returns

OpenCloud\ObjectStore\Upload\UploadBuilder
public
# setOption( $key, $value )

Parameters

$key
option name
$value
option value

Returns


$this
public
# setContainer( OpenCloud\ObjectStore\Resource\Container $container )

Parameters

$container

Returns


$this
public
# setEntityBody( Guzzle\Http\EntityBody $entityBody )

Parameters

$entityBody

Returns


$this
public mixed
# build( )

Build the transfer.

Build the transfer.

Returns

mixed

Throws

OpenCloud\Common\Exceptions\InvalidArgumentError
API documentation generated by ApiGen