Overview

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
  • PHP

Classes

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

Class AbstractTransfer

Contains abstract functionality for transfer objects.

Direct known subclasses

OpenCloud\ObjectStore\Upload\ConcurrentTransfer, OpenCloud\ObjectStore\Upload\ConsecutiveTransfer
Namespace: OpenCloud\ObjectStore\Upload
Located at OpenCloud/ObjectStore/Upload/AbstractTransfer.php
Methods summary
public static static
# newInstance( )

Returns

static
static
public mixed
# setClient( OpenCloud\Common\Http\Client $client )

Parameters

$client

Returns

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

Parameters

$entityBody

Returns

mixed
$this
public mixed
# setTransferState( OpenCloud\ObjectStore\Upload\TransferState $transferState )

Parameters

$transferState

Returns

mixed
$this
public array
# getOptions( )

Returns

array
array
public mixed
# setOptions( mixed $options )

Parameters

$options

Returns

mixed
$this
public mixed
# setOption( mixed $option, mixed $value )

Parameters

$option
key being updated
$value
option's value

Returns

mixed
$this
public
# getPartSize( )
public mixed
# setup( )

Returns

mixed
$this
protected mixed
# validatePartSize( )

Make sure the part size falls within a valid range

Make sure the part size falls within a valid range

Returns

mixed
mixed
public Guzzle\Http\Message\Response
# upload( )

Initiates the upload procedure.

Initiates the upload procedure.

Returns

Guzzle\Http\Message\Response
\Guzzle\Http\Message\Response

Throws

OpenCloud\Common\Exceptions\RuntimeException
If the transfer is not in a "running" state
OpenCloud\ObjectStore\Exception\UploadException
If any errors occur during the upload

CodeCoverageIgnore

Constants summary
integer MIN_PART_SIZE

Minimum chunk size is 1MB.

Minimum chunk size is 1MB.

#1048576
integer MAX_PART_SIZE

Maximum chunk size is 5GB.

Maximum chunk size is 5GB.

#5368709120
integer DEFAULT_PART_SIZE

Default chunk size is 1GB.

Default chunk size is 1GB.

#1073741824
Properties summary
protected OpenCloud\Common\Http\Client $client

The client object which handles all HTTP interactions

The client object which handles all HTTP interactions

#
protected Guzzle\Http\EntityBody $entityBody

The payload being transferred

The payload being transferred

#
protected OpenCloud\ObjectStore\Upload\TransferState $transferState

The current state of the transfer responsible for, among other things, holding an itinerary of uploaded parts

The current state of the transfer responsible for, among other things, holding an itinerary of uploaded parts

#
protected array $options

User-defined key/pair options

User-defined key/pair options

#
protected integer $partSize
#
protected array $defaultOptions

Defaults that will always override user-defined options

Defaults that will always override user-defined options

#array( 'concurrency' => true, 'partSize' => self::DEFAULT_PART_SIZE, 'prefix' => 'segment', 'doPartChecksum' => true )
API documentation generated by ApiGen 2.8.0