Struct TCPHealthCheck 

#[non_exhaustive]
pub struct TCPHealthCheck {
    pub port: Option<i32>,
    pub port_name: Option<String>,
    pub port_specification: Option<PortSpecification>,
    pub proxy_header: Option<ProxyHeader>,
    pub request: Option<String>,
    pub response: Option<String>,
    /* private fields */
}

Available on crate features health-checks or region-health-checks only.

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.

port: Option<i32>

The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through65535.

port_name: Option<String>

Not supported.

port_specification: Option<PortSpecification>

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group backends.

For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports.

proxy_header: Option<ProxyHeader>

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

request: Option<String>

Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.

response: Option<String>

Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp

Implementations

impl TCPHealthCheck

pub fn new() -> Self

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

where T: Into<i32>,

Sets the value of port.

Example

let x = TCPHealthCheck::new().set_port(42);

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

where T: Into<i32>,

Sets or clears the value of port.

Example

let x = TCPHealthCheck::new().set_or_clear_port(Some(42));
let x = TCPHealthCheck::new().set_or_clear_port(None::<i32>);

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

where T: Into<String>,

Sets the value of port_name.

Example

let x = TCPHealthCheck::new().set_port_name("example");

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

where T: Into<String>,

Sets or clears the value of port_name.

Example

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

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

where T: Into<PortSpecification>,

Sets the value of port_specification.

Example

use google_cloud_compute_v1::model::tcp_health_check::PortSpecification;
let x0 = TCPHealthCheck::new().set_port_specification(PortSpecification::UseNamedPort);
let x1 = TCPHealthCheck::new().set_port_specification(PortSpecification::UseServingPort);

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

where T: Into<PortSpecification>,

Sets or clears the value of port_specification.

Example

use google_cloud_compute_v1::model::tcp_health_check::PortSpecification;
let x0 = TCPHealthCheck::new().set_or_clear_port_specification(Some(PortSpecification::UseNamedPort));
let x1 = TCPHealthCheck::new().set_or_clear_port_specification(Some(PortSpecification::UseServingPort));
let x_none = TCPHealthCheck::new().set_or_clear_port_specification(None::<PortSpecification>);

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

where T: Into<ProxyHeader>,

Sets the value of proxy_header.

Example

use google_cloud_compute_v1::model::tcp_health_check::ProxyHeader;
let x0 = TCPHealthCheck::new().set_proxy_header(ProxyHeader::ProxyV1);

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

where T: Into<ProxyHeader>,

Sets or clears the value of proxy_header.

Example

use google_cloud_compute_v1::model::tcp_health_check::ProxyHeader;
let x0 = TCPHealthCheck::new().set_or_clear_proxy_header(Some(ProxyHeader::ProxyV1));
let x_none = TCPHealthCheck::new().set_or_clear_proxy_header(None::<ProxyHeader>);

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

where T: Into<String>,

Sets the value of request.

Example

let x = TCPHealthCheck::new().set_request("example");

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

where T: Into<String>,

Sets or clears the value of request.

Example

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

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

where T: Into<String>,

Sets the value of response.

Example

let x = TCPHealthCheck::new().set_response("example");

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

where T: Into<String>,

Sets or clears the value of response.

Example

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

Trait Implementations

impl Clone for TCPHealthCheck

fn clone(&self) -> TCPHealthCheck

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TCPHealthCheck

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

Formats the value using the given formatter.

impl Default for TCPHealthCheck

fn default() -> TCPHealthCheck

Returns the “default value” for a type.

impl Message for TCPHealthCheck

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TCPHealthCheck

fn eq(&self, other: &TCPHealthCheck) -> 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 TCPHealthCheck