Struct cloudflare::endpoints::load_balancing::Pool

pub struct Pool {
    pub id: String,
    pub created_on: DateTime<Utc>,
    pub modified_on: DateTime<Utc>,
    pub description: String,
    pub name: String,
    pub enabled: bool,
    pub minimum_origins: u8,
    pub monitor: String,
    pub check_regions: Option<Vec<String>>,
    pub origins: HashSet<Origin>,
    pub notification_email: String,
}

A pool is a set of origins that requests could be routed to (e.g. each of your data centers or regions have its own pool). Requests will be routed to particular pools according to your steering policy, and then balanced across origins in that pool, proportional to each origin’s weight.

For example, you might have two pools: one for the US, and one for Oceania. Inside each pool, there would be many origins, with weight roughly proportional to the number of requests they can handle. Then you might use a “dynamic latency” steering policy to ensure requests get routed to whatever pool can serve them fastest. So US users will probably get routed to the US pool. If the US pool becomes unavailable, they’ll fail over to the Oceania pool.

Fields

id: String

created_on: DateTime<Utc>

modified_on: DateTime<Utc>

description: String

A human-readable description of the pool. e.g. “Primary data center - Provider XYZ”

name: String

enabled: bool

Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

minimum_origins: u8

The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we will failover to the next available pool.

monitor: String

The ID of the Monitor to use for health checking origins within this pool.

check_regions: Option<Vec<String>>

origins: HashSet<Origin>

The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

notification_email: String

The email address to send health status notifications to. This can be an individual mailbox or a mailing list.

Trait Implementations

impl Clone for Pool

fn clone(&self) -> Pool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Pool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Pool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> Endpoint<Pool, (), ()> for PoolDetails<'a>

fn method(&self) -> Method

fn path(&self) -> String

fn query(&self) -> Option<QueryType>

fn body(&self) -> Option<BodyType>

fn url(&self, environment: &Environment) -> Url

fn content_type(&self) -> String

impl<'a> Endpoint<Pool, (), Params<'a>> for CreatePool<'a>

fn method(&self) -> Method

fn path(&self) -> String

fn body(&self) -> Option<Params<'a>>

fn query(&self) -> Option<QueryType>

fn url(&self, environment: &Environment) -> Url

fn content_type(&self) -> String

impl PartialEq<Pool> for Pool

fn eq(&self, other: &Pool) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Pool) -> bool

This method tests for !=.

impl Serialize for Pool

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl ApiResult for Pool

impl Eq for Pool

impl StructuralEq for Pool

impl StructuralPartialEq for Pool