Struct google_api_proto::google::cloud::compute::v1::TcpHealthCheck

pub struct TcpHealthCheck {
    pub port: Option<i32>,
    pub port_name: Option<String>,
    pub port_specification: Option<String>,
    pub proxy_header: Option<String>,
    pub request: Option<String>,
    pub response: Option<String>,
}

Fields

port: Option<i32>

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

port_name: Option<String>

Not supported.

port_specification: Option<String>

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 the port 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. Check the PortSpecification enum for the list of possible values.

proxy_header: Option<String>

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

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 port(&self) -> i32

Returns the value of port, or the default value if port is unset.

pub fn request(&self) -> &str

Returns the value of request, or the default value if request is unset.

pub fn port_name(&self) -> &str

Returns the value of port_name, or the default value if port_name is unset.

pub fn port_specification(&self) -> &str

Returns the value of port_specification, or the default value if port_specification is unset.

pub fn proxy_header(&self) -> &str

Returns the value of proxy_header, or the default value if proxy_header is unset.

pub fn response(&self) -> &str

Returns the value of response, or the default value if response is unset.

Trait Implementations

impl Clone for TcpHealthCheck

fn clone(&self) -> TcpHealthCheck

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for TcpHealthCheck

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TcpHealthCheck

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

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

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

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

impl StructuralPartialEq for TcpHealthCheck