int
The TCP port number to which the health check
prober sends packets. The default value is 80.
Valid values are 1 through 65535.
This field is a member of oneof_ _port.
port_name
str
Not supported.
This field is a member of oneof_ _port_name.
port_specification
str
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.
This field is a member of oneof_ _port_specification.
proxy_header
str
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.
This field is a member of oneof_ _proxy_header.
request
str
Instructs the health check prober to send
this exact ASCII string, up to 1024 bytes in
length, after establishing the TCP connection.
This field is a member of oneof_ _request.
response
str
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
This field is a member of oneof_ _response.
Classes
PortSpecification
PortSpecification(value)
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.
ProxyHeader
ProxyHeader(value)
Specifies the type of proxy header to append before sending data to
the backend, either NONE or PROXY_V1. The default is NONE.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-11 UTC."],[],[],null,["# Class TCPHealthCheck (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/python/docs/reference/compute/latest/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.34.0](/python/docs/reference/compute/1.34.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.33.0](/python/docs/reference/compute/1.33.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.32.0](/python/docs/reference/compute/1.32.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.31.0](/python/docs/reference/compute/1.31.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.30.0](/python/docs/reference/compute/1.30.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.29.0](/python/docs/reference/compute/1.29.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.28.0](/python/docs/reference/compute/1.28.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.27.0](/python/docs/reference/compute/1.27.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.26.0](/python/docs/reference/compute/1.26.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.25.0](/python/docs/reference/compute/1.25.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.24.0](/python/docs/reference/compute/1.24.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.23.0](/python/docs/reference/compute/1.23.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.22.0](/python/docs/reference/compute/1.22.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.21.0](/python/docs/reference/compute/1.21.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.20.1](/python/docs/reference/compute/1.20.1/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.19.2](/python/docs/reference/compute/1.19.2/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.18.0](/python/docs/reference/compute/1.18.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.17.0](/python/docs/reference/compute/1.17.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.16.1](/python/docs/reference/compute/1.16.1/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.15.0](/python/docs/reference/compute/1.15.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.14.1](/python/docs/reference/compute/1.14.1/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.13.0](/python/docs/reference/compute/1.13.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.12.1](/python/docs/reference/compute/1.12.1/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.11.0](/python/docs/reference/compute/1.11.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.10.1](/python/docs/reference/compute/1.10.1/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.9.0](/python/docs/reference/compute/1.9.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.8.0](/python/docs/reference/compute/1.8.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.7.0](/python/docs/reference/compute/1.7.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.6.1](/python/docs/reference/compute/1.6.1/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.5.2](/python/docs/reference/compute/1.5.2/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.4.0](/python/docs/reference/compute/1.4.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.3.2](/python/docs/reference/compute/1.3.2/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.2.0](/python/docs/reference/compute/1.2.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.1.0](/python/docs/reference/compute/1.1.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [1.0.0](/python/docs/reference/compute/1.0.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [0.9.0](/python/docs/reference/compute/0.9.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [0.8.0](/python/docs/reference/compute/0.8.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [0.7.0](/python/docs/reference/compute/0.7.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [0.6.0](/python/docs/reference/compute/0.6.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [0.5.0](/python/docs/reference/compute/0.5.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [0.4.2](/python/docs/reference/compute/0.4.2/google.cloud.compute_v1.types.TCPHealthCheck)\n- [0.3.0](/python/docs/reference/compute/0.3.0/google.cloud.compute_v1.types.TCPHealthCheck)\n- [0.2.1](/python/docs/reference/compute/0.2.1/google.cloud.compute_v1.types.TCPHealthCheck)\n- [0.1.0](/python/docs/reference/compute/0.1.0/google.cloud.compute_v1.types.TCPHealthCheck) \n\n TCPHealthCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\nClasses\n-------\n\n### PortSpecification\n\n PortSpecification(value)\n\nSpecifies how a port is selected for health checking. Can be one of\nthe following values: USE_FIXED_PORT: Specifies a port number\nexplicitly using the port field in the health check. Supported by\nbackend services for passthrough load balancers and backend services\nfor proxy load balancers. Not supported by target pools. The health\ncheck supports all backends supported by the backend service\nprovided the backend can be health checked. For example, GCE_VM_IP\nnetwork endpoint groups, GCE_VM_IP_PORT network endpoint groups, and\ninstance group backends. USE_NAMED_PORT: Not supported.\nUSE_SERVING_PORT: Provides an indirect method of specifying the\nhealth check port by referring to the backend service. Only\nsupported by backend services for proxy load balancers. Not\nsupported by target pools. Not supported by backend services for\npassthrough load balancers. Supports all backends that can be health\nchecked; for example, GCE_VM_IP_PORT network endpoint groups and\ninstance group backends. For GCE_VM_IP_PORT network endpoint group\nbackends, the health check uses the port number specified for each\nendpoint in the network endpoint group. For instance group backends,\nthe health check uses the port number determined by looking up the\nbackend service's named port in the instance group's list of named\nports.\n\n### ProxyHeader\n\n ProxyHeader(value)\n\nSpecifies the type of proxy header to append before sending data to\nthe backend, either NONE or PROXY_V1. The default is NONE."]]