PHP Class Cloudflare\User\LoadBalancers\Pools

CTM Pool User-level Cloud Traffic Manager Pool

Author: James Bell ([email protected])

Inheritance: extends CloudFlare\Api

Show file Open project: jamesryanbell/cloudflare

Public Methods

Method	Description
create ( string $name, array $origins, string \| null $description = null, boolean \| null $enabled = null, string \| null $monitor = null, string \| null $notifier = null )	Create a pool Create a new pool
delete_pool ( string $identifier )	Delete a pool Delete a configured pool
details ( string $identifier )	Pool details Fetch a single configured pool
pools ( )	List pools List configured pools
update ( string $identifier, string \| null $name = null, array \| null $origins = null, string \| null $description = null, boolean \| null $enabled = null, string \| null $monitor = null, string \| null $notifier = null )	Modify a pool Modify a configured pool

Create a pool Create a new pool

public create ( string $name, array $origins, string \| null $description = null, boolean \| null $enabled = null, string \| null $monitor = null, string \| null $notifier = null )
$name	string	Object name
$origins	array	A list of origins contained in the pool. Traffic destined to the pool is balanced across all available origins contained in the pool (as long as the pool is considered available).
$description	string \| null	Object description
$enabled	boolean \| null	Whether this pool is enabled or not.
$monitor	string \| null	ID of the monitor object to use for monitoring the health status of origins inside this pool.
$notifier	string \| null	ID of the notifier object to use for notifications relating to the health status of origins inside this pool.

Delete a pool Delete a configured pool

public delete_pool ( string $identifier )
$identifier	string

Pool details Fetch a single configured pool

public details ( string $identifier )
$identifier	string

List pools List configured pools

public pools ( )

Modify a pool Modify a configured pool

public update ( string $identifier, string \| null $name = null, array \| null $origins = null, string \| null $description = null, boolean \| null $enabled = null, string \| null $monitor = null, string \| null $notifier = null )
$identifier	string
$name	string \| null	Object name
$origins	array \| null	A list of origins contained in the pool. Traffic destined to the pool is balanced across all available origins contained in the pool (as long as the pool is considered available).
$description	string \| null	Object description
$enabled	boolean \| null	Whether this pool is enabled or not.
$monitor	string \| null	ID of the monitor object to use for monitoring the health status of origins inside this pool.
$notifier	string \| null	ID of the notifier object to use for notifications relating to the health status of origins inside this pool.