target.apidocs.com.google.api.services.compute.model.HTTPHealthCheck.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

The newest version!







HTTPHealthCheck (Compute Engine API v1-rev20250320-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class HTTPHealthCheck



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.HTTPHealthCheck













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class HTTPHealthCheck
extends com.google.api.client.json.GenericJson
Model definition for HTTPHealthCheck.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


HTTPHealthCheck() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


HTTPHealthCheck
clone() 


String
getHost()
The value of the host header in the HTTP health check request.



Integer
getPort()
The TCP port number to which the health check prober sends packets.



String
getPortName()
Not supported.



String
getPortSpecification()
Specifies how a port is selected for health checking.



String
getProxyHeader()
Specifies the type of proxy header to append before sending data to the backend, either NONE or
 PROXY_V1.



String
getRequestPath()
The request path of the HTTP health check request.



String
getResponse()
Creates a content-based HTTP health check.



HTTPHealthCheck
set(String fieldName,
   Object value) 


HTTPHealthCheck
setHost(String host)
The value of the host header in the HTTP health check request.



HTTPHealthCheck
setPort(Integer port)
The TCP port number to which the health check prober sends packets.



HTTPHealthCheck
setPortName(String portName)
Not supported.



HTTPHealthCheck
setPortSpecification(String portSpecification)
Specifies how a port is selected for health checking.



HTTPHealthCheck
setProxyHeader(String proxyHeader)
Specifies the type of proxy header to append before sending data to the backend, either NONE or
 PROXY_V1.



HTTPHealthCheck
setRequestPath(String requestPath)
The request path of the HTTP health check request.



HTTPHealthCheck
setResponse(String response)
Creates a content-based HTTP health check.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





HTTPHealthCheck
public HTTPHealthCheck()









Method Detail





getHost
public 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

Returns:
value or null for none








setHost
public HTTPHealthCheck setHost(String host)
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

Parameters:
host - host or null for none








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

Returns:
value or null for none








setPort
public HTTPHealthCheck setPort(Integer port)
The TCP port number to which the health check prober sends packets. The default value is 80.
 Valid values are 1 through 65535.

Parameters:
port - port or null for none








getPortName
public String getPortName()
Not supported.

Returns:
value or null for none








setPortName
public HTTPHealthCheck setPortName(String portName)
Not supported.

Parameters:
portName - portName or null for none








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

Returns:
value or null for none








setPortSpecification
public HTTPHealthCheck setPortSpecification(String portSpecification)
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.

Parameters:
portSpecification - portSpecification or null for none








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

Returns:
value or null for none








setProxyHeader
public HTTPHealthCheck setProxyHeader(String proxyHeader)
Specifies the type of proxy header to append before sending data to the backend, either NONE or
 PROXY_V1. The default is NONE.

Parameters:
proxyHeader - proxyHeader or null for none








getRequestPath
public String getRequestPath()
The request path of the HTTP health check request. The default value is /. Must comply with
 RFC3986.

Returns:
value or null for none








setRequestPath
public HTTPHealthCheck setRequestPath(String requestPath)
The request path of the HTTP health check request. The default value is /. Must comply with
 RFC3986.

Parameters:
requestPath - requestPath or null for none








getResponse
public 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

Returns:
value or null for none








setResponse
public HTTPHealthCheck setResponse(String response)
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

Parameters:
response - response or null for none








set
public HTTPHealthCheck set(String fieldName,
                           Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public HTTPHealthCheck clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.

Modifier and Type	Method and Description
`HTTPHealthCheck`	`clone()`
`String`	`getHost()` The value of the host header in the HTTP health check request.
`Integer`	`getPort()` The TCP port number to which the health check prober sends packets.
`String`	`getPortName()` Not supported.
`String`	`getPortSpecification()` Specifies how a port is selected for health checking.
`String`	`getProxyHeader()` Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
`String`	`getRequestPath()` The request path of the HTTP health check request.
`String`	`getResponse()` Creates a content-based HTTP health check.
`HTTPHealthCheck`	`set(String fieldName, Object value)`
`HTTPHealthCheck`	`setHost(String host)` The value of the host header in the HTTP health check request.
`HTTPHealthCheck`	`setPort(Integer port)` The TCP port number to which the health check prober sends packets.
`HTTPHealthCheck`	`setPortName(String portName)` Not supported.
`HTTPHealthCheck`	`setPortSpecification(String portSpecification)` Specifies how a port is selected for health checking.
`HTTPHealthCheck`	`setProxyHeader(String proxyHeader)` Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
`HTTPHealthCheck`	`setRequestPath(String requestPath)` The request path of the HTTP health check request.
`HTTPHealthCheck`	`setResponse(String response)` Creates a content-based HTTP health check.