target.apidocs.com.google.api.services.compute.model.BackendServiceHAPolicy.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!






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



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













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




public final class BackendServiceHAPolicy
extends com.google.api.client.json.GenericJson
Model definition for BackendServiceHAPolicy.

  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


BackendServiceHAPolicy() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BackendServiceHAPolicy
clone() 


String
getFastIPMove()
Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it.



BackendServiceHAPolicy
set(String fieldName,
   Object value) 


BackendServiceHAPolicy
setFastIPMove(String fastIPMove)
Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it.







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





BackendServiceHAPolicy
public BackendServiceHAPolicy()









Method Detail





getFastIPMove
public String getFastIPMove()
Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it. Supported
 values are: - DISABLED: Fast IP Move is disabled. You can only use the haPolicy.leader API to
 update the leader. - >GARP_RA: Provides a method to very quickly define a new network endpoint
 as the leader. This method is faster than updating the leader using the haPolicy.leader API.
 Fast IP move works as follows: The VM hosting the network endpoint that should become the new
 leader sends either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router Advertisement(RA)
 packet (IPv6). Google Cloud immediately but temporarily associates the forwarding rule IP
 address with that VM, and both new and in-flight packets are quickly delivered to that VM. Note
 the important properties of the Fast IP Move functionality: - The GARP/RA-initiated re-routing
 stays active for approximately 20 minutes. After triggering fast failover, you must also
 appropriately set the haPolicy.leader. - The new leader instance should continue to send
 GARP/RA packets periodically every 10 seconds until at least 10 minutes after updating the
 haPolicy.leader (but stop immediately if it is no longer the leader). - After triggering a fast
 failover, we recommend that you wait at least 3 seconds before sending another GARP/RA packet
 from a different VM instance to avoid race conditions. - Don't send GARP/RA packets from
 different VM instances at the same time. If multiple instances continue to send GARP/RA
 packets, traffic might be routed to different destinations in an alternating order. This
 condition ceases when a single instance issues a GARP/RA packet. - The GARP/RA request always
 takes priority over the leader API. Using the haPolicy.leader API to change the leader to a
 different instance will have no effect until the GARP/RA request becomes inactive. - The
 GARP/RA packets should follow the GARP/RA Packet Specifications.. - When multiple forwarding
 rules refer to a regional backend service, you need only send a GARP or RA packet for a single
 forwarding rule virtual IP. The virtual IPs for all forwarding rules targeting the same backend
 service will also be moved to the sender of the GARP or RA packet. The following are the Fast
 IP Move limitations (that is, when fastIPMove is not DISABLED): - Multiple forwarding rules
 cannot use the same IP address if one of them refers to a regional backend service with
 fastIPMove. - The regional backend service must set the network field, and all NEGs must belong
 to that network. However, individual NEGs can belong to different subnetworks of that network.
 - The maximum number of network endpoints across all backends of a backend service with
 fastIPMove is 64. - The maximum number of backend services with fastIPMove that can have the
 same network endpoint attached to one of its backends is 64. - The maximum number of backend
 services with fastIPMove in a VPC in a region is 64. - The network endpoints that are attached
 to a backend of a backend service with fastIPMove cannot resolve to C3 machines. - Traffic
 directed to the leader by a static route next hop will not be redirected to a new leader by
 fast failover. Such traffic will only be redirected once an haPolicy.leader update has taken
 effect. Only traffic to the forwarding rule's virtual IP will be redirected to a new leader by
 fast failover. haPolicy.fastIPMove can be set only at backend service creation time. Once set,
 it cannot be updated. By default, fastIpMove is set to DISABLED.

Returns:
value or null for none








setFastIPMove
public BackendServiceHAPolicy setFastIPMove(String fastIPMove)
Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it. Supported
 values are: - DISABLED: Fast IP Move is disabled. You can only use the haPolicy.leader API to
 update the leader. - >GARP_RA: Provides a method to very quickly define a new network endpoint
 as the leader. This method is faster than updating the leader using the haPolicy.leader API.
 Fast IP move works as follows: The VM hosting the network endpoint that should become the new
 leader sends either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router Advertisement(RA)
 packet (IPv6). Google Cloud immediately but temporarily associates the forwarding rule IP
 address with that VM, and both new and in-flight packets are quickly delivered to that VM. Note
 the important properties of the Fast IP Move functionality: - The GARP/RA-initiated re-routing
 stays active for approximately 20 minutes. After triggering fast failover, you must also
 appropriately set the haPolicy.leader. - The new leader instance should continue to send
 GARP/RA packets periodically every 10 seconds until at least 10 minutes after updating the
 haPolicy.leader (but stop immediately if it is no longer the leader). - After triggering a fast
 failover, we recommend that you wait at least 3 seconds before sending another GARP/RA packet
 from a different VM instance to avoid race conditions. - Don't send GARP/RA packets from
 different VM instances at the same time. If multiple instances continue to send GARP/RA
 packets, traffic might be routed to different destinations in an alternating order. This
 condition ceases when a single instance issues a GARP/RA packet. - The GARP/RA request always
 takes priority over the leader API. Using the haPolicy.leader API to change the leader to a
 different instance will have no effect until the GARP/RA request becomes inactive. - The
 GARP/RA packets should follow the GARP/RA Packet Specifications.. - When multiple forwarding
 rules refer to a regional backend service, you need only send a GARP or RA packet for a single
 forwarding rule virtual IP. The virtual IPs for all forwarding rules targeting the same backend
 service will also be moved to the sender of the GARP or RA packet. The following are the Fast
 IP Move limitations (that is, when fastIPMove is not DISABLED): - Multiple forwarding rules
 cannot use the same IP address if one of them refers to a regional backend service with
 fastIPMove. - The regional backend service must set the network field, and all NEGs must belong
 to that network. However, individual NEGs can belong to different subnetworks of that network.
 - The maximum number of network endpoints across all backends of a backend service with
 fastIPMove is 64. - The maximum number of backend services with fastIPMove that can have the
 same network endpoint attached to one of its backends is 64. - The maximum number of backend
 services with fastIPMove in a VPC in a region is 64. - The network endpoints that are attached
 to a backend of a backend service with fastIPMove cannot resolve to C3 machines. - Traffic
 directed to the leader by a static route next hop will not be redirected to a new leader by
 fast failover. Such traffic will only be redirected once an haPolicy.leader update has taken
 effect. Only traffic to the forwarding rule's virtual IP will be redirected to a new leader by
 fast failover. haPolicy.fastIPMove can be set only at backend service creation time. Once set,
 it cannot be updated. By default, fastIpMove is set to DISABLED.

Parameters:
fastIPMove - fastIPMove or null for none








set
public BackendServiceHAPolicy set(String fieldName,
                                  Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public BackendServiceHAPolicy 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
`BackendServiceHAPolicy`	`clone()`
`String`	`getFastIPMove()` Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it.
`BackendServiceHAPolicy`	`set(String fieldName, Object value)`
`BackendServiceHAPolicy`	`setFastIPMove(String fastIPMove)` Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it.