Documentation

TransferPart
in package

Represents an individual part of the EntityBody being uploaded.

Tags
codeCoverageIgnore

Table of Contents

$contentLength  : int
$eTag  : string
$partNumber  : int
$path  : string
createRequest()  : Request
Create the request needed for this upload to the API.
fromResponse()  : TransferPart
Construct a TransferPart from a HTTP response delivered by the API.
getContentLength()  : int
getETag()  : string
getPartNumber()  : int
getPath()  : string
setContentLength()  : $this
setETag()  : $this
setPartNumber()  : $this
setPath()  : $this

Properties

$contentLength

protected int $contentLength

The length of this upload in bytes.

$eTag

protected string $eTag

This upload's ETag checksum.

$partNumber

protected int $partNumber

Its position in the upload queue.

$path

protected string $path

The API path of this upload.

Methods

createRequest()

Create the request needed for this upload to the API.

public static createRequest(EntityBody $part, int $number, OpenStack $client, array<string|int, mixed> $options) : Request
Parameters
$part : EntityBody

The entity body being uploaded

$number : int

Its number/position, needed for name

$client : OpenStack

Client responsible for issuing requests

$options : array<string|int, mixed>

Set by the Transfer object

Return values
Request —

fromResponse()

Construct a TransferPart from a HTTP response delivered by the API.

public static fromResponse(Response $response[, int $partNumber = 1 ]) : TransferPart
Parameters
$response : Response
$partNumber : int = 1
Return values
TransferPart —

getContentLength()

public getContentLength() : int
Return values
int —

getETag()

public getETag() : string
Return values
string —

getPartNumber()

public getPartNumber() : int
Return values
int —

getPath()

public getPath() : string
Return values
string —

setContentLength()

public setContentLength(int $contentLength) : $this
Parameters
$contentLength : int
Return values
$this —

setETag()

public setETag(string $etag) : $this
Parameters
$etag : string
Return values
$this —

setPartNumber()

public setPartNumber(int $partNumber) : $this
Parameters
$partNumber : int
Return values
$this —

setPath()

public setPath( $path) : $this
Parameters
$path :
Return values
$this —

Search results