CompositeHealthCheck (Compute Engine API alpha-rev20250415-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class CompositeHealthCheck
extends com.google.api.client.json.GenericJson
```
Represents a composite health check. A composite health check resource specifies the health source resources and the health destination resource to which the aggregated health result from the health source resources is delivered.
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

CompositeHealthCheck()

Constructors
Constructor and Description
`CompositeHealthCheck()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompositeHealthCheck`	`clone()`
`byte[]`	`decodeFingerprint()` Fingerprint of this resource.
`CompositeHealthCheck`	`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.
`String`	`getHealthDestination()` URL to the destination resource.
`List<String>`	`getHealthSources()` URLs to the HealthSource resources whose results are AND'ed.
`BigInteger`	`getId()` [Output Only] A unique identifier for this resource type.
`String`	`getKind()` [Output Only] Type of the resource.
`String`	`getName()` Name of the resource.
`String`	`getRegion()` [Output Only] URL of the region where the composite health check resides.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`String`	`getSelfLinkWithId()` [Output Only] Server-defined URL with id for the resource.
`CompositeHealthCheck`	`set(String fieldName, Object value)`
`CompositeHealthCheck`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`CompositeHealthCheck`	`setDescription(String description)` An optional description of this resource.
`CompositeHealthCheck`	`setFingerprint(String fingerprint)` Fingerprint of this resource.
`CompositeHealthCheck`	`setHealthDestination(String healthDestination)` URL to the destination resource.
`CompositeHealthCheck`	`setHealthSources(List<String> healthSources)` URLs to the HealthSource resources whose results are AND'ed.
`CompositeHealthCheck`	`setId(BigInteger id)` [Output Only] A unique identifier for this resource type.
`CompositeHealthCheck`	`setKind(String kind)` [Output Only] Type of the resource.
`CompositeHealthCheck`	`setName(String name)` Name of the resource.
`CompositeHealthCheck`	`setRegion(String region)` [Output Only] URL of the region where the composite health check resides.
`CompositeHealthCheck`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`CompositeHealthCheck`	`setSelfLinkWithId(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, 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
  - CompositeHealthCheck
```
public CompositeHealthCheck()
```
- Method Detail
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public CompositeHealthCheck 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 CompositeHealthCheck 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 CompositeHealthCheck. An up- to-date fingerprint must be provided in order to patch the CompositeHealthCheck; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the CompositeHealthCheck.
    
    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 CompositeHealthCheck. An up- to-date fingerprint must be provided in order to patch the CompositeHealthCheck; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the CompositeHealthCheck.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getFingerprint()
  - setFingerprint
```
public CompositeHealthCheck 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 CompositeHealthCheck. An up- to-date fingerprint must be provided in order to patch the CompositeHealthCheck; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the CompositeHealthCheck.
    
    Parameters:
    
    fingerprint - fingerprint or null for none
    
    See Also:
    
    #encodeFingerprint()
  - encodeFingerprint
```
public CompositeHealthCheck 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 CompositeHealthCheck. An up- to-date fingerprint must be provided in order to patch the CompositeHealthCheck; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the CompositeHealthCheck.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getHealthDestination
```
public String getHealthDestination()
```
    URL to the destination resource. Must be set. Must be a ForwardingRule. The ForwardingRule must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the CompositeHealthCheck (cross-region deployment for INTERNAL_MANAGED is not supported). Can be mutated.
    
    Returns:
    
    value or null for none
  - setHealthDestination
```
public CompositeHealthCheck setHealthDestination(String healthDestination)
```
    URL to the destination resource. Must be set. Must be a ForwardingRule. The ForwardingRule must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the CompositeHealthCheck (cross-region deployment for INTERNAL_MANAGED is not supported). Can be mutated.
    
    Parameters:
    
    healthDestination - healthDestination or null for none
  - getHealthSources
```
public List<String> getHealthSources()
```
    URLs to the HealthSource resources whose results are AND'ed. I.e. he aggregated result is is HEALTHY only if all sources are HEALTHY. Must have at least 1. Must not have more than 10. Must be regional and in the same region as the CompositeHealthCheck. Can be mutated.
    
    Returns:
    
    value or null for none
  - setHealthSources
```
public CompositeHealthCheck setHealthSources(List<String> healthSources)
```
    URLs to the HealthSource resources whose results are AND'ed. I.e. he aggregated result is is HEALTHY only if all sources are HEALTHY. Must have at least 1. Must not have more than 10. Must be regional and in the same region as the CompositeHealthCheck. Can be mutated.
    
    Parameters:
    
    healthSources - healthSources or null for none
  - getId
```
public BigInteger getId()
```
    [Output Only] A unique identifier for this resource type. The server generates this identifier.
    
    Returns:
    
    value or null for none
  - setId
```
public CompositeHealthCheck setId(BigInteger id)
```
    [Output Only] A unique identifier for this resource type. The server generates this identifier.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#compositeHealthCheck for composite health checks.
    
    Returns:
    
    value or null for none
  - setKind
```
public CompositeHealthCheck setKind(String kind)
```
    [Output Only] Type of the resource. Always compute#compositeHealthCheck for composite 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 CompositeHealthCheck 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
  - getRegion
```
public String getRegion()
```
    [Output Only] URL of the region where the composite health check resides. This field applies only to the regional resource. 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 CompositeHealthCheck setRegion(String region)
```
    [Output Only] URL of the region where the composite health check resides. This field applies only to the regional resource. 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 CompositeHealthCheck setSelfLink(String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getSelfLinkWithId
```
public String getSelfLinkWithId()
```
    [Output Only] Server-defined URL with id for the resource.
    
    Returns:
    
    value or null for none
  - setSelfLinkWithId
```
public CompositeHealthCheck setSelfLinkWithId(String selfLinkWithId)
```
    [Output Only] Server-defined URL with id for the resource.
    
    Parameters:
    
    selfLinkWithId - selfLinkWithId or null for none
  - set
```
public CompositeHealthCheck set(String fieldName,
                                Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public CompositeHealthCheck clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class CompositeHealthCheck

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

CompositeHealthCheck

Method Detail

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getFingerprint

decodeFingerprint

setFingerprint

encodeFingerprint

getHealthDestination

setHealthDestination

getHealthSources

setHealthSources

getId

setId

getKind

setKind

getName

setName

getRegion

setRegion

getSelfLink

setSelfLink

getSelfLinkWithId

setSelfLinkWithId

set

clone