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

Go to download







RouterBgpPeer (Compute Engine API beta-rev20220726-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 RouterBgpPeer



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













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




public final class RouterBgpPeer
extends GenericJson
Model definition for RouterBgpPeer.

  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


RouterBgpPeer() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


RouterBgpPeer
clone() 


List<String>
getAdvertisedGroups()
User-specified list of prefix groups to advertise in custom mode, which can take one of the
 following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.



List<RouterAdvertisedIpRange>
getAdvertisedIpRanges()
User-specified list of individual IP ranges to advertise in custom mode.



Long
getAdvertisedRoutePriority()
The priority of routes advertised to this BGP peer.



String
getAdvertiseMode()
User-specified flag to indicate which mode to use for advertisement.



RouterBgpPeerBfd
getBfd()
BFD configuration for the BGP peering.



String
getEnable()
The status of the BGP peer connection.



Boolean
getEnableIpv6()
Enable IPv6 traffic over BGP Peer.



String
getInterfaceName()
Name of the interface the BGP peer is associated with.



String
getIpAddress()
IP address of the interface inside Google Cloud Platform.



String
getIpv6NexthopAddress()
IPv6 address of the interface inside Google Cloud Platform.



String
getManagementType()
[Output Only] The resource that configures and manages this BGP peer.



String
getMd5AuthenticationKeyName()
Present if MD5 authentication is enabled for the peering.



String
getName()
Name of this BGP peer.



Long
getPeerAsn()
Peer BGP Autonomous System Number (ASN).



String
getPeerIpAddress()
IP address of the BGP interface outside Google Cloud Platform.



String
getPeerIpv6NexthopAddress()
IPv6 address of the BGP interface outside Google Cloud Platform.



String
getRouterApplianceInstance()
URI of the VM instance that is used as third-party router appliances such as Next Gen
 Firewalls, Virtual Routers, or Router Appliances.



RouterBgpPeer
set(String fieldName,
   Object value) 


RouterBgpPeer
setAdvertisedGroups(List<String> advertisedGroups)
User-specified list of prefix groups to advertise in custom mode, which can take one of the
 following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.



RouterBgpPeer
setAdvertisedIpRanges(List<RouterAdvertisedIpRange> advertisedIpRanges)
User-specified list of individual IP ranges to advertise in custom mode.



RouterBgpPeer
setAdvertisedRoutePriority(Long advertisedRoutePriority)
The priority of routes advertised to this BGP peer.



RouterBgpPeer
setAdvertiseMode(String advertiseMode)
User-specified flag to indicate which mode to use for advertisement.



RouterBgpPeer
setBfd(RouterBgpPeerBfd bfd)
BFD configuration for the BGP peering.



RouterBgpPeer
setEnable(String enable)
The status of the BGP peer connection.



RouterBgpPeer
setEnableIpv6(Boolean enableIpv6)
Enable IPv6 traffic over BGP Peer.



RouterBgpPeer
setInterfaceName(String interfaceName)
Name of the interface the BGP peer is associated with.



RouterBgpPeer
setIpAddress(String ipAddress)
IP address of the interface inside Google Cloud Platform.



RouterBgpPeer
setIpv6NexthopAddress(String ipv6NexthopAddress)
IPv6 address of the interface inside Google Cloud Platform.



RouterBgpPeer
setManagementType(String managementType)
[Output Only] The resource that configures and manages this BGP peer.



RouterBgpPeer
setMd5AuthenticationKeyName(String md5AuthenticationKeyName)
Present if MD5 authentication is enabled for the peering.



RouterBgpPeer
setName(String name)
Name of this BGP peer.



RouterBgpPeer
setPeerAsn(Long peerAsn)
Peer BGP Autonomous System Number (ASN).



RouterBgpPeer
setPeerIpAddress(String peerIpAddress)
IP address of the BGP interface outside Google Cloud Platform.



RouterBgpPeer
setPeerIpv6NexthopAddress(String peerIpv6NexthopAddress)
IPv6 address of the BGP interface outside Google Cloud Platform.



RouterBgpPeer
setRouterApplianceInstance(String routerApplianceInstance)
URI of the VM instance that is used as third-party router appliances such as Next Gen
 Firewalls, Virtual Routers, or Router Appliances.







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





RouterBgpPeer
public RouterBgpPeer()









Method Detail





getAdvertiseMode
public String getAdvertiseMode()
User-specified flag to indicate which mode to use for advertisement.

Returns:
value or null for none








setAdvertiseMode
public RouterBgpPeer setAdvertiseMode(String advertiseMode)
User-specified flag to indicate which mode to use for advertisement.

Parameters:
advertiseMode - advertiseMode or null for none








getAdvertisedGroups
public List<String> getAdvertisedGroups()
User-specified list of prefix groups to advertise in custom mode, which can take one of the
 following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.
 - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. Note that this field can only be
 populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the
 "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this
 field blank to advertise no custom groups.

Returns:
value or null for none








setAdvertisedGroups
public RouterBgpPeer setAdvertisedGroups(List<String> advertisedGroups)
User-specified list of prefix groups to advertise in custom mode, which can take one of the
 following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.
 - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. Note that this field can only be
 populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the
 "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this
 field blank to advertise no custom groups.

Parameters:
advertisedGroups - advertisedGroups or null for none








getAdvertisedIpRanges
public List<RouterAdvertisedIpRange> getAdvertisedIpRanges()
User-specified list of individual IP ranges to advertise in custom mode. This field can only be
 populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the
 "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this
 field blank to advertise no custom IP ranges.

Returns:
value or null for none








setAdvertisedIpRanges
public RouterBgpPeer setAdvertisedIpRanges(List<RouterAdvertisedIpRange> advertisedIpRanges)
User-specified list of individual IP ranges to advertise in custom mode. This field can only be
 populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the
 "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this
 field blank to advertise no custom IP ranges.

Parameters:
advertisedIpRanges - advertisedIpRanges or null for none








getAdvertisedRoutePriority
public Long getAdvertisedRoutePriority()
The priority of routes advertised to this BGP peer. Where there is more than one matching route
 of maximum length, the routes with the lowest priority value win.

Returns:
value or null for none








setAdvertisedRoutePriority
public RouterBgpPeer setAdvertisedRoutePriority(Long advertisedRoutePriority)
The priority of routes advertised to this BGP peer. Where there is more than one matching route
 of maximum length, the routes with the lowest priority value win.

Parameters:
advertisedRoutePriority - advertisedRoutePriority or null for none








getBfd
public RouterBgpPeerBfd getBfd()
BFD configuration for the BGP peering.

Returns:
value or null for none








setBfd
public RouterBgpPeer setBfd(RouterBgpPeerBfd bfd)
BFD configuration for the BGP peering.

Parameters:
bfd - bfd or null for none








getEnable
public String getEnable()
The status of the BGP peer connection. If set to FALSE, any active session with the peer is
 terminated and all associated routing information is removed. If set to TRUE, the peer
 connection can be established with routing information. The default is TRUE.

Returns:
value or null for none








setEnable
public RouterBgpPeer setEnable(String enable)
The status of the BGP peer connection. If set to FALSE, any active session with the peer is
 terminated and all associated routing information is removed. If set to TRUE, the peer
 connection can be established with routing information. The default is TRUE.

Parameters:
enable - enable or null for none








getEnableIpv6
public Boolean getEnableIpv6()
Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.

Returns:
value or null for none








setEnableIpv6
public RouterBgpPeer setEnableIpv6(Boolean enableIpv6)
Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.

Parameters:
enableIpv6 - enableIpv6 or null for none








getInterfaceName
public String getInterfaceName()
Name of the interface the BGP peer is associated with.

Returns:
value or null for none








setInterfaceName
public RouterBgpPeer setInterfaceName(String interfaceName)
Name of the interface the BGP peer is associated with.

Parameters:
interfaceName - interfaceName or null for none








getIpAddress
public String getIpAddress()
IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

Returns:
value or null for none








setIpAddress
public RouterBgpPeer setIpAddress(String ipAddress)
IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

Parameters:
ipAddress - ipAddress or null for none








getIpv6NexthopAddress
public String getIpv6NexthopAddress()
IPv6 address of the interface inside Google Cloud Platform.

Returns:
value or null for none








setIpv6NexthopAddress
public RouterBgpPeer setIpv6NexthopAddress(String ipv6NexthopAddress)
IPv6 address of the interface inside Google Cloud Platform.

Parameters:
ipv6NexthopAddress - ipv6NexthopAddress or null for none








getManagementType
public String getManagementType()
[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the
 default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer
 that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment
 of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when
 the PARTNER InterconnectAttachment is created, updated, or deleted.

Returns:
value or null for none








setManagementType
public RouterBgpPeer setManagementType(String managementType)
[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the
 default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer
 that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment
 of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when
 the PARTNER InterconnectAttachment is created, updated, or deleted.

Parameters:
managementType - managementType or null for none








getMd5AuthenticationKeyName
public String getMd5AuthenticationKeyName()
Present if MD5 authentication is enabled for the peering. Must be the name of one of the
 entries in the Router.md5_authentication_keys. The field must comply with RFC1035.

Returns:
value or null for none








setMd5AuthenticationKeyName
public RouterBgpPeer setMd5AuthenticationKeyName(String md5AuthenticationKeyName)
Present if MD5 authentication is enabled for the peering. Must be the name of one of the
 entries in the Router.md5_authentication_keys. The field must comply with RFC1035.

Parameters:
md5AuthenticationKeyName - md5AuthenticationKeyName or null for none








getName
public String getName()
Name of this BGP peer. 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 RouterBgpPeer setName(String name)
Name of this BGP peer. 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








getPeerAsn
public Long getPeerAsn()
Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

Returns:
value or null for none








setPeerAsn
public RouterBgpPeer setPeerAsn(Long peerAsn)
Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

Parameters:
peerAsn - peerAsn or null for none








getPeerIpAddress
public String getPeerIpAddress()
IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Returns:
value or null for none








setPeerIpAddress
public RouterBgpPeer setPeerIpAddress(String peerIpAddress)
IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Parameters:
peerIpAddress - peerIpAddress or null for none








getPeerIpv6NexthopAddress
public String getPeerIpv6NexthopAddress()
IPv6 address of the BGP interface outside Google Cloud Platform.

Returns:
value or null for none








setPeerIpv6NexthopAddress
public RouterBgpPeer setPeerIpv6NexthopAddress(String peerIpv6NexthopAddress)
IPv6 address of the BGP interface outside Google Cloud Platform.

Parameters:
peerIpv6NexthopAddress - peerIpv6NexthopAddress or null for none








getRouterApplianceInstance
public String getRouterApplianceInstance()
URI of the VM instance that is used as third-party router appliances such as Next Gen
 Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones
 contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP
 session.

Returns:
value or null for none








setRouterApplianceInstance
public RouterBgpPeer setRouterApplianceInstance(String routerApplianceInstance)
URI of the VM instance that is used as third-party router appliances such as Next Gen
 Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones
 contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP
 session.

Parameters:
routerApplianceInstance - routerApplianceInstance or null for none








set
public RouterBgpPeer set(String fieldName,
                         Object value)

Overrides:
set in class GenericJson








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

Modifier and Type	Method and Description
`RouterBgpPeer`	`clone()`
`List<String>`	`getAdvertisedGroups()` User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.
`List<RouterAdvertisedIpRange>`	`getAdvertisedIpRanges()` User-specified list of individual IP ranges to advertise in custom mode.
`Long`	`getAdvertisedRoutePriority()` The priority of routes advertised to this BGP peer.
`String`	`getAdvertiseMode()` User-specified flag to indicate which mode to use for advertisement.
`RouterBgpPeerBfd`	`getBfd()` BFD configuration for the BGP peering.
`String`	`getEnable()` The status of the BGP peer connection.
`Boolean`	`getEnableIpv6()` Enable IPv6 traffic over BGP Peer.
`String`	`getInterfaceName()` Name of the interface the BGP peer is associated with.
`String`	`getIpAddress()` IP address of the interface inside Google Cloud Platform.
`String`	`getIpv6NexthopAddress()` IPv6 address of the interface inside Google Cloud Platform.
`String`	`getManagementType()` [Output Only] The resource that configures and manages this BGP peer.
`String`	`getMd5AuthenticationKeyName()` Present if MD5 authentication is enabled for the peering.
`String`	`getName()` Name of this BGP peer.
`Long`	`getPeerAsn()` Peer BGP Autonomous System Number (ASN).
`String`	`getPeerIpAddress()` IP address of the BGP interface outside Google Cloud Platform.
`String`	`getPeerIpv6NexthopAddress()` IPv6 address of the BGP interface outside Google Cloud Platform.
`String`	`getRouterApplianceInstance()` URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances.
`RouterBgpPeer`	`set(String fieldName, Object value)`
`RouterBgpPeer`	`setAdvertisedGroups(List<String> advertisedGroups)` User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.
`RouterBgpPeer`	`setAdvertisedIpRanges(List<RouterAdvertisedIpRange> advertisedIpRanges)` User-specified list of individual IP ranges to advertise in custom mode.
`RouterBgpPeer`	`setAdvertisedRoutePriority(Long advertisedRoutePriority)` The priority of routes advertised to this BGP peer.
`RouterBgpPeer`	`setAdvertiseMode(String advertiseMode)` User-specified flag to indicate which mode to use for advertisement.
`RouterBgpPeer`	`setBfd(RouterBgpPeerBfd bfd)` BFD configuration for the BGP peering.
`RouterBgpPeer`	`setEnable(String enable)` The status of the BGP peer connection.
`RouterBgpPeer`	`setEnableIpv6(Boolean enableIpv6)` Enable IPv6 traffic over BGP Peer.
`RouterBgpPeer`	`setInterfaceName(String interfaceName)` Name of the interface the BGP peer is associated with.
`RouterBgpPeer`	`setIpAddress(String ipAddress)` IP address of the interface inside Google Cloud Platform.
`RouterBgpPeer`	`setIpv6NexthopAddress(String ipv6NexthopAddress)` IPv6 address of the interface inside Google Cloud Platform.
`RouterBgpPeer`	`setManagementType(String managementType)` [Output Only] The resource that configures and manages this BGP peer.
`RouterBgpPeer`	`setMd5AuthenticationKeyName(String md5AuthenticationKeyName)` Present if MD5 authentication is enabled for the peering.
`RouterBgpPeer`	`setName(String name)` Name of this BGP peer.
`RouterBgpPeer`	`setPeerAsn(Long peerAsn)` Peer BGP Autonomous System Number (ASN).
`RouterBgpPeer`	`setPeerIpAddress(String peerIpAddress)` IP address of the BGP interface outside Google Cloud Platform.
`RouterBgpPeer`	`setPeerIpv6NexthopAddress(String peerIpv6NexthopAddress)` IPv6 address of the BGP interface outside Google Cloud Platform.
`RouterBgpPeer`	`setRouterApplianceInstance(String routerApplianceInstance)` URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances.