S3MultipartUploadException
extends MultipartUploadException
in package
Table of Contents
- $bucket : string
- $filename : string
- $key : string
- $monitoringEvents : mixed
- $state : UploadState
- __construct() : mixed
- appendMonitoringEvent() : mixed
- Append a client-side monitoring event to this object's event list
- getBucket() : string|null
- Get the Bucket information of the transfer object
- getKey() : string|null
- Get the Key information of the transfer object
- getMonitoringEvents() : array<string|int, mixed>
- Get client-side monitoring events attached to this object. Each event is represented as an associative array within the returned array.
- getSourceFileName() : string|null
- Get the source file name of the transfer object
- getState() : UploadState
- Get the state of the transfer
- prependMonitoringEvent() : mixed
- Prepend a client-side monitoring event to this object's event list
- collectPathInfo() : mixed
- Collect file path information when accessible. (Bucket, Key)
Properties
$bucket
private
string
$bucket
Bucket of the transfer object
$filename
private
string
$filename
Source file name of the transfer object
$key
private
string
$key
Key of the transfer object
$monitoringEvents
private
mixed
$monitoringEvents
= []
$state
private
UploadState
$state
State of the erroneous transfer
Methods
__construct()
public
__construct(UploadState $state[, Exception|array<string|int, mixed> $prev = null ]) : mixed
Parameters
- $state : UploadState
-
Upload state at time of the exception.
- $prev : Exception|array<string|int, mixed> = null
-
Exception being thrown. Could be an array of AwsExceptions being thrown when uploading parts for one object, or an instance of AwsException for a specific Multipart error being thrown in the MultipartUpload process.
Return values
mixed —appendMonitoringEvent()
Append a client-side monitoring event to this object's event list
public
appendMonitoringEvent(array<string|int, mixed> $event) : mixed
Parameters
- $event : array<string|int, mixed>
Return values
mixed —getBucket()
Get the Bucket information of the transfer object
public
getBucket() : string|null
Return values
string|null —Returns null when 'Bucket' information is unavailable.
getKey()
Get the Key information of the transfer object
public
getKey() : string|null
Return values
string|null —Returns null when 'Key' information is unavailable.
getMonitoringEvents()
Get client-side monitoring events attached to this object. Each event is represented as an associative array within the returned array.
public
getMonitoringEvents() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSourceFileName()
Get the source file name of the transfer object
public
getSourceFileName() : string|null
Return values
string|null —Returns null when metadata of the stream wrapped in 'Body' parameter is unavailable.
getState()
Get the state of the transfer
public
getState() : UploadState
Return values
UploadState —prependMonitoringEvent()
Prepend a client-side monitoring event to this object's event list
public
prependMonitoringEvent(array<string|int, mixed> $event) : mixed
Parameters
- $event : array<string|int, mixed>
Return values
mixed —collectPathInfo()
Collect file path information when accessible. (Bucket, Key)
private
collectPathInfo(CommandInterface $cmd) : mixed
Parameters
- $cmd : CommandInterface