ResourceWaiterInterface
extends
WaiterInterface
in
Interface used in conjunction with clients to wait on a resource
Table of Contents
Constants
- INTERVAL = 'waiter.interval'
- MAX_ATTEMPTS = 'waiter.max_attempts'
Methods
- setClient() : self
- Set the client associated with the waiter
- setConfig() : self
- Set configuration options associated with the waiter
- setInterval() : self
- Set the amount of time to interval between attempts
- setMaxAttempts() : self
- Set the maximum number of attempts to make when waiting
- wait() : mixed
- Begin the waiting loop
Constants
INTERVAL
public
mixed
INTERVAL
= 'waiter.interval'
MAX_ATTEMPTS
public
mixed
MAX_ATTEMPTS
= 'waiter.max_attempts'
Methods
setClient()
Set the client associated with the waiter
public
setClient(AwsClientInterface $client) : self
Parameters
- $client : AwsClientInterface
-
Client to use with the waiter
Return values
selfsetConfig()
Set configuration options associated with the waiter
public
setConfig(array<string|int, mixed> $config) : self
Parameters
- $config : array<string|int, mixed>
-
Configuration options to set
Return values
selfsetInterval()
Set the amount of time to interval between attempts
public
setInterval(int $interval) : self
Parameters
- $interval : int
-
Interval in seconds
Return values
selfsetMaxAttempts()
Set the maximum number of attempts to make when waiting
public
setMaxAttempts(int $maxAttempts) : self
Parameters
- $maxAttempts : int
-
Max number of attempts
Return values
selfwait()
Begin the waiting loop
public
wait() : mixed