• Home
• com.google.apis
• google-api-services-compute
• beta-rev20220726-2.0.0
• source code
• HealthCheckService.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

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 HealthCheckService



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













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




public final class HealthCheckService
extends GenericJson
Represents a Health-Check as a Service resource.

 
 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


HealthCheckService() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


HealthCheckService
clone() 


byte[]
decodeFingerprint()
Fingerprint of this resource.



HealthCheckService
encodeFingerprint(byte[] fingerprint)
Fingerprint of this resource.



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



String
getDescription()
An optional description of this resource.



String
getFingerprint()
Fingerprint of this resource.



List<String>
getHealthChecks()
A list of URLs to the HealthCheck resources.



String
getHealthStatusAggregationPolicy()
Optional.



String
getHealthStatusAggregationStrategy()
This field is deprecated.



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



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



String
getName()
Name of the resource.



List<String>
getNetworkEndpointGroups()
A list of URLs to the NetworkEndpointGroup resources.



List<String>
getNotificationEndpoints()
A list of URLs to the NotificationEndpoint resources.



String
getRegion()
[Output Only] URL of the region where the health check service resides.



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



HealthCheckService
set(String fieldName,
   Object value) 


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



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



HealthCheckService
setFingerprint(String fingerprint)
Fingerprint of this resource.



HealthCheckService
setHealthChecks(List<String> healthChecks)
A list of URLs to the HealthCheck resources.



HealthCheckService
setHealthStatusAggregationPolicy(String healthStatusAggregationPolicy)
Optional.



HealthCheckService
setHealthStatusAggregationStrategy(String healthStatusAggregationStrategy)
This field is deprecated.



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



HealthCheckService
setKind(String kind)
[Output only] Type of the resource.



HealthCheckService
setName(String name)
Name of the resource.



HealthCheckService
setNetworkEndpointGroups(List<String> networkEndpointGroups)
A list of URLs to the NetworkEndpointGroup resources.



HealthCheckService
setNotificationEndpoints(List<String> notificationEndpoints)
A list of URLs to the NotificationEndpoint resources.



HealthCheckService
setRegion(String region)
[Output Only] URL of the region where the health check service resides.



HealthCheckService
setSelfLink(String selfLink)
[Output Only] Server-defined URL 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, 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





HealthCheckService
public HealthCheckService()









Method Detail





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

Returns:
value or null for none








setCreationTimestamp
public HealthCheckService 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 HealthCheckService setDescription(String description)
An optional description of this resource. Provide this property when you create the resource.

Parameters:
description - description or null for none








getFingerprint
public String getFingerprint()
Fingerprint of this resource. A hash of the contents stored in this object. This field is used
 in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-
 to-date fingerprint must be provided in order to patch/update the HealthCheckService;
 Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint,
 make a get() request to retrieve the HealthCheckService.

Returns:
value or null for none
See Also:
decodeFingerprint()








decodeFingerprint
public byte[] decodeFingerprint()
Fingerprint of this resource. A hash of the contents stored in this object. This field is used
 in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-
 to-date fingerprint must be provided in order to patch/update the HealthCheckService;
 Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint,
 make a get() request to retrieve the HealthCheckService.

Returns:
Base64 decoded value or null for none
Since:
1.14
See Also:
getFingerprint()








setFingerprint
public HealthCheckService setFingerprint(String fingerprint)
Fingerprint of this resource. A hash of the contents stored in this object. This field is used
 in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-
 to-date fingerprint must be provided in order to patch/update the HealthCheckService;
 Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint,
 make a get() request to retrieve the HealthCheckService.

Parameters:
fingerprint - fingerprint or null for none
See Also:
#encodeFingerprint()








encodeFingerprint
public HealthCheckService encodeFingerprint(byte[] fingerprint)
Fingerprint of this resource. A hash of the contents stored in this object. This field is used
 in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-
 to-date fingerprint must be provided in order to patch/update the HealthCheckService;
 Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint,
 make a get() request to retrieve the HealthCheckService.

Since:
1.14
See Also:

 The value is encoded Base64 or {@code null} for none.
 








getHealthChecks
public List<String> getHealthChecks()
A 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 or
 portSpecification=USE_FIXED_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 must belong to the same region as zones of
 NEGs.

Returns:
value or null for none








setHealthChecks
public HealthCheckService setHealthChecks(List<String> healthChecks)
A 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 or
 portSpecification=USE_FIXED_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 must belong to the same region as zones of
 NEGs.

Parameters:
healthChecks - healthChecks or null for none








getHealthStatusAggregationPolicy
public String getHealthStatusAggregationPolicy()
Optional. Policy for how the results from multiple health checks for the same endpoint are
 aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth
 message is returned for each pair in the health check service. - AND. If any health check of an
 endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health
 checks report HEALTHY, the HealthState of the endpoint is HEALTHY. .

Returns:
value or null for none








setHealthStatusAggregationPolicy
public HealthCheckService setHealthStatusAggregationPolicy(String healthStatusAggregationPolicy)
Optional. Policy for how the results from multiple health checks for the same endpoint are
 aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth
 message is returned for each pair in the health check service. - AND. If any health check of an
 endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health
 checks report HEALTHY, the HealthState of the endpoint is HEALTHY. .

Parameters:
healthStatusAggregationPolicy - healthStatusAggregationPolicy or null for none








getHealthStatusAggregationStrategy
public String getHealthStatusAggregationStrategy()
This field is deprecated. Use health_status_aggregation_policy instead. 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(String healthStatusAggregationStrategy)
This field is deprecated. Use health_status_aggregation_policy instead. 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 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(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#healthCheckServicefor health check services.

Returns:
value or null for none








setKind
public HealthCheckService setKind(String kind)
[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.

Parameters:
kind - kind or null for none








getName
public 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(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 List<String> getNetworkEndpointGroups()
A 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(List<String> networkEndpointGroups)
A 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 List<String> getNotificationEndpoints()
A 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(List<String> notificationEndpoints)
A 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 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(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 String getSelfLink()
[Output Only] Server-defined URL for the resource.

Returns:
value or null for none








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

Parameters:
selfLink - selfLink or null for none








set
public HealthCheckService set(String fieldName,
                              Object value)

Overrides:
set in class GenericJson








clone
public HealthCheckService 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.