com.google.cloud.compute.v1

Class TCPHealthCheck.Builder

java.lang.Object

com.google.cloud.compute.v1.TCPHealthCheck.Builder

Enclosing class:

TCPHealthCheck

public static class TCPHealthCheck.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
TCPHealthCheck	build()
TCPHealthCheck.Builder	clone()
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	getRequest() The application data to send once the TCP connection has been established (default value is empty).
String	getResponse() The bytes to match against the beginning of the response data.
TCPHealthCheck.Builder	mergeFrom(TCPHealthCheck other)
TCPHealthCheck.Builder	setPort(Integer port) The TCP port number for the health check request.
TCPHealthCheck.Builder	setPortName(String portName) Port name as defined in InstanceGroup#NamedPort#name.
TCPHealthCheck.Builder	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.
TCPHealthCheck.Builder	setProxyHeader(String proxyHeader) Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
TCPHealthCheck.Builder	setRequest(String request) The application data to send once the TCP connection has been established (default value is empty).
TCPHealthCheck.Builder	setResponse(String response) The bytes to match against the beginning of the response data.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

mergeFrom

public TCPHealthCheck.Builder mergeFrom(TCPHealthCheck other)

getPort

public Integer getPort()

The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

setPort

public TCPHealthCheck.Builder setPort(Integer port)

The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

getPortName

public String getPortName()

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

setPortName

public TCPHealthCheck.Builder setPortName(String portName)

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

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, TCP health check follows behavior specified in port and portName fields.

setPortSpecification

public TCPHealthCheck.Builder 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, TCP health check follows behavior specified in port and portName fields.

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.

setProxyHeader

public TCPHealthCheck.Builder 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.

getRequest

public String getRequest()

The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

setRequest

public TCPHealthCheck.Builder setRequest(String request)

The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

getResponse

public String getResponse()

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

setResponse

public TCPHealthCheck.Builder setResponse(String response)

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

build

public TCPHealthCheck build()

clone

public TCPHealthCheck.Builder clone()

Overrides:

clone in class Object