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
Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required
 by target pool-based network load balancers. For all other load balancers, including backend
 service-based network load balancers, and for managed instance group auto-healing, you must use
 modern (non-legacy) health checks. For more information, see Health checks overview .

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


Integer
getCheckIntervalSec()
How often (in seconds) to send a health check.



String
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.



String
getDescription()
An optional description of this resource.



Integer
getHealthyThreshold()
A so-far unhealthy instance will be marked healthy after this many consecutive successes.



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



BigInteger
getId()
[Output Only] The unique identifier for the resource.



String
getKind()
[Output Only] Type of the resource.



String
getName()
Name of the resource.



Integer
getPort()
The TCP port number for the HTTP health check request.



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



String
getSelfLink()
[Output Only] Server-defined URL for the resource.



Integer
getTimeoutSec()
How long (in seconds) to wait before claiming failure.



Integer
getUnhealthyThreshold()
A so-far healthy instance will be marked unhealthy after this many consecutive failures.



HttpHealthCheck
set(String fieldName,
   Object value) 


HttpHealthCheck
setCheckIntervalSec(Integer checkIntervalSec)
How often (in seconds) to send a health check.



HttpHealthCheck
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.



HttpHealthCheck
setDescription(String description)
An optional description of this resource.



HttpHealthCheck
setHealthyThreshold(Integer healthyThreshold)
A so-far unhealthy instance will be marked healthy after this many consecutive successes.



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



HttpHealthCheck
setId(BigInteger id)
[Output Only] The unique identifier for the resource.



HttpHealthCheck
setKind(String kind)
[Output Only] Type of the resource.



HttpHealthCheck
setName(String name)
Name of the resource.



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



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



HttpHealthCheck
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.



HttpHealthCheck
setTimeoutSec(Integer timeoutSec)
How long (in seconds) to wait before claiming failure.



HttpHealthCheck
setUnhealthyThreshold(Integer unhealthyThreshold)
A so-far healthy instance will be marked unhealthy after this many consecutive failures.







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





getCheckIntervalSec
public Integer getCheckIntervalSec()
How often (in seconds) to send a health check. The default value is 5 seconds.

Returns:
value or null for none








setCheckIntervalSec
public HttpHealthCheck setCheckIntervalSec(Integer checkIntervalSec)
How often (in seconds) to send a health check. The default value is 5 seconds.

Parameters:
checkIntervalSec - checkIntervalSec or null for none








getCreationTimestamp
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.

Returns:
value or null for none








setCreationTimestamp
public HttpHealthCheck setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.

Parameters:
creationTimestamp - creationTimestamp or null for none








getDescription
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.

Returns:
value or null for none








setDescription
public HttpHealthCheck setDescription(String description)
An optional description of this resource. Provide this property when you create the resource.

Parameters:
description - description or null for none








getHealthyThreshold
public Integer getHealthyThreshold()
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The
 default value is 2.

Returns:
value or null for none








setHealthyThreshold
public HttpHealthCheck setHealthyThreshold(Integer healthyThreshold)
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The
 default value is 2.

Parameters:
healthyThreshold - healthyThreshold or null for none








getHost
public String getHost()
The value of the host header in the HTTP health check request. If left empty (default value),
 the public 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 public IP on behalf of which this health check is performed will be used.

Parameters:
host - host or null for none








getId
public BigInteger getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:
value or null for none








setId
public HttpHealthCheck setId(BigInteger id)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameters:
id - id or null for none








getKind
public String getKind()
[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.

Returns:
value or null for none








setKind
public HttpHealthCheck setKind(String kind)
[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.

Parameters:
kind - kind or null for none








getName
public String getName()
Name of the resource. Provided by the client when the resource is created. The name must be
 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters
 long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must be a dash, lowercase
 letter, or digit, except the last character, which cannot be a dash.

Returns:
value or null for none








setName
public HttpHealthCheck setName(String name)
Name of the resource. Provided by the client when the resource is created. The name must be
 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters
 long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must be a dash, lowercase
 letter, or digit, except the last character, which cannot be a dash.

Parameters:
name - name or null for none








getPort
public Integer getPort()
The TCP port number for the HTTP health check request. The default value is 80.

Returns:
value or null for none








setPort
public HttpHealthCheck setPort(Integer port)
The TCP port number for the HTTP health check request. The default value is 80.

Parameters:
port - port or null for none








getRequestPath
public String getRequestPath()
The request path of the HTTP health check request. The default value is /. This field does not
 support query parameters. 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 /. This field does not
 support query parameters. Must comply with RFC3986.

Parameters:
requestPath - requestPath or null for none








getSelfLink
public String getSelfLink()
[Output Only] Server-defined URL for the resource.

Returns:
value or null for none








setSelfLink
public HttpHealthCheck setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.

Parameters:
selfLink - selfLink or null for none








getTimeoutSec
public Integer getTimeoutSec()
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is
 invalid for timeoutSec to have greater value than checkIntervalSec.

Returns:
value or null for none








setTimeoutSec
public HttpHealthCheck setTimeoutSec(Integer timeoutSec)
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is
 invalid for timeoutSec to have greater value than checkIntervalSec.

Parameters:
timeoutSec - timeoutSec or null for none








getUnhealthyThreshold
public Integer getUnhealthyThreshold()
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The
 default value is 2.

Returns:
value or null for none








setUnhealthyThreshold
public HttpHealthCheck setUnhealthyThreshold(Integer unhealthyThreshold)
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The
 default value is 2.

Parameters:
unhealthyThreshold - unhealthyThreshold 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()`
`Integer`	`getCheckIntervalSec()` How often (in seconds) to send a health check.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`Integer`	`getHealthyThreshold()` A so-far unhealthy instance will be marked healthy after this many consecutive successes.
`String`	`getHost()` The value of the host header in the HTTP health check request.
`BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getKind()` [Output Only] Type of the resource.
`String`	`getName()` Name of the resource.
`Integer`	`getPort()` The TCP port number for the HTTP health check request.
`String`	`getRequestPath()` The request path of the HTTP health check request.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`Integer`	`getTimeoutSec()` How long (in seconds) to wait before claiming failure.
`Integer`	`getUnhealthyThreshold()` A so-far healthy instance will be marked unhealthy after this many consecutive failures.
`HttpHealthCheck`	`set(String fieldName, Object value)`
`HttpHealthCheck`	`setCheckIntervalSec(Integer checkIntervalSec)` How often (in seconds) to send a health check.
`HttpHealthCheck`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`HttpHealthCheck`	`setDescription(String description)` An optional description of this resource.
`HttpHealthCheck`	`setHealthyThreshold(Integer healthyThreshold)` A so-far unhealthy instance will be marked healthy after this many consecutive successes.
`HttpHealthCheck`	`setHost(String host)` The value of the host header in the HTTP health check request.
`HttpHealthCheck`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource.
`HttpHealthCheck`	`setKind(String kind)` [Output Only] Type of the resource.
`HttpHealthCheck`	`setName(String name)` Name of the resource.
`HttpHealthCheck`	`setPort(Integer port)` The TCP port number for the HTTP health check request.
`HttpHealthCheck`	`setRequestPath(String requestPath)` The request path of the HTTP health check request.
`HttpHealthCheck`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`HttpHealthCheck`	`setTimeoutSec(Integer timeoutSec)` How long (in seconds) to wait before claiming failure.
`HttpHealthCheck`	`setUnhealthyThreshold(Integer unhealthyThreshold)` A so-far healthy instance will be marked unhealthy after this many consecutive failures.