HealthCheckService (Compute Engine API alpha (Rev. 106) 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.HealthCheckService

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class HealthCheckService
extends com.google.api.client.json.GenericJson
```
A HealthCheckService defines a set of backends on which to perform periodic health checks and an endpoint to which to send notification of changes in the health status of the backends.
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

HealthCheckService()

Constructors
Constructor and Description
`HealthCheckService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HealthCheckService`	`clone()`
`java.lang.String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`java.lang.String`	`getDescription()` An optional description of this resource.
`java.util.List<java.lang.String>`	`getHealthChecks()` List of URLs to the HealthCheck resources.
`java.lang.String`	`getHealthStatusAggregationStrategy()` Policy for how the results from multiple health checks for the same endpoint are aggregated.
`java.math.BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`java.lang.String`	`getKind()` [Output only] Type of the resource.
`java.lang.String`	`getName()` Name of the resource.
`java.util.List<java.lang.String>`	`getNetworkEndpointGroups()` List of URLs to the NetworkEndpointGroup resources.
`java.util.List<java.lang.String>`	`getNotificationEndpoints()` List of URLs to the NotificationEndpoint resources.
`java.lang.String`	`getRegion()` [Output Only] URL of the region where the health check service resides.
`java.lang.String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`java.lang.String`	`getSelfLinkWithId()` [Output Only] Server-defined URL with id for the resource.
`HealthCheckService`	`set(java.lang.String fieldName, java.lang.Object value)`
`HealthCheckService`	`setCreationTimestamp(java.lang.String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`HealthCheckService`	`setDescription(java.lang.String description)` An optional description of this resource.
`HealthCheckService`	`setHealthChecks(java.util.List<java.lang.String> healthChecks)` List of URLs to the HealthCheck resources.
`HealthCheckService`	`setHealthStatusAggregationStrategy(java.lang.String healthStatusAggregationStrategy)` Policy for how the results from multiple health checks for the same endpoint are aggregated.
`HealthCheckService`	`setId(java.math.BigInteger id)` [Output Only] The unique identifier for the resource.
`HealthCheckService`	`setKind(java.lang.String kind)` [Output only] Type of the resource.
`HealthCheckService`	`setName(java.lang.String name)` Name of the resource.
`HealthCheckService`	`setNetworkEndpointGroups(java.util.List<java.lang.String> networkEndpointGroups)` List of URLs to the NetworkEndpointGroup resources.
`HealthCheckService`	`setNotificationEndpoints(java.util.List<java.lang.String> notificationEndpoints)` List of URLs to the NotificationEndpoint resources.
`HealthCheckService`	`setRegion(java.lang.String region)` [Output Only] URL of the region where the health check service resides.
`HealthCheckService`	`setSelfLink(java.lang.String selfLink)` [Output Only] Server-defined URL for the resource.
`HealthCheckService`	`setSelfLinkWithId(java.lang.String selfLinkWithId)` [Output Only] Server-defined URL with id for the resource.

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
  - HealthCheckService
```
public HealthCheckService()
```
- Method Detail
  - getCreationTimestamp
```
public java.lang.String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public HealthCheckService 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 HealthCheckService 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
  - getHealthChecks
```
public java.util.List<java.lang.String> getHealthChecks()
```
    List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks
    
    Returns:
    
    value or null for none
  - setHealthChecks
```
public HealthCheckService setHealthChecks(java.util.List<java.lang.String> healthChecks)
```
    List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks
    
    Parameters:
    
    healthChecks - healthChecks or null for none
  - getHealthStatusAggregationStrategy
```
public java.lang.String getHealthStatusAggregationStrategy()
```
    Policy for how the results from multiple health checks for the same endpoint are aggregated. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .
    
    Returns:
    
    value or null for none
  - setHealthStatusAggregationStrategy
```
public HealthCheckService setHealthStatusAggregationStrategy(java.lang.String healthStatusAggregationStrategy)
```
    Policy for how the results from multiple health checks for the same endpoint are aggregated. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .
    
    Parameters:
    
    healthStatusAggregationStrategy - healthStatusAggregationStrategy 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 HealthCheckService 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()
```
    [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
    
    Returns:
    
    value or null for none
  - setKind
```
public HealthCheckService setKind(java.lang.String kind)
```
    [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
    
    Parameters:
    
    kind - kind or null for none
  - getName
```
public java.lang.String getName()
```
    Name of the resource. 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 HealthCheckService setName(java.lang.String name)
```
    Name of the resource. 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
  - getNetworkEndpointGroups
```
public java.util.List<java.lang.String> getNetworkEndpointGroups()
```
    List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.
    
    Returns:
    
    value or null for none
  - setNetworkEndpointGroups
```
public HealthCheckService setNetworkEndpointGroups(java.util.List<java.lang.String> networkEndpointGroups)
```
    List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.
    
    Parameters:
    
    networkEndpointGroups - networkEndpointGroups or null for none
  - getNotificationEndpoints
```
public java.util.List<java.lang.String> getNotificationEndpoints()
```
    List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
    
    Returns:
    
    value or null for none
  - setNotificationEndpoints
```
public HealthCheckService setNotificationEndpoints(java.util.List<java.lang.String> notificationEndpoints)
```
    List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
    
    Parameters:
    
    notificationEndpoints - notificationEndpoints or null for none
  - getRegion
```
public java.lang.String getRegion()
```
    [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    
    Returns:
    
    value or null for none
  - setRegion
```
public HealthCheckService setRegion(java.lang.String region)
```
    [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    
    Parameters:
    
    region - region 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 HealthCheckService setSelfLink(java.lang.String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getSelfLinkWithId
```
public java.lang.String getSelfLinkWithId()
```
    [Output Only] Server-defined URL with id for the resource.
    
    Returns:
    
    value or null for none
  - setSelfLinkWithId
```
public HealthCheckService setSelfLinkWithId(java.lang.String selfLinkWithId)
```
    [Output Only] Server-defined URL with id for the resource.
    
    Parameters:
    
    selfLinkWithId - selfLinkWithId or null for none
  - set
```
public HealthCheckService set(java.lang.String fieldName,
                              java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public HealthCheckService clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API alpha (revision 106)

Class HealthCheckService

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

HealthCheckService

Method Detail

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getHealthChecks

setHealthChecks

getHealthStatusAggregationStrategy

setHealthStatusAggregationStrategy

getId

setId

getKind

setKind

getName

setName

getNetworkEndpointGroups

setNetworkEndpointGroups

getNotificationEndpoints

setNotificationEndpoints

getRegion

setRegion

getSelfLink

setSelfLink

getSelfLinkWithId

setSelfLinkWithId

set

clone