Compute V1 Client - Class HTTP2HealthCheck (1.5.0)

Reference documentation and code samples for the Compute V1 Client class HTTP2HealthCheck.

Generated from protobuf message google.cloud.compute.v1.HTTP2HealthCheck

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ host`	`string` 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
`↳ 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.
`↳ port_name`	`string` Not supported.
`↳ port_specification`	`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 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.
`↳ proxy_header`	`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_path`	`string` The request path of the HTTP/2 health check request. The default value is /.
`↳ response`	`string` 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

getHost

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

Generated from protobuf field optional string host = 3208616;

Returns
Type	Description
`string`

hasHost

clearHost

setHost

Generated from protobuf field optional string host = 3208616;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPort

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

Generated from protobuf field optional int32 port = 3446913;

Returns
Type	Description
`int`

hasPort

clearPort

setPort

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

Generated from protobuf field optional int32 port = 3446913;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPortName

Not supported.

Generated from protobuf field optional string port_name = 41534345;

Returns
Type	Description
`string`

hasPortName

clearPortName

setPortName

Not supported.

Generated from protobuf field optional string port_name = 41534345;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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 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.

Generated from protobuf field optional string port_specification = 51590597;

Returns
Type	Description
`string`

hasPortSpecification

clearPortSpecification

setPortSpecification

Check the PortSpecification enum for the list of possible values.

Generated from protobuf field optional string port_specification = 51590597;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Generated from protobuf field optional string proxy_header = 160374142;

Returns
Type	Description
`string`

hasProxyHeader

clearProxyHeader

setProxyHeader

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.

Generated from protobuf field optional string proxy_header = 160374142;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRequestPath

The request path of the HTTP/2 health check request. The default value is /.

Generated from protobuf field optional string request_path = 229403605;

Returns
Type	Description
`string`

hasRequestPath

clearRequestPath

setRequestPath

The request path of the HTTP/2 health check request. The default value is /.

Generated from protobuf field optional string request_path = 229403605;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getResponse

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

Generated from protobuf field optional string response = 196547649;

Returns
Type	Description
`string`

hasResponse

clearResponse

setResponse

Generated from protobuf field optional string response = 196547649;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`