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

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

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 for the health check request.
String	getPortName() Port name as defined in InstanceGroup#NamedPort#name.
String	getPortSpecification() Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used 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() The string to match anywhere in the first 1024 bytes of the response body.
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 for the health check request.
HTTPHealthCheck	setPortName(String portName) Port name as defined in InstanceGroup#NamedPort#name.
HTTPHealthCheck	setPortSpecification(String portSpecification) Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used 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) The string to match anywhere in the first 1024 bytes of the response body.

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 IP on behalf of which this health check is performed will be used.

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 IP on behalf of which this health check is performed will be used.

Parameters:

host - host or null for none

getPort

public Integer getPort()

The TCP port number for the health check request. 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 for the health check request. The default value is 80. Valid values are 1 through 65535.

Parameters:

port - port or null for none

getPortName

public String getPortName()

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

Returns:

value or null for none

setPortName

public HTTPHealthCheck setPortName(String portName)

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

Parameters:

portName - portName or null for none

getPortSpecification

public String getPortSpecification()

Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields.

Returns:

value or null for none

setPortSpecification

public HTTPHealthCheck setPortSpecification(String portSpecification)

Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields.

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

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

Parameters:

requestPath - requestPath or null for none

getResponse

public String getResponse()

The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

Returns:

value or null for none

setResponse

public HTTPHealthCheck setResponse(String response)

The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

Parameters:

response - response or null for none

set

public HTTPHealthCheck set(String fieldName,
                           Object value)

Overrides:

set in class GenericJson

clone

public HTTPHealthCheck clone()

Overrides:

clone in class GenericJson