HttpsHealthCheck (Compute Engine API beta (Rev. 138) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.HttpsHealthCheck

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class HttpsHealthCheck
extends com.google.api.client.json.GenericJson
```
Represents a legacy HTTPS Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.
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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

HttpsHealthCheck()

Constructors
Constructor and Description
`HttpsHealthCheck()`

Method Summary

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

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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
  - HttpsHealthCheck
```
public HttpsHealthCheck()
```
- Method Detail
  - getCheckIntervalSec
```
public java.lang.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 HttpsHealthCheck setCheckIntervalSec(java.lang.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 java.lang.String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public HttpsHealthCheck setCreationTimestamp(java.lang.String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getDescription
```
public java.lang.String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public HttpsHealthCheck setDescription(java.lang.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 java.lang.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 HttpsHealthCheck setHealthyThreshold(java.lang.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 java.lang.String getHost()
```
    The value of the host header in the HTTPS 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 HttpsHealthCheck setHost(java.lang.String host)
```
    The value of the host header in the HTTPS 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 java.math.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 HttpsHealthCheck setId(java.math.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 java.lang.String getKind()
```
    Type of the resource.
    
    Returns:
    
    value or null for none
  - setKind
```
public HttpsHealthCheck setKind(java.lang.String kind)
```
    Type of the resource.
    
    Parameters:
    
    kind - kind or null for none
  - getName
```
public java.lang.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 HttpsHealthCheck setName(java.lang.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 java.lang.Integer getPort()
```
    The TCP port number for the HTTPS health check request. The default value is 443.
    
    Returns:
    
    value or null for none
  - setPort
```
public HttpsHealthCheck setPort(java.lang.Integer port)
```
    The TCP port number for the HTTPS health check request. The default value is 443.
    
    Parameters:
    
    port - port or null for none
  - getRequestPath
```
public java.lang.String getRequestPath()
```
    The request path of the HTTPS health check request. The default value is "/".
    
    Returns:
    
    value or null for none
  - setRequestPath
```
public HttpsHealthCheck setRequestPath(java.lang.String requestPath)
```
    The request path of the HTTPS health check request. The default value is "/".
    
    Parameters:
    
    requestPath - requestPath or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public HttpsHealthCheck setSelfLink(java.lang.String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getTimeoutSec
```
public java.lang.Integer getTimeoutSec()
```
    How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
    
    Returns:
    
    value or null for none
  - setTimeoutSec
```
public HttpsHealthCheck setTimeoutSec(java.lang.Integer timeoutSec)
```
    How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
    
    Parameters:
    
    timeoutSec - timeoutSec or null for none
  - getUnhealthyThreshold
```
public java.lang.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 HttpsHealthCheck setUnhealthyThreshold(java.lang.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 HttpsHealthCheck set(java.lang.String fieldName,
                            java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public HttpsHealthCheck clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API beta (revision 138)

Class HttpsHealthCheck

Nested Class Summary

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

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

HttpsHealthCheck

Method Detail

getCheckIntervalSec

setCheckIntervalSec

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getHealthyThreshold

setHealthyThreshold

getHost

setHost

getId

setId

getKind

setKind

getName

setName

getPort

setPort

getRequestPath

setRequestPath

getSelfLink

setSelfLink

getTimeoutSec

setTimeoutSec

getUnhealthyThreshold

setUnhealthyThreshold

set

clone