Documentation

ChunkedUploadResponse
in package
implements ModelInterface, ArrayAccess

ChunkedUploadResponse Class Doc Comment

Tags
category

Class

description

This response object is returned after you upload a chunked upload.

author

Swagger Codegen team apihelp@docusign.com

license

The Docusign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getChecksum()  : string|null
Gets checksum
getChunkedUploadId()  : string|null
Gets chunked_upload_id
getChunkedUploadParts()  : array<string|int, ChunkedUploadPart>
Gets chunked_upload_parts
getChunkedUploadUri()  : string|null
Gets chunked_upload_uri
getCommitted()  : string|null
Gets committed
getExpirationDateTime()  : string|null
Gets expiration_date_time
getMaxChunkedUploadParts()  : string|null
Gets max_chunked_upload_parts
getMaxTotalSize()  : string|null
Gets max_total_size
getModelName()  : string
The original name of the model.
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTotalSize()  : string|null
Gets total_size
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setChecksum()  : $this
Sets checksum
setChunkedUploadId()  : $this
Sets chunked_upload_id
setChunkedUploadParts()  : $this
Sets chunked_upload_parts
setChunkedUploadUri()  : $this
Sets chunked_upload_uri
setCommitted()  : $this
Sets committed
setExpirationDateTime()  : $this
Sets expiration_date_time
setMaxChunkedUploadParts()  : $this
Sets max_chunked_upload_parts
setMaxTotalSize()  : $this
Sets max_total_size
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTotalSize()  : $this
Sets total_size
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['checksum' => 'checksum', 'chunked_upload_id' => 'chunkedUploadId', 'chunked_upload_parts' => 'chunkedUploadParts', 'chunked_upload_uri' => 'chunkedUploadUri', 'committed' => 'committed', 'expiration_date_time' => 'expirationDateTime', 'max_chunked_upload_parts' => 'maxChunkedUploadParts', 'max_total_size' => 'maxTotalSize', 'total_size' => 'totalSize']

$container

Associative array for storing property values

protected array<string|int, mixed> $container = []

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['checksum' => 'getChecksum', 'chunked_upload_id' => 'getChunkedUploadId', 'chunked_upload_parts' => 'getChunkedUploadParts', 'chunked_upload_uri' => 'getChunkedUploadUri', 'committed' => 'getCommitted', 'expiration_date_time' => 'getExpirationDateTime', 'max_chunked_upload_parts' => 'getMaxChunkedUploadParts', 'max_total_size' => 'getMaxTotalSize', 'total_size' => 'getTotalSize']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['checksum' => 'setChecksum', 'chunked_upload_id' => 'setChunkedUploadId', 'chunked_upload_parts' => 'setChunkedUploadParts', 'chunked_upload_uri' => 'setChunkedUploadUri', 'committed' => 'setCommitted', 'expiration_date_time' => 'setExpirationDateTime', 'max_chunked_upload_parts' => 'setMaxChunkedUploadParts', 'max_total_size' => 'setMaxTotalSize', 'total_size' => 'setTotalSize']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['checksum' => null, 'chunked_upload_id' => null, 'chunked_upload_parts' => null, 'chunked_upload_uri' => null, 'committed' => null, 'expiration_date_time' => null, 'max_chunked_upload_parts' => null, 'max_total_size' => null, 'total_size' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'chunkedUploadResponse'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['checksum' => '?string', 'chunked_upload_id' => '?string', 'chunked_upload_parts' => '\\DocuSign\\eSign\\Model\\ChunkedUploadPart[]', 'chunked_upload_uri' => '?string', 'committed' => '?string', 'expiration_date_time' => '?string', 'max_chunked_upload_parts' => '?string', 'max_total_size' => '?string', 'total_size' => '?string']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed

__toString()

Gets the string presentation of the object

public __toString() : string
Return values
string

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed>

getChecksum()

Gets checksum

public getChecksum() : string|null
Return values
string|null

getChunkedUploadId()

Gets chunked_upload_id

public getChunkedUploadId() : string|null
Return values
string|null

getChunkedUploadUri()

Gets chunked_upload_uri

public getChunkedUploadUri() : string|null
Return values
string|null

getCommitted()

Gets committed

public getCommitted() : string|null
Return values
string|null

getExpirationDateTime()

Gets expiration_date_time

public getExpirationDateTime() : string|null
Return values
string|null

getMaxChunkedUploadParts()

Gets max_chunked_upload_parts

public getMaxChunkedUploadParts() : string|null
Return values
string|null

getMaxTotalSize()

Gets max_total_size

public getMaxTotalSize() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTotalSize()

Gets total_size

public getTotalSize() : string|null
Return values
string|null

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed
Parameters
$offset : int

Offset

Return values
mixed

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

Offset

$value : mixed

Value to be set

Return values
void

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void

setChecksum()

Sets checksum

public setChecksum(string|null $checksum) : $this
Parameters
$checksum : string|null
Return values
$this

setChunkedUploadId()

Sets chunked_upload_id

public setChunkedUploadId(string|null $chunked_upload_id) : $this
Parameters
$chunked_upload_id : string|null
Return values
$this

setChunkedUploadUri()

Sets chunked_upload_uri

public setChunkedUploadUri(string|null $chunked_upload_uri) : $this
Parameters
$chunked_upload_uri : string|null
Return values
$this

setCommitted()

Sets committed

public setCommitted(string|null $committed) : $this
Parameters
$committed : string|null
Return values
$this

setExpirationDateTime()

Sets expiration_date_time

public setExpirationDateTime(string|null $expiration_date_time) : $this
Parameters
$expiration_date_time : string|null
Return values
$this

setMaxChunkedUploadParts()

Sets max_chunked_upload_parts

public setMaxChunkedUploadParts(string|null $max_chunked_upload_parts) : $this
Parameters
$max_chunked_upload_parts : string|null
Return values
$this

setMaxTotalSize()

Sets max_total_size

public setMaxTotalSize(string|null $max_total_size) : $this
Parameters
$max_total_size : string|null
Return values
$this

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed>

setTotalSize()

Sets total_size

public setTotalSize(string|null $total_size) : $this
Parameters
$total_size : string|null
Return values
$this

swaggerFormats()

Array of property to format mappings. Used for (de)serialization

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>

swaggerTypes()

Array of property to type mappings. Used for (de)serialization

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool

True if all properties are valid

Search results