NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

Class ConfigResourceWaiter

Resource waiter driven by configuration options

Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface

Extended by

Aws\Common\Waiter\AbstractWaiter implements Aws\Common\Waiter\WaiterInterface

Extended by

Aws\Common\Waiter\AbstractResourceWaiter implements Aws\Common\Waiter\ResourceWaiterInterface

Extended by

Aws\Common\Waiter\ConfigResourceWaiter

Namespace: Aws\Common\Waiter
Located at Aws/Common/Waiter/ConfigResourceWaiter.php

Methods summary

public __construct ( Aws\Common\Waiter\WaiterConfig $waiterConfig )
public setConfig ( array $config )

Set config options associated with the waiter
public getWaiterConfig ( )

Get the waiter's configuration data
protected doWait ( )

Method to implement in subclasses
protected checkErrorAcceptor ( Aws\Common\Exception\ServiceResponseException $e )

Check if an exception satisfies a success or failure acceptor
protected checkResult ( Guzzle\Service\Resource\Model $result )

Check to see if the response model satisfies a success or failure state
protected checkPath ( 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

#


                     public


__construct( Aws\Common\Waiter\WaiterConfig $waiterConfig )

Parameters

$waiterConfig: Aws\Common\Waiter\WaiterConfig
$waiterConfig Waiter configuration

#


                     public 
                    Aws\Common\Waiter\ConfigResourceWaiter


setConfig( array $config )

Set config options associated with the waiter

Parameters

$config: array
$config Options to set

Returns

Aws\Common\Waiter\ConfigResourceWaiter

Overrides

Aws\Common\Waiter\AbstractWaiter::setConfig

#


                     public 
                    Aws\Common\Waiter\WaiterConfig


getWaiterConfig( )

Get the waiter's configuration data

Returns

Aws\Common\Waiter\WaiterConfig

#


                     protected 
                    boolean


doWait( )

Method to implement in subclasses

Returns

boolean
Return true when successful, false on failure

#


                     protected 
                    boolean|null


checkErrorAcceptor( Aws\Common\Exception\ServiceResponseException $e )

Check if an exception satisfies a success or failure acceptor

Parameters

$e: Aws\Common\Exception\ServiceResponseException
$e

Returns

boolean|null
Returns true for success, false for failure, and null for no transition

#


                     protected 
                    boolean


checkResult( Guzzle\Service\Resource\Model $result )

Check to see if the response model satisfies a success or failure state

Parameters

$result: Guzzle\Service\Resource\Model
$result Result model

Returns

boolean

Throws

Aws\Common\Exception\RuntimeException

#


                     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

boolean

Methods inherited from Aws\Common\Waiter\AbstractResourceWaiter

setClient(), wait()

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

INTERVAL, MAX_ATTEMPTS

Properties summary

`protected Aws\Common\Waiter\WaiterConfig`	`$waiterConfig`	# Waiter configuration

Properties inherited from Aws\Common\Waiter\AbstractResourceWaiter

Properties inherited from Aws\Common\Waiter\AbstractWaiter

$attempts, $config

Properties inherited from Guzzle\Common\AbstractHasDispatcher

$eventDispatcher