Interface RouterBgpPeerOrBuilder (1.33.0)

Version 1.33.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public interface RouterBgpPeerOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdvertiseMode()

public abstract String getAdvertiseMode()

User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values.

optional string advertise_mode = 312134331;

Returns
Type	Description
String	The advertiseMode.

getAdvertiseModeBytes()

public abstract ByteString getAdvertiseModeBytes()

User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values.

optional string advertise_mode = 312134331;

Returns
Type	Description
ByteString	The bytes for advertiseMode.

getAdvertisedGroups(int index)

public abstract String getAdvertisedGroups(int index)

User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. 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. Check the AdvertisedGroups enum for the list of possible values.

repeated string advertised_groups = 21065526;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The advertisedGroups at the given index.

getAdvertisedGroupsBytes(int index)

public abstract ByteString getAdvertisedGroupsBytes(int index)

User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. 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. Check the AdvertisedGroups enum for the list of possible values.

repeated string advertised_groups = 21065526;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the advertisedGroups at the given index.

getAdvertisedGroupsCount()

public abstract int getAdvertisedGroupsCount()

User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. 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. Check the AdvertisedGroups enum for the list of possible values.

repeated string advertised_groups = 21065526;

Returns
Type	Description
int	The count of advertisedGroups.

getAdvertisedGroupsList()

public abstract List<String> getAdvertisedGroupsList()

User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. 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. Check the AdvertisedGroups enum for the list of possible values.

repeated string advertised_groups = 21065526;

Returns
Type	Description
List<String>	A list containing the advertisedGroups.

getAdvertisedIpRanges(int index)

public abstract RouterAdvertisedIpRange getAdvertisedIpRanges(int index)

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.

repeated .google.cloud.compute.v1.RouterAdvertisedIpRange advertised_ip_ranges = 35449932;

Parameter
Name	Description
index	int

Returns
Type	Description
RouterAdvertisedIpRange

getAdvertisedIpRangesCount()

public abstract int getAdvertisedIpRangesCount()

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.

repeated .google.cloud.compute.v1.RouterAdvertisedIpRange advertised_ip_ranges = 35449932;

Returns
Type	Description
int

getAdvertisedIpRangesList()

public abstract List<RouterAdvertisedIpRange> getAdvertisedIpRangesList()

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.

repeated .google.cloud.compute.v1.RouterAdvertisedIpRange advertised_ip_ranges = 35449932;

Returns
Type	Description
List<RouterAdvertisedIpRange>

getAdvertisedIpRangesOrBuilder(int index)

public abstract RouterAdvertisedIpRangeOrBuilder getAdvertisedIpRangesOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.RouterAdvertisedIpRange advertised_ip_ranges = 35449932;

Parameter
Name	Description
index	int

Returns
Type	Description
RouterAdvertisedIpRangeOrBuilder

getAdvertisedIpRangesOrBuilderList()

public abstract List<? extends RouterAdvertisedIpRangeOrBuilder> getAdvertisedIpRangesOrBuilderList()

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.

repeated .google.cloud.compute.v1.RouterAdvertisedIpRange advertised_ip_ranges = 35449932;

Returns
Type	Description
List<? extends com.google.cloud.compute.v1.RouterAdvertisedIpRangeOrBuilder>

getAdvertisedRoutePriority()

public abstract int 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.

optional uint32 advertised_route_priority = 186486332;

Returns
Type	Description
int	The advertisedRoutePriority.

getBfd()

public abstract RouterBgpPeerBfd getBfd()

BFD configuration for the BGP peering.

optional .google.cloud.compute.v1.RouterBgpPeerBfd bfd = 97440;

Returns
Type	Description
RouterBgpPeerBfd	The bfd.

getBfdOrBuilder()

public abstract RouterBgpPeerBfdOrBuilder getBfdOrBuilder()

BFD configuration for the BGP peering.

optional .google.cloud.compute.v1.RouterBgpPeerBfd bfd = 97440;

Returns
Type	Description
RouterBgpPeerBfdOrBuilder

getCustomLearnedIpRanges(int index)

public abstract RouterBgpPeerCustomLearnedIpRange getCustomLearnedIpRanges(int index)

A list of user-defined custom learned route IP address ranges for a BGP session.

repeated .google.cloud.compute.v1.RouterBgpPeerCustomLearnedIpRange custom_learned_ip_ranges = 481363012;

Parameter
Name	Description
index	int

Returns
Type	Description
RouterBgpPeerCustomLearnedIpRange

getCustomLearnedIpRangesCount()

public abstract int getCustomLearnedIpRangesCount()

A list of user-defined custom learned route IP address ranges for a BGP session.

repeated .google.cloud.compute.v1.RouterBgpPeerCustomLearnedIpRange custom_learned_ip_ranges = 481363012;

Returns
Type	Description
int

getCustomLearnedIpRangesList()

public abstract List<RouterBgpPeerCustomLearnedIpRange> getCustomLearnedIpRangesList()

A list of user-defined custom learned route IP address ranges for a BGP session.

repeated .google.cloud.compute.v1.RouterBgpPeerCustomLearnedIpRange custom_learned_ip_ranges = 481363012;

Returns
Type	Description
List<RouterBgpPeerCustomLearnedIpRange>

getCustomLearnedIpRangesOrBuilder(int index)

public abstract RouterBgpPeerCustomLearnedIpRangeOrBuilder getCustomLearnedIpRangesOrBuilder(int index)

A list of user-defined custom learned route IP address ranges for a BGP session.

repeated .google.cloud.compute.v1.RouterBgpPeerCustomLearnedIpRange custom_learned_ip_ranges = 481363012;

Parameter
Name	Description
index	int

Returns
Type	Description
RouterBgpPeerCustomLearnedIpRangeOrBuilder

getCustomLearnedIpRangesOrBuilderList()

public abstract List<? extends RouterBgpPeerCustomLearnedIpRangeOrBuilder> getCustomLearnedIpRangesOrBuilderList()

A list of user-defined custom learned route IP address ranges for a BGP session.

repeated .google.cloud.compute.v1.RouterBgpPeerCustomLearnedIpRange custom_learned_ip_ranges = 481363012;

Returns
Type	Description
List<? extends com.google.cloud.compute.v1.RouterBgpPeerCustomLearnedIpRangeOrBuilder>

getCustomLearnedRoutePriority()

public abstract int getCustomLearnedRoutePriority()

The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.

optional int32 custom_learned_route_priority = 330412356;

Returns
Type	Description
int	The customLearnedRoutePriority.

getEnable()

public abstract 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. Check the Enable enum for the list of possible values.

optional string enable = 311764355;

Returns
Type	Description
String	The enable.

getEnableBytes()

public abstract ByteString getEnableBytes()

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. Check the Enable enum for the list of possible values.

optional string enable = 311764355;

Returns
Type	Description
ByteString	The bytes for enable.

getEnableIpv6()

public abstract boolean getEnableIpv6()

Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.

optional bool enable_ipv6 = 181467939;

Returns
Type	Description
boolean	The enableIpv6.

getInterfaceName()

public abstract String getInterfaceName()

Name of the interface the BGP peer is associated with.

optional string interface_name = 437854673;

Returns
Type	Description
String	The interfaceName.

getInterfaceNameBytes()

public abstract ByteString getInterfaceNameBytes()

Name of the interface the BGP peer is associated with.

optional string interface_name = 437854673;

Returns
Type	Description
ByteString	The bytes for interfaceName.

getIpAddress()

public abstract String getIpAddress()

IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

optional string ip_address = 406272220;

Returns
Type	Description
String	The ipAddress.

getIpAddressBytes()

public abstract ByteString getIpAddressBytes()

IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

optional string ip_address = 406272220;

Returns
Type	Description
ByteString	The bytes for ipAddress.

getIpv6NexthopAddress()

public abstract String getIpv6NexthopAddress()

IPv6 address of the interface inside Google Cloud Platform.

optional string ipv6_nexthop_address = 27968211;

Returns
Type	Description
String	The ipv6NexthopAddress.

getIpv6NexthopAddressBytes()

public abstract ByteString getIpv6NexthopAddressBytes()

IPv6 address of the interface inside Google Cloud Platform.

optional string ipv6_nexthop_address = 27968211;

Returns
Type	Description
ByteString	The bytes for ipv6NexthopAddress.

getManagementType()

public abstract 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. Check the ManagementType enum for the list of possible values.

optional string management_type = 173703606;

Returns
Type	Description
String	The managementType.

getManagementTypeBytes()

public abstract ByteString getManagementTypeBytes()

[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. Check the ManagementType enum for the list of possible values.

optional string management_type = 173703606;

Returns
Type	Description
ByteString	The bytes for managementType.

getMd5AuthenticationKeyName()

public abstract 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.

optional string md5_authentication_key_name = 281075345;

Returns
Type	Description
String	The md5AuthenticationKeyName.

getMd5AuthenticationKeyNameBytes()

public abstract ByteString getMd5AuthenticationKeyNameBytes()

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.

optional string md5_authentication_key_name = 281075345;

Returns
Type	Description
ByteString	The bytes for md5AuthenticationKeyName.

getName()

public abstract 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? 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.

optional string name = 3373707;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

optional string name = 3373707;

Returns
Type	Description
ByteString	The bytes for name.

getPeerAsn()

public abstract int getPeerAsn()

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

optional uint32 peer_asn = 69573151;

Returns
Type	Description
int	The peerAsn.

getPeerIpAddress()

public abstract String getPeerIpAddress()

IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

optional string peer_ip_address = 207735769;

Returns
Type	Description
String	The peerIpAddress.

getPeerIpAddressBytes()

public abstract ByteString getPeerIpAddressBytes()

IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

optional string peer_ip_address = 207735769;

Returns
Type	Description
ByteString	The bytes for peerIpAddress.

getPeerIpv6NexthopAddress()

public abstract String getPeerIpv6NexthopAddress()

IPv6 address of the BGP interface outside Google Cloud Platform.

optional string peer_ipv6_nexthop_address = 491486608;

Returns
Type	Description
String	The peerIpv6NexthopAddress.

getPeerIpv6NexthopAddressBytes()

public abstract ByteString getPeerIpv6NexthopAddressBytes()

IPv6 address of the BGP interface outside Google Cloud Platform.

optional string peer_ipv6_nexthop_address = 491486608;

Returns
Type	Description
ByteString	The bytes for peerIpv6NexthopAddress.

getRouterApplianceInstance()

public abstract 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.

optional string router_appliance_instance = 468312989;

Returns
Type	Description
String	The routerApplianceInstance.

getRouterApplianceInstanceBytes()

public abstract ByteString getRouterApplianceInstanceBytes()

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.

optional string router_appliance_instance = 468312989;

Returns
Type	Description
ByteString	The bytes for routerApplianceInstance.

hasAdvertiseMode()

public abstract boolean hasAdvertiseMode()

User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values.

optional string advertise_mode = 312134331;

Returns
Type	Description
boolean	Whether the advertiseMode field is set.

hasAdvertisedRoutePriority()

public abstract boolean hasAdvertisedRoutePriority()

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.

optional uint32 advertised_route_priority = 186486332;

Returns
Type	Description
boolean	Whether the advertisedRoutePriority field is set.

hasBfd()

public abstract boolean hasBfd()

BFD configuration for the BGP peering.

optional .google.cloud.compute.v1.RouterBgpPeerBfd bfd = 97440;

Returns
Type	Description
boolean	Whether the bfd field is set.

hasCustomLearnedRoutePriority()

public abstract boolean hasCustomLearnedRoutePriority()

The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.

optional int32 custom_learned_route_priority = 330412356;

Returns
Type	Description
boolean	Whether the customLearnedRoutePriority field is set.

hasEnable()

public abstract boolean hasEnable()

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. Check the Enable enum for the list of possible values.

optional string enable = 311764355;

Returns
Type	Description
boolean	Whether the enable field is set.

hasEnableIpv6()

public abstract boolean hasEnableIpv6()

Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.

optional bool enable_ipv6 = 181467939;

Returns
Type	Description
boolean	Whether the enableIpv6 field is set.

hasInterfaceName()

public abstract boolean hasInterfaceName()

Name of the interface the BGP peer is associated with.

optional string interface_name = 437854673;

Returns
Type	Description
boolean	Whether the interfaceName field is set.

hasIpAddress()

public abstract boolean hasIpAddress()

IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

optional string ip_address = 406272220;

Returns
Type	Description
boolean	Whether the ipAddress field is set.

hasIpv6NexthopAddress()

public abstract boolean hasIpv6NexthopAddress()

IPv6 address of the interface inside Google Cloud Platform.

optional string ipv6_nexthop_address = 27968211;

Returns
Type	Description
boolean	Whether the ipv6NexthopAddress field is set.

hasManagementType()

public abstract boolean hasManagementType()

[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. Check the ManagementType enum for the list of possible values.

optional string management_type = 173703606;

Returns
Type	Description
boolean	Whether the managementType field is set.

hasMd5AuthenticationKeyName()

public abstract boolean hasMd5AuthenticationKeyName()

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.

optional string md5_authentication_key_name = 281075345;

Returns
Type	Description
boolean	Whether the md5AuthenticationKeyName field is set.

hasName()

public abstract boolean hasName()

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

optional string name = 3373707;

Returns
Type	Description
boolean	Whether the name field is set.

hasPeerAsn()

public abstract boolean hasPeerAsn()

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

optional uint32 peer_asn = 69573151;

Returns
Type	Description
boolean	Whether the peerAsn field is set.

hasPeerIpAddress()

public abstract boolean hasPeerIpAddress()

IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

optional string peer_ip_address = 207735769;

Returns
Type	Description
boolean	Whether the peerIpAddress field is set.

hasPeerIpv6NexthopAddress()

public abstract boolean hasPeerIpv6NexthopAddress()

IPv6 address of the BGP interface outside Google Cloud Platform.

optional string peer_ipv6_nexthop_address = 491486608;

Returns
Type	Description
boolean	Whether the peerIpv6NexthopAddress field is set.

hasRouterApplianceInstance()

public abstract boolean hasRouterApplianceInstance()

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.

optional string router_appliance_instance = 468312989;

Returns
Type	Description
boolean	Whether the routerApplianceInstance field is set.