Interface RouterBgpPeerOrBuilder (1.7.2)

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

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

repeated string advertised_groups = 21065526;

Returns

Type	Description
int	The count of advertisedGroups.

getAdvertisedGroupsList()

public abstract List<String> getAdvertisedGroupsList()

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

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

Returns

Type	Description
int

getAdvertisedIpRangesList()

public abstract List<RouterAdvertisedIpRange> getAdvertisedIpRangesList()

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

Returns

Type	Description
List<RouterAdvertisedIpRange>

getAdvertisedIpRangesOrBuilder(int index)

public abstract RouterAdvertisedIpRangeOrBuilder getAdvertisedIpRangesOrBuilder(int index)

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

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

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

optional string enable = 311764355;

Returns

Type	Description
ByteString	The bytes for enable.

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.

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

optional string management_type = 173703606;

Returns

Type	Description
ByteString	The bytes for managementType.

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

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.

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

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.

hasEnable()

public abstract boolean hasEnable()

optional string enable = 311764355;

Returns

Type	Description
boolean	Whether the enable 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.

hasManagementType()

public abstract boolean hasManagementType()

optional string management_type = 173703606;

Returns

Type	Description
boolean	Whether the managementType field is set.

hasName()

public abstract boolean hasName()

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.

hasRouterApplianceInstance()

public abstract boolean hasRouterApplianceInstance()

optional string router_appliance_instance = 468312989;

Returns

Type	Description
boolean	Whether the routerApplianceInstance field is set.