SDK for PHP V3

DownloadResult extends Result
in package

FinalYes

AWS result.

Table of Contents

Methods

__construct()  : mixed
__toString()  : string
Provides debug information about the result object
appendMonitoringEvent()  : mixed
Append a client-side monitoring event to this object's event list
count()  : int
get()  : mixed|null
Get a specific key value from the result model.
getDownloadDataResult()  : mixed
getIterator()  : Traversable
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.
getPath()  : mixed
hasKey()  : bool
Check if the model contains a key by name
offsetExists()  : bool
offsetGet()  : mixed|null
This method returns a reference to the variable to allow for indirect array modification (e.g., $foo['bar']['baz'] = 'qux').
offsetSet()  : void
offsetUnset()  : void
prependMonitoringEvent()  : mixed
Prepend a client-side monitoring event to this object's event list
search()  : mixed
Returns the result of executing a JMESPath expression on the contents of the Result model.
toArray()  : mixed

Methods

__construct()

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

__toString()

Provides debug information about the result object

public __toString() : string
Return values
string

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>

count()

public count() : int
Return values
int

get()

Get a specific key value from the result model.

public get(mixed $key) : mixed|null
Parameters
$key : mixed

Key to retrieve.

Return values
mixed|null —

Value of the key or NULL if not found.

getDownloadDataResult()

public getDownloadDataResult() : mixed

getIterator()

public getIterator() : Traversable
Return values
Traversable

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>

getPath()

public getPath(mixed $path) : mixed
Parameters
$path : mixed
Tags
deprecated

hasKey()

Check if the model contains a key by name

public hasKey(mixed $name) : bool
Parameters
$name : mixed

Name of the key to retrieve

Return values
bool

offsetExists()

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetGet()

This method returns a reference to the variable to allow for indirect array modification (e.g., $foo['bar']['baz'] = 'qux').

public & offsetGet( $offset) : mixed|null
Parameters
$offset :
Return values
mixed|null

offsetSet()

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

offsetUnset()

public offsetUnset(mixed $offset) : void
Parameters
$offset : 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>

search()

Returns the result of executing a JMESPath expression on the contents of the Result model.

public search(mixed $expression) : mixed

$result = $client->execute($command); $jpResult = $result->search('foo.*.bar[?baz > 10]');

Parameters
$expression : mixed

JMESPath expression to execute

Return values
mixed —

Returns the result of the JMESPath expression.

toArray()

public toArray() : mixed
<-- modeled_exceptions -->
On this page