HTTP2HealthCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs).. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes
| Name | Description |
host |
str
The value of the host header in the HTTP/2 health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest This field is a member of oneof_ _host.
|
port |
int
The TCP port number to which the health check prober sends packets. The default value is 443. 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 pass-through 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 pass-through 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_path |
str
The request path of the HTTP/2 health check request. The default value is /. This field is a member of oneof_ _request_path.
|
response |
str
Creates a content-based HTTP/2 health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http 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 pass-through 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 pass-through 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.
Values: UNDEFINED_PORT_SPECIFICATION (0): A value indicating that the enum field is not set. USE_FIXED_PORT (190235748): The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends. USE_NAMED_PORT (349300671): Not supported. USE_SERVING_PORT (362637516): For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's 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.
Values: UNDEFINED_PROXY_HEADER (0): A value indicating that the enum field is not set. NONE (2402104): No description available. PROXY_V1 (334352940): No description available.