Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::TCPHealthCheck (v1.7.1)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::TCPHealthCheck.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#port

def port() -> ::Integer
Returns
  • (::Integer) — The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

#port=

def port=(value) -> ::Integer
Parameter
  • value (::Integer) — The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.
Returns
  • (::Integer) — The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

#port_name

def port_name() -> ::String
Returns
  • (::String) — Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

#port_name=

def port_name=(value) -> ::String
Parameter
  • value (::String) — Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
Returns
  • (::String) — Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

#port_specification

def port_specification() -> ::String
Returns
  • (::String) — Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields. Check the PortSpecification enum for the list of possible values.

#port_specification=

def port_specification=(value) -> ::String
Parameter
  • value (::String) — Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields. Check the PortSpecification enum for the list of possible values.
Returns
  • (::String) — Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, TCP health check follows behavior specified in port and portName fields. Check the PortSpecification enum for the list of possible values.

#proxy_header

def proxy_header() -> ::String
Returns
  • (::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.

#proxy_header=

def proxy_header=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def request() -> ::String
Returns
  • (::String) — The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

#request=

def request=(value) -> ::String
Parameter
  • value (::String) — The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
Returns
  • (::String) — The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

#response

def response() -> ::String
Returns
  • (::String) — The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

#response=

def response=(value) -> ::String
Parameter
  • value (::String) — The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
Returns
  • (::String) — The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.