SDK for PHP 3.x
DeleteMultipleObjectsException
extends Exception
in package
implements
MonitoringEventsInterface
Uses
HasMonitoringEventsTrait
Exception thrown when errors occur while deleting objects using a {@see S3\BatchDelete} object.
Table of Contents
Interfaces
- MonitoringEventsInterface
- Interface for adding and retrieving client-side monitoring events
Methods
- __construct() : mixed
- appendMonitoringEvent() : mixed
- Append a client-side monitoring event to this object's event list
- createMessageFromErrors() : string
- Create a single error message from multiple errors.
- getDeleted() : array<string|int, mixed>
- Get the successfully deleted objects
- getErrors() : array<string|int, mixed>
- Get the errored objects
- 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.
- prependMonitoringEvent() : mixed
- Prepend a client-side monitoring event to this object's event list
Methods
__construct()
public
__construct(array<string|int, mixed> $deleted, array<string|int, mixed> $errors) : mixed
Parameters
- $deleted : array<string|int, mixed>
-
Array of successfully deleted keys
- $errors : array<string|int, mixed>
-
Array of errors that were encountered
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>
createMessageFromErrors()
Create a single error message from multiple errors.
public
static createMessageFromErrors(array<string|int, mixed> $errors) : string
Parameters
- $errors : array<string|int, mixed>
-
Errors encountered
Return values
stringgetDeleted()
Get the successfully deleted objects
public
getDeleted() : array<string|int, mixed>
Return values
array<string|int, mixed> —Returns an array of associative arrays, each containing a 'Key' and optionally 'DeleteMarker' and 'DeleterMarkerVersionId'
getErrors()
Get the errored objects
public
getErrors() : array<string|int, mixed>
Return values
array<string|int, mixed> —Returns an array of associative arrays, each containing a 'Code', 'Message', and 'Key' key.
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>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>