Class ConfigResourceWaiter
Resource waiter driven by configuration options
- Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
-
Aws\Common\Waiter\AbstractWaiter
implements
Aws\Common\Waiter\WaiterInterface
-
Aws\Common\Waiter\AbstractResourceWaiter
implements
Aws\Common\Waiter\ResourceWaiterInterface
-
Aws\Common\Waiter\ConfigResourceWaiter
Methods summary
-
public__construct ( Aws\Common\Waiter\WaiterConfig $waiterConfig ) -
publicsetConfig ( array $config )Set config options associated with the waiter
-
publicgetWaiterConfig ( )Get the waiter's configuration data
-
protecteddoWait ( )Method to implement in subclasses
-
protectedcheckErrorAcceptor ( Aws\Common\Exception\ServiceResponseException $e )Check if an exception satisfies a success or failure acceptor
-
protectedcheckResult ( Guzzle\Service\Resource\Model $result )Check to see if the response model satisfies a success or failure state
-
protectedcheckPath ( Guzzle\Service\Resource\Model $model, string $key = null, string $checkValue = array(), bool $all = true )Check to see if the path of the output key is satisfied by the value
Methods detail
Parameters
- $waiterConfig
Aws\Common\Waiter\WaiterConfig
$waiterConfig Waiter configuration
Set config options associated with the waiter
Parameters
- $config
array
$config Options to set
Returns
Overrides
Method to implement in subclasses
Returns
booleanReturn true when successful, false on failure
Check if an exception satisfies a success or failure acceptor
Parameters
Returns
boolean|nullReturns true for success, false for failure, and null for no transition
Check to see if the response model satisfies a success or failure state
Parameters
- $result
Guzzle\Service\Resource\Model
$result Result model
Returns
booleanThrows
protected
boolean
checkPath( Guzzle\Service\Resource\Model $model, string $key = null, string $checkValue = array(), boolean $all = true )
Check to see if the path of the output key is satisfied by the value
Parameters
- $model
Guzzle\Service\Resource\Model
$model Result model- $key
string
$key Key to check- $checkValue
string
$checkValue Compare the key to the value- $all
boolean
$all Set to true to ensure all value match or false to only match one
Returns
booleanMethods inherited from Aws\Common\Waiter\AbstractResourceWaiter
Methods inherited from Aws\Common\Waiter\AbstractWaiter
getAllEvents(),
getInterval(),
getMaxAttempts(),
setInterval(),
setMaxAttempts()
Methods inherited from Guzzle\Common\AbstractHasDispatcher
addSubscriber(),
dispatch(),
getEventDispatcher(),
setEventDispatcher()
Magic methods summary
Constants summary
Constants inherited from Aws\Common\Waiter\WaiterInterface
Properties summary
protected
|
$waiterConfig |
#
Waiter configuration |