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 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
public
# setClient( OpenCloud\Common\Http\Client $client )

Parameters

$client

Returns


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

Parameters

$entityBody

Returns


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

Parameters

$transferState

Returns


$this
public array
# getOptions( )

Returns

array
public
# setOptions( $options )

Parameters

$options

Returns


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

Parameters

$option
key being updated
$value
option's value

Returns


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

Returns


$this
public Guzzle\Http\Message\Response
# upload( )

Initiates the upload procedure.

Initiates the upload procedure.

Returns

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
float 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
API documentation generated by ApiGen