Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • 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
      • Enum
      • Resource
    • ObjectStore
      • Constants
      • Exception
      • Resource
      • Upload
    • Orchestration
    • Queues
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

  • AbstractTransfer
  • ConcurrentTransfer
  • ConsecutiveTransfer
  • ContainerMigration
  • DirectorySync
  • TransferBuilder
  • TransferPart
  • TransferState
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

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
type
$options Available configuration options: * `concurrency' <bool> The number of concurrent workers. * `partSize' <int> The size, in bytes, for the chunk * `doPartChecksum' <bool> 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 mixed
# setOption( mixed $key, mixed $value )

Parameters

$key
mixed
$key The option name
$value
mixed
$value The option value

Returns

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

Parameters

$container
OpenCloud\ObjectStore\Resource\Container
$container

Returns

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

Parameters

$entityBody
Guzzle\Http\EntityBody
$entityBody

Returns

mixed
$this
public mixed
# build( )

Build the transfer.

Build the transfer.

Returns

mixed

Throws

OpenCloud\Common\Exceptions\InvalidArgumentError
Properties summary
protected OpenCloud\ObjectStore\Resource\Container $container
#

The container being uploaded to

The container being uploaded to

protected Guzzle\Http\EntityBody $entityBody
#

The data payload.

The data payload.

protected array $options array()
#

A key/value pair of options.

A key/value pair of options.

PHP OpenCloud API API documentation generated by ApiGen 2.8.0