Compute Engine v1 API - Class HTTPHealthCheck (2.15.0)

public sealed class HTTPHealthCheck : IMessage<HTTPHealthCheck>, IEquatable<HTTPHealthCheck>, IDeepCloneable<HTTPHealthCheck>, IBufferMessage, IMessage

Inheritance

object > HTTPHealthCheck

Implements

IMessage HTTPHealthCheck, IEquatable HTTPHealthCheck, IDeepCloneable HTTPHealthCheck, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

HTTPHealthCheck()

public HTTPHealthCheck()

HTTPHealthCheck(HTTPHealthCheck)

public HTTPHealthCheck(HTTPHealthCheck other)

Parameter
Name	Description
`other`	`HTTPHealthCheck`

Properties

HasHost

public bool HasHost { get; }

Gets whether the "host" field is set

Property Value
Type	Description
`bool`

HasPort

public bool HasPort { get; }

Gets whether the "port" field is set

Property Value
Type	Description
`bool`

HasPortName

public bool HasPortName { get; }

Gets whether the "port_name" field is set

Property Value
Type	Description
`bool`

HasPortSpecification

public bool HasPortSpecification { get; }

Gets whether the "port_specification" field is set

Property Value
Type	Description
`bool`

HasProxyHeader

public bool HasProxyHeader { get; }

Gets whether the "proxy_header" field is set

Property Value
Type	Description
`bool`

HasRequestPath

public bool HasRequestPath { get; }

Gets whether the "request_path" field is set

Property Value
Type	Description
`bool`

HasResponse

public bool HasResponse { get; }

Gets whether the "response" field is set

Property Value
Type	Description
`bool`

Host

public string Host { get; set; }

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

Property Value
Type	Description
`string`

Port

public int Port { get; set; }

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

Property Value
Type	Description
`int`

PortName

public string PortName { get; set; }

Not supported.

Property Value
Type	Description
`string`

PortSpecification

public string PortSpecification { get; set; }

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.

Property Value
Type	Description
`string`

ProxyHeader

public string ProxyHeader { get; set; }

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.

Property Value
Type	Description
`string`

RequestPath

public string RequestPath { get; set; }

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

Property Value
Type	Description
`string`

Response

public string Response { get; set; }

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

Property Value
Type	Description
`string`