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

Go to download







TCPHealthCheck (Compute Engine API beta-rev20220726-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 TCPHealthCheck



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













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




public final class TCPHealthCheck
extends GenericJson
Model definition for TCPHealthCheck.

  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


TCPHealthCheck() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


TCPHealthCheck
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
set(String fieldName,
   Object value) 


TCPHealthCheck
setPort(Integer port)
The TCP port number for the health check request.



TCPHealthCheck
setPortName(String portName)
Port name as defined in InstanceGroup#NamedPort#name.



TCPHealthCheck
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
setProxyHeader(String proxyHeader)
Specifies the type of proxy header to append before sending data to the backend, either NONE or
 PROXY_V1.



TCPHealthCheck
setRequest(String request)
The application data to send once the TCP connection has been established (default value is
 empty).



TCPHealthCheck
setResponse(String response)
The bytes to match against the beginning of the response data.







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





TCPHealthCheck
public TCPHealthCheck()









Method Detail





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

Returns:
value or null for none








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

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








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.

Returns:
value or null for none








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

Parameters:
request - request or null for none








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.

Returns:
value or null for none








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

Parameters:
response - response or null for none








set
public TCPHealthCheck set(String fieldName,
                          Object value)

Overrides:
set in class GenericJson








clone
public TCPHealthCheck clone()

Overrides:
clone in class 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–2022 Google. All rights reserved.

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