Struct TargetPool 

#[non_exhaustive]
pub struct TargetPool {

    pub backup_pool: Option<String>,
    pub creation_timestamp: Option<String>,
    pub description: Option<String>,
    pub failover_ratio: Option<f32>,
    pub health_checks: Vec<String>,
    pub id: Option<u64>,
    pub instances: Vec<String>,
    pub kind: Option<String>,
    pub name: Option<String>,
    pub region: Option<String>,
    pub security_policy: Option<String>,
    pub self_link: Option<String>,
    pub session_affinity: Option<SessionAffinity>,
    /* private fields */
}

Available on crate feature target-pools only.

Represents a Target Pool resource.

Target pools are used with external passthrough Network Load Balancers. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, readUsing target pools.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

backup_pool: Option<String>

The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or belowfailoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.

In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the “force” mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

creation_timestamp: Option<String>

Output only. [Output Only] Creation timestamp inRFC3339 text format.

description: Option<String>

An optional description of this resource. Provide this property when you create the resource.

failover_ratio: Option<f32>

This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].

If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.

In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the “force” mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

health_checks: Vec<String>

The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

id: Option<u64>

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

instances: Vec<String>

A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

kind: Option<String>

Output only. [Output Only] Type of the resource. Always compute#targetPool for target pools.

name: Option<String>

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

region: Option<String>

Output only. [Output Only] URL of the region where the target pool resides.

security_policy: Option<String>

[Output Only] The resource URL for the security policy associated with this target pool.

self_link: Option<String>

[Output Only] Server-defined URL for the resource.

session_affinity: Option<SessionAffinity>

Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.

Implementations

impl TargetPool

pub fn new() -> Self

pub fn set_backup_pool<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of backup_pool.

Example

let x = TargetPool::new().set_backup_pool("example");

pub fn set_or_clear_backup_pool<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of backup_pool.

Example

let x = TargetPool::new().set_or_clear_backup_pool(Some("example"));
let x = TargetPool::new().set_or_clear_backup_pool(None::<String>);

pub fn set_creation_timestamp<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of creation_timestamp.

Example

let x = TargetPool::new().set_creation_timestamp("example");

pub fn set_or_clear_creation_timestamp<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of creation_timestamp.

Example

let x = TargetPool::new().set_or_clear_creation_timestamp(Some("example"));
let x = TargetPool::new().set_or_clear_creation_timestamp(None::<String>);

pub fn set_description<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of description.

Example

let x = TargetPool::new().set_description("example");

pub fn set_or_clear_description<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of description.

Example

let x = TargetPool::new().set_or_clear_description(Some("example"));
let x = TargetPool::new().set_or_clear_description(None::<String>);

pub fn set_failover_ratio<T>(self, v: T) -> Self

where T: Into<f32>,

Sets the value of failover_ratio.

Example

let x = TargetPool::new().set_failover_ratio(42.0);

pub fn set_or_clear_failover_ratio<T>(self, v: Option<T>) -> Self

where T: Into<f32>,

Sets or clears the value of failover_ratio.

Example

let x = TargetPool::new().set_or_clear_failover_ratio(Some(42.0));
let x = TargetPool::new().set_or_clear_failover_ratio(None::<f32>);

pub fn set_health_checks<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of health_checks.

Example

let x = TargetPool::new().set_health_checks(["a", "b", "c"]);

pub fn set_id<T>(self, v: T) -> Self

where T: Into<u64>,

Sets the value of id.

Example

let x = TargetPool::new().set_id(42_u32);

pub fn set_or_clear_id<T>(self, v: Option<T>) -> Self

where T: Into<u64>,

Sets or clears the value of id.

Example

let x = TargetPool::new().set_or_clear_id(Some(42_u32));
let x = TargetPool::new().set_or_clear_id(None::<u32>);

pub fn set_instances<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of instances.

Example

let x = TargetPool::new().set_instances(["a", "b", "c"]);

pub fn set_kind<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of kind.

Example

let x = TargetPool::new().set_kind("example");

pub fn set_or_clear_kind<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of kind.

Example

let x = TargetPool::new().set_or_clear_kind(Some("example"));
let x = TargetPool::new().set_or_clear_kind(None::<String>);

pub fn set_name<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of name.

Example

let x = TargetPool::new().set_name("example");

pub fn set_or_clear_name<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of name.

Example

let x = TargetPool::new().set_or_clear_name(Some("example"));
let x = TargetPool::new().set_or_clear_name(None::<String>);

pub fn set_region<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of region.

Example

let x = TargetPool::new().set_region("example");

pub fn set_or_clear_region<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of region.

Example

let x = TargetPool::new().set_or_clear_region(Some("example"));
let x = TargetPool::new().set_or_clear_region(None::<String>);

pub fn set_security_policy<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of security_policy.

Example

let x = TargetPool::new().set_security_policy("example");

pub fn set_or_clear_security_policy<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of security_policy.

Example

let x = TargetPool::new().set_or_clear_security_policy(Some("example"));
let x = TargetPool::new().set_or_clear_security_policy(None::<String>);

pub fn set_self_link<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of self_link.

Example

let x = TargetPool::new().set_self_link("example");

pub fn set_or_clear_self_link<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of self_link.

Example

let x = TargetPool::new().set_or_clear_self_link(Some("example"));
let x = TargetPool::new().set_or_clear_self_link(None::<String>);

pub fn set_session_affinity<T>(self, v: T) -> Self

where T: Into<SessionAffinity>,

Sets the value of session_affinity.

Example

use google_cloud_compute_v1::model::target_pool::SessionAffinity;
let x0 = TargetPool::new().set_session_affinity(SessionAffinity::ClientIpNoDestination);
let x1 = TargetPool::new().set_session_affinity(SessionAffinity::ClientIpPortProto);
let x2 = TargetPool::new().set_session_affinity(SessionAffinity::ClientIpProto);

pub fn set_or_clear_session_affinity<T>(self, v: Option<T>) -> Self

where T: Into<SessionAffinity>,

Sets or clears the value of session_affinity.

Example

use google_cloud_compute_v1::model::target_pool::SessionAffinity;
let x0 = TargetPool::new().set_or_clear_session_affinity(Some(SessionAffinity::ClientIpNoDestination));
let x1 = TargetPool::new().set_or_clear_session_affinity(Some(SessionAffinity::ClientIpPortProto));
let x2 = TargetPool::new().set_or_clear_session_affinity(Some(SessionAffinity::ClientIpProto));
let x_none = TargetPool::new().set_or_clear_session_affinity(None::<SessionAffinity>);

Trait Implementations

impl Clone for TargetPool

fn clone(&self) -> TargetPool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TargetPool

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

Formats the value using the given formatter.

impl Default for TargetPool

fn default() -> TargetPool

Returns the “default value” for a type.

impl Message for TargetPool

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TargetPool

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TargetPool