com.google.cloud.compute.v1

Interface RouterBgpPeerOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RouterBgpPeer, RouterBgpPeer.Builder

public interface RouterBgpPeerOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
com.google.protobuf.ByteString	getAdvertisedGroupsBytes(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.
int	getAdvertisedGroupsCount() 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<String>	getAdvertisedGroupsList() 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.
RouterAdvertisedIpRange	getAdvertisedIpRanges(int index) User-specified list of individual IP ranges to advertise in custom mode.
int	getAdvertisedIpRangesCount() User-specified list of individual IP ranges to advertise in custom mode.
List<RouterAdvertisedIpRange>	getAdvertisedIpRangesList() User-specified list of individual IP ranges to advertise in custom mode.
RouterAdvertisedIpRangeOrBuilder	getAdvertisedIpRangesOrBuilder(int index) User-specified list of individual IP ranges to advertise in custom mode.
List<? extends RouterAdvertisedIpRangeOrBuilder>	getAdvertisedIpRangesOrBuilderList() User-specified list of individual IP ranges to advertise in custom mode.
int	getAdvertisedRoutePriority() The priority of routes advertised to this BGP peer.
String	getAdvertiseMode() User-specified flag to indicate which mode to use for advertisement.
com.google.protobuf.ByteString	getAdvertiseModeBytes() User-specified flag to indicate which mode to use for advertisement.
RouterBgpPeerBfd	getBfd() BFD configuration for the BGP peering.
RouterBgpPeerBfdOrBuilder	getBfdOrBuilder() BFD configuration for the BGP peering.
String	getEnable() The status of the BGP peer connection.
com.google.protobuf.ByteString	getEnableBytes() 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.
com.google.protobuf.ByteString	getInterfaceNameBytes() Name of the interface the BGP peer is associated with.
String	getIpAddress() IP address of the interface inside Google Cloud Platform.
com.google.protobuf.ByteString	getIpAddressBytes() IP address of the interface inside Google Cloud Platform.
String	getIpv6NexthopAddress() IPv6 address of the interface inside Google Cloud Platform.
com.google.protobuf.ByteString	getIpv6NexthopAddressBytes() IPv6 address of the interface inside Google Cloud Platform.
String	getManagementType() [Output Only] The resource that configures and manages this BGP peer.
com.google.protobuf.ByteString	getManagementTypeBytes() [Output Only] The resource that configures and manages this BGP peer.
String	getMd5AuthenticationKeyName() Present if MD5 authentication is enabled for the peering.
com.google.protobuf.ByteString	getMd5AuthenticationKeyNameBytes() Present if MD5 authentication is enabled for the peering.
String	getName() Name of this BGP peer.
com.google.protobuf.ByteString	getNameBytes() Name of this BGP peer.
int	getPeerAsn() Peer BGP Autonomous System Number (ASN).
String	getPeerIpAddress() IP address of the BGP interface outside Google Cloud Platform.
com.google.protobuf.ByteString	getPeerIpAddressBytes() IP address of the BGP interface outside Google Cloud Platform.
String	getPeerIpv6NexthopAddress() IPv6 address of the BGP interface outside Google Cloud Platform.
com.google.protobuf.ByteString	getPeerIpv6NexthopAddressBytes() 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.
com.google.protobuf.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.
boolean	hasAdvertisedRoutePriority() The priority of routes advertised to this BGP peer.
boolean	hasAdvertiseMode() User-specified flag to indicate which mode to use for advertisement.
boolean	hasBfd() BFD configuration for the BGP peering.
boolean	hasEnable() The status of the BGP peer connection.
boolean	hasEnableIpv6() Enable IPv6 traffic over BGP Peer.
boolean	hasInterfaceName() Name of the interface the BGP peer is associated with.
boolean	hasIpAddress() IP address of the interface inside Google Cloud Platform.
boolean	hasIpv6NexthopAddress() IPv6 address of the interface inside Google Cloud Platform.
boolean	hasManagementType() [Output Only] The resource that configures and manages this BGP peer.
boolean	hasMd5AuthenticationKeyName() Present if MD5 authentication is enabled for the peering.
boolean	hasName() Name of this BGP peer.
boolean	hasPeerAsn() Peer BGP Autonomous System Number (ASN).
boolean	hasPeerIpAddress() IP address of the BGP interface outside Google Cloud Platform.
boolean	hasPeerIpv6NexthopAddress() IPv6 address of the BGP interface outside Google Cloud Platform.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasAdvertiseMode

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:

Whether the advertiseMode field is set.

getAdvertiseMode

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:

The advertiseMode.

getAdvertiseModeBytes

com.google.protobuf.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:

The bytes for advertiseMode.

getAdvertisedGroupsList

List<String> getAdvertisedGroupsList()

 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;

Returns:

A list containing the advertisedGroups.

getAdvertisedGroupsCount

int getAdvertisedGroupsCount()

 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;

Returns:

The count of advertisedGroups.

getAdvertisedGroups

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;

Parameters:

index - The index of the element to return.

Returns:

The advertisedGroups at the given index.

getAdvertisedGroupsBytes

com.google.protobuf.ByteString getAdvertisedGroupsBytes(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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the advertisedGroups at the given index.

getAdvertisedIpRangesList

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;

getAdvertisedIpRanges

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;

getAdvertisedIpRangesCount

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;

getAdvertisedIpRangesOrBuilderList

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;

getAdvertisedIpRangesOrBuilder

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;

hasAdvertisedRoutePriority

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:

Whether the advertisedRoutePriority field is set.

getAdvertisedRoutePriority

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:

The advertisedRoutePriority.

hasBfd

boolean hasBfd()

 BFD configuration for the BGP peering.
 

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

Returns:

Whether the bfd field is set.

getBfd

RouterBgpPeerBfd getBfd()

 BFD configuration for the BGP peering.
 

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

Returns:

The bfd.

getBfdOrBuilder

RouterBgpPeerBfdOrBuilder getBfdOrBuilder()

 BFD configuration for the BGP peering.
 

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

hasEnable

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:

Whether the enable field is set.

getEnable

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:

The enable.

getEnableBytes

com.google.protobuf.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:

The bytes for enable.

hasEnableIpv6

boolean hasEnableIpv6()

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

optional bool enable_ipv6 = 181467939;

Returns:

Whether the enableIpv6 field is set.

getEnableIpv6

boolean getEnableIpv6()

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

optional bool enable_ipv6 = 181467939;

Returns:

The enableIpv6.

hasInterfaceName

boolean hasInterfaceName()

 Name of the interface the BGP peer is associated with.
 

optional string interface_name = 437854673;

Returns:

Whether the interfaceName field is set.

getInterfaceName

String getInterfaceName()

 Name of the interface the BGP peer is associated with.
 

optional string interface_name = 437854673;

Returns:

The interfaceName.

getInterfaceNameBytes

com.google.protobuf.ByteString getInterfaceNameBytes()

 Name of the interface the BGP peer is associated with.
 

optional string interface_name = 437854673;

Returns:

The bytes for interfaceName.

hasIpAddress

boolean hasIpAddress()

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

optional string ip_address = 406272220;

Returns:

Whether the ipAddress field is set.

getIpAddress

String getIpAddress()

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

optional string ip_address = 406272220;

Returns:

The ipAddress.

getIpAddressBytes

com.google.protobuf.ByteString getIpAddressBytes()

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

optional string ip_address = 406272220;

Returns:

The bytes for ipAddress.

hasIpv6NexthopAddress

boolean hasIpv6NexthopAddress()

 IPv6 address of the interface inside Google Cloud Platform.
 

optional string ipv6_nexthop_address = 27968211;

Returns:

Whether the ipv6NexthopAddress field is set.

getIpv6NexthopAddress

String getIpv6NexthopAddress()

 IPv6 address of the interface inside Google Cloud Platform.
 

optional string ipv6_nexthop_address = 27968211;

Returns:

The ipv6NexthopAddress.

getIpv6NexthopAddressBytes

com.google.protobuf.ByteString getIpv6NexthopAddressBytes()

 IPv6 address of the interface inside Google Cloud Platform.
 

optional string ipv6_nexthop_address = 27968211;

Returns:

The bytes for ipv6NexthopAddress.

hasManagementType

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:

Whether the managementType field is set.

getManagementType

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:

The managementType.

getManagementTypeBytes

com.google.protobuf.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:

The bytes for managementType.

hasMd5AuthenticationKeyName

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:

Whether the md5AuthenticationKeyName field is set.

getMd5AuthenticationKeyName

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:

The md5AuthenticationKeyName.

getMd5AuthenticationKeyNameBytes

com.google.protobuf.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:

The bytes for md5AuthenticationKeyName.

hasName

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]([-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.
 

optional string name = 3373707;

Returns:

Whether the name field is set.

getName

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.
 

optional string name = 3373707;

Returns:

The name.

getNameBytes

com.google.protobuf.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]([-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.
 

optional string name = 3373707;

Returns:

The bytes for name.

hasPeerAsn

boolean hasPeerAsn()

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

optional uint32 peer_asn = 69573151;

Returns:

Whether the peerAsn field is set.

getPeerAsn

int getPeerAsn()

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

optional uint32 peer_asn = 69573151;

Returns:

The peerAsn.

hasPeerIpAddress

boolean hasPeerIpAddress()

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

optional string peer_ip_address = 207735769;

Returns:

Whether the peerIpAddress field is set.

getPeerIpAddress

String getPeerIpAddress()

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

optional string peer_ip_address = 207735769;

Returns:

The peerIpAddress.

getPeerIpAddressBytes

com.google.protobuf.ByteString getPeerIpAddressBytes()

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

optional string peer_ip_address = 207735769;

Returns:

The bytes for peerIpAddress.

hasPeerIpv6NexthopAddress

boolean hasPeerIpv6NexthopAddress()

 IPv6 address of the BGP interface outside Google Cloud Platform.
 

optional string peer_ipv6_nexthop_address = 491486608;

Returns:

Whether the peerIpv6NexthopAddress field is set.

getPeerIpv6NexthopAddress

String getPeerIpv6NexthopAddress()

 IPv6 address of the BGP interface outside Google Cloud Platform.
 

optional string peer_ipv6_nexthop_address = 491486608;

Returns:

The peerIpv6NexthopAddress.

getPeerIpv6NexthopAddressBytes

com.google.protobuf.ByteString getPeerIpv6NexthopAddressBytes()

 IPv6 address of the BGP interface outside Google Cloud Platform.
 

optional string peer_ipv6_nexthop_address = 491486608;

Returns:

The bytes for peerIpv6NexthopAddress.

hasRouterApplianceInstance

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:

Whether the routerApplianceInstance field is set.

getRouterApplianceInstance

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:

The routerApplianceInstance.

getRouterApplianceInstanceBytes

com.google.protobuf.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:

The bytes for routerApplianceInstance.