- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public interface HTTPHealthCheckOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getHost()
public abstract String getHost()The value of the host header in the HTTP 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
optional string host = 3208616;
| Returns | |
|---|---|
| Type | Description |
String |
The host. |
getHostBytes()
public abstract ByteString getHostBytes()The value of the host header in the HTTP 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
optional string host = 3208616;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for host. |
getPort()
public abstract int getPort()The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.
optional int32 port = 3446913;
| Returns | |
|---|---|
| Type | Description |
int |
The port. |
getPortName()
public abstract String getPortName()Not supported.
optional string port_name = 41534345;
| Returns | |
|---|---|
| Type | Description |
String |
The portName. |
getPortNameBytes()
public abstract ByteString getPortNameBytes()Not supported.
optional string port_name = 41534345;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for portName. |
getPortSpecification()
public abstract String getPortSpecification()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. Also supported in legacy HTTP health checks for 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.
optional string port_specification = 51590597;
| Returns | |
|---|---|
| Type | Description |
String |
The portSpecification. |
getPortSpecificationBytes()
public abstract ByteString getPortSpecificationBytes()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. Also supported in legacy HTTP health checks for 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.
optional string port_specification = 51590597;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for portSpecification. |
getProxyHeader()
public abstract String getProxyHeader()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.
optional string proxy_header = 160374142;
| Returns | |
|---|---|
| Type | Description |
String |
The proxyHeader. |
getProxyHeaderBytes()
public abstract ByteString getProxyHeaderBytes()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.
optional string proxy_header = 160374142;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for proxyHeader. |
getRequestPath()
public abstract String getRequestPath()The request path of the HTTP health check request. The default value is /.
optional string request_path = 229403605;
| Returns | |
|---|---|
| Type | Description |
String |
The requestPath. |
getRequestPathBytes()
public abstract ByteString getRequestPathBytes()The request path of the HTTP health check request. The default value is /.
optional string request_path = 229403605;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for requestPath. |
getResponse()
public abstract String getResponse()Creates a content-based HTTP 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
optional string response = 196547649;
| Returns | |
|---|---|
| Type | Description |
String |
The response. |
getResponseBytes()
public abstract ByteString getResponseBytes()Creates a content-based HTTP 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
optional string response = 196547649;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for response. |
hasHost()
public abstract boolean hasHost()The value of the host header in the HTTP 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
optional string host = 3208616;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the host field is set. |
hasPort()
public abstract boolean hasPort()The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.
optional int32 port = 3446913;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the port field is set. |
hasPortName()
public abstract boolean hasPortName()Not supported.
optional string port_name = 41534345;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the portName field is set. |
hasPortSpecification()
public abstract boolean hasPortSpecification()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. Also supported in legacy HTTP health checks for 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.
optional string port_specification = 51590597;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the portSpecification field is set. |
hasProxyHeader()
public abstract boolean hasProxyHeader()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.
optional string proxy_header = 160374142;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the proxyHeader field is set. |
hasRequestPath()
public abstract boolean hasRequestPath()The request path of the HTTP health check request. The default value is /.
optional string request_path = 229403605;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the requestPath field is set. |
hasResponse()
public abstract boolean hasResponse()Creates a content-based HTTP 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
optional string response = 196547649;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the response field is set. |