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

Go to download







RouterBgpPeerBfd (Compute Engine API alpha-rev20200526-1.30.9)











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 RouterBgpPeerBfd



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













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




public final class RouterBgpPeerBfd
extends GenericJson
Model definition for RouterBgpPeerBfd.

  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


RouterBgpPeerBfd() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


RouterBgpPeerBfd
clone() 


Long
getMinReceiveInterval()
The minimum interval, in milliseconds, between BFD control packets received from the peer
 router.



Long
getMinTransmitInterval()
The minimum interval, in milliseconds, between BFD control packets transmitted to the peer
 router.



String
getMode()
The BFD session initialization mode for this BGP peer.



Long
getMultiplier()
The number of consecutive BFD packets that must be missed before BFD declares that a peer is
 unavailable.



String
getPacketMode()
The BFD packet mode for this BGP peer.



String
getSessionInitializationMode()
The BFD session initialization mode for this BGP peer.



Long
getSlowTimerInterval()
The minimum interval, in milliseconds, between BFD control packets transmitted to and received
 from the peer router when BFD echo mode is enabled on both routers.



RouterBgpPeerBfd
set(String fieldName,
   Object value) 


RouterBgpPeerBfd
setMinReceiveInterval(Long minReceiveInterval)
The minimum interval, in milliseconds, between BFD control packets received from the peer
 router.



RouterBgpPeerBfd
setMinTransmitInterval(Long minTransmitInterval)
The minimum interval, in milliseconds, between BFD control packets transmitted to the peer
 router.



RouterBgpPeerBfd
setMode(String mode)
The BFD session initialization mode for this BGP peer.



RouterBgpPeerBfd
setMultiplier(Long multiplier)
The number of consecutive BFD packets that must be missed before BFD declares that a peer is
 unavailable.



RouterBgpPeerBfd
setPacketMode(String packetMode)
The BFD packet mode for this BGP peer.



RouterBgpPeerBfd
setSessionInitializationMode(String sessionInitializationMode)
The BFD session initialization mode for this BGP peer.



RouterBgpPeerBfd
setSlowTimerInterval(Long slowTimerInterval)
The minimum interval, in milliseconds, between BFD control packets transmitted to and received
 from the peer router when BFD echo mode is enabled on both routers.







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





RouterBgpPeerBfd
public RouterBgpPeerBfd()









Method Detail





getMinReceiveInterval
public Long getMinReceiveInterval()
The minimum interval, in milliseconds, between BFD control packets received from the peer
 router. The actual value is negotiated between the two routers and is equal to the greater of
 this value and the transmit interval of the other router. Not currently available publicly. If
 set, this value must be between 100 and 30000. The default is 300.

Returns:
value or null for none








setMinReceiveInterval
public RouterBgpPeerBfd setMinReceiveInterval(Long minReceiveInterval)
The minimum interval, in milliseconds, between BFD control packets received from the peer
 router. The actual value is negotiated between the two routers and is equal to the greater of
 this value and the transmit interval of the other router. Not currently available publicly. If
 set, this value must be between 100 and 30000. The default is 300.

Parameters:
minReceiveInterval - minReceiveInterval or null for none








getMinTransmitInterval
public Long getMinTransmitInterval()
The minimum interval, in milliseconds, between BFD control packets transmitted to the peer
 router. The actual value is negotiated between the two routers and is equal to the greater of
 this value and the corresponding receive interval of the other router. Not currently available
 publicly. If set, this value must be between 100 and 30000. The default is 300.

Returns:
value or null for none








setMinTransmitInterval
public RouterBgpPeerBfd setMinTransmitInterval(Long minTransmitInterval)
The minimum interval, in milliseconds, between BFD control packets transmitted to the peer
 router. The actual value is negotiated between the two routers and is equal to the greater of
 this value and the corresponding receive interval of the other router. Not currently available
 publicly. If set, this value must be between 100 and 30000. The default is 300.

Parameters:
minTransmitInterval - minTransmitInterval or null for none








getMode
public String getMode()
The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will
 initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for
 the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is
 disabled for this BGP peer. The default is PASSIVE.

Returns:
value or null for none








setMode
public RouterBgpPeerBfd setMode(String mode)
The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will
 initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for
 the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is
 disabled for this BGP peer. The default is PASSIVE.

Parameters:
mode - mode or null for none








getMultiplier
public Long getMultiplier()
The number of consecutive BFD packets that must be missed before BFD declares that a peer is
 unavailable. Not currently available publicly. If set, the value must be a value between 2 and
 16. The default is 3.

Returns:
value or null for none








setMultiplier
public RouterBgpPeerBfd setMultiplier(Long multiplier)
The number of consecutive BFD packets that must be missed before BFD declares that a peer is
 unavailable. Not currently available publicly. If set, the value must be a value between 2 and
 16. The default is 3.

Parameters:
multiplier - multiplier or null for none








getPacketMode
public String getPacketMode()
The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for
 this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo
 packets will be sent to the other router. If the peer router does not have BFD echo mode
 enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled
 for this BGP peer. If this router and the peer router have a multihop connection, this should
 be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default
 is CONTROL_AND_ECHO.

Returns:
value or null for none








setPacketMode
public RouterBgpPeerBfd setPacketMode(String packetMode)
The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for
 this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo
 packets will be sent to the other router. If the peer router does not have BFD echo mode
 enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled
 for this BGP peer. If this router and the peer router have a multihop connection, this should
 be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default
 is CONTROL_AND_ECHO.

Parameters:
packetMode - packetMode or null for none








getSessionInitializationMode
public String getSessionInitializationMode()
The BFD session initialization mode for this BGP peer. Not currently available publicly. If set
 to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE,
 the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer.
 If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Returns:
value or null for none








setSessionInitializationMode
public RouterBgpPeerBfd setSessionInitializationMode(String sessionInitializationMode)
The BFD session initialization mode for this BGP peer. Not currently available publicly. If set
 to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE,
 the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer.
 If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Parameters:
sessionInitializationMode - sessionInitializationMode or null for none








getSlowTimerInterval
public Long getSlowTimerInterval()
The minimum interval, in milliseconds, between BFD control packets transmitted to and received
 from the peer router when BFD echo mode is enabled on both routers. The actual transmit and
 receive intervals are negotiated between the two routers and are equal to the greater of this
 value and the corresponding interval on the other router. If set, this value must be between
 1000 and 30000. The default is 5000.

Returns:
value or null for none








setSlowTimerInterval
public RouterBgpPeerBfd setSlowTimerInterval(Long slowTimerInterval)
The minimum interval, in milliseconds, between BFD control packets transmitted to and received
 from the peer router when BFD echo mode is enabled on both routers. The actual transmit and
 receive intervals are negotiated between the two routers and are equal to the greater of this
 value and the corresponding interval on the other router. If set, this value must be between
 1000 and 30000. The default is 5000.

Parameters:
slowTimerInterval - slowTimerInterval or null for none








set
public RouterBgpPeerBfd set(String fieldName,
                            Object value)

Overrides:
set in class GenericJson








clone
public RouterBgpPeerBfd 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–2020 Google. All rights reserved.

Modifier and Type	Method and Description
`RouterBgpPeerBfd`	`clone()`
`Long`	`getMinReceiveInterval()` The minimum interval, in milliseconds, between BFD control packets received from the peer router.
`Long`	`getMinTransmitInterval()` The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router.
`String`	`getMode()` The BFD session initialization mode for this BGP peer.
`Long`	`getMultiplier()` The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.
`String`	`getPacketMode()` The BFD packet mode for this BGP peer.
`String`	`getSessionInitializationMode()` The BFD session initialization mode for this BGP peer.
`Long`	`getSlowTimerInterval()` The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers.
`RouterBgpPeerBfd`	`set(String fieldName, Object value)`
`RouterBgpPeerBfd`	`setMinReceiveInterval(Long minReceiveInterval)` The minimum interval, in milliseconds, between BFD control packets received from the peer router.
`RouterBgpPeerBfd`	`setMinTransmitInterval(Long minTransmitInterval)` The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router.
`RouterBgpPeerBfd`	`setMode(String mode)` The BFD session initialization mode for this BGP peer.
`RouterBgpPeerBfd`	`setMultiplier(Long multiplier)` The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.
`RouterBgpPeerBfd`	`setPacketMode(String packetMode)` The BFD packet mode for this BGP peer.
`RouterBgpPeerBfd`	`setSessionInitializationMode(String sessionInitializationMode)` The BFD session initialization mode for this BGP peer.
`RouterBgpPeerBfd`	`setSlowTimerInterval(Long slowTimerInterval)` The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers.