Files
BW/include/aws/old/ResultInterface.php
sean 343b4a3f3f
Some checks failed
deploy-testing / deploy (push) Has been cancelled
Initial testing snapshot
2026-11-19 18:32:17 -05:00

55 lines
1.3 KiB
PHP

<?php
namespace Aws;
/**
* Represents an AWS result object that is returned from executing an operation.
*/
interface ResultInterface extends \ArrayAccess, \IteratorAggregate, \Countable
{
/**
* Provides debug information about the result object
*
* @return string
*/
public function __toString();
/**
* Convert the result to an array.
*
* @return array
*/
public function toArray();
/**
* Check if the model contains a key by name
*
* @param string $name Name of the key to retrieve
*
* @return bool
*/
public function hasKey($name);
/**
* Get a specific key value from the result model.
*
* @param string $key Key to retrieve.
*
* @return mixed|null Value of the key or NULL if not found.
*/
public function get($key);
/**
* Returns the result of executing a JMESPath expression on the contents
* of the Result model.
*
* $result = $client->execute($command);
* $jpResult = $result->search('foo.*.bar[?baz > `10`]');
*
* @param string $expression JMESPath expression to execute
*
* @return mixed Returns the result of the JMESPath expression.
* @link http://jmespath.readthedocs.org/en/latest/ JMESPath documentation
*/
public function search($expression);
};