Class RouterBgpPeer.Builder (1.52.0) 

public static final class RouterBgpPeer.Builder extends GeneratedMessageV3.Builder<RouterBgpPeer.Builder> implements RouterBgpPeerOrBuilder

Protobuf type google.cloud.compute.v1.RouterBgpPeer

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RouterBgpPeer.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAdvertisedGroups(String value)

public RouterBgpPeer.Builder addAdvertisedGroups(String value)

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
value String

The advertisedGroups to add.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

addAdvertisedGroupsBytes(ByteString value)

public RouterBgpPeer.Builder addAdvertisedGroupsBytes(ByteString value)

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
value ByteString

The bytes of the advertisedGroups to add.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

addAdvertisedIpRanges(RouterAdvertisedIpRange value)

public RouterBgpPeer.Builder addAdvertisedIpRanges(RouterAdvertisedIpRange value)

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
value RouterAdvertisedIpRange
Returns
Type Description
RouterBgpPeer.Builder

addAdvertisedIpRanges(RouterAdvertisedIpRange.Builder builderForValue)

public RouterBgpPeer.Builder addAdvertisedIpRanges(RouterAdvertisedIpRange.Builder builderForValue)

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
builderForValue RouterAdvertisedIpRange.Builder
Returns
Type Description
RouterBgpPeer.Builder

addAdvertisedIpRanges(int index, RouterAdvertisedIpRange value)

public RouterBgpPeer.Builder addAdvertisedIpRanges(int index, RouterAdvertisedIpRange value)

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;

Parameters
Name Description
index int
value RouterAdvertisedIpRange
Returns
Type Description
RouterBgpPeer.Builder

addAdvertisedIpRanges(int index, RouterAdvertisedIpRange.Builder builderForValue)

public RouterBgpPeer.Builder addAdvertisedIpRanges(int index, RouterAdvertisedIpRange.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue RouterAdvertisedIpRange.Builder
Returns
Type Description
RouterBgpPeer.Builder

addAdvertisedIpRangesBuilder()

public RouterAdvertisedIpRange.Builder addAdvertisedIpRangesBuilder()

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
RouterAdvertisedIpRange.Builder

addAdvertisedIpRangesBuilder(int index)

public RouterAdvertisedIpRange.Builder addAdvertisedIpRangesBuilder(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.Builder

addAllAdvertisedGroups(Iterable<String> values)

public RouterBgpPeer.Builder addAllAdvertisedGroups(Iterable<String> values)

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
values Iterable<String>

The advertisedGroups to add.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

addAllAdvertisedIpRanges(Iterable<? extends RouterAdvertisedIpRange> values)

public RouterBgpPeer.Builder addAllAdvertisedIpRanges(Iterable<? extends RouterAdvertisedIpRange> values)

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
values Iterable<? extends com.google.cloud.compute.v1.RouterAdvertisedIpRange>
Returns
Type Description
RouterBgpPeer.Builder

addAllCustomLearnedIpRanges(Iterable<? extends RouterBgpPeerCustomLearnedIpRange> values)

public RouterBgpPeer.Builder addAllCustomLearnedIpRanges(Iterable<? extends RouterBgpPeerCustomLearnedIpRange> values)

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
values Iterable<? extends com.google.cloud.compute.v1.RouterBgpPeerCustomLearnedIpRange>
Returns
Type Description
RouterBgpPeer.Builder

addCustomLearnedIpRanges(RouterBgpPeerCustomLearnedIpRange value)

public RouterBgpPeer.Builder addCustomLearnedIpRanges(RouterBgpPeerCustomLearnedIpRange value)

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
value RouterBgpPeerCustomLearnedIpRange
Returns
Type Description
RouterBgpPeer.Builder

addCustomLearnedIpRanges(RouterBgpPeerCustomLearnedIpRange.Builder builderForValue)

public RouterBgpPeer.Builder addCustomLearnedIpRanges(RouterBgpPeerCustomLearnedIpRange.Builder builderForValue)

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
builderForValue RouterBgpPeerCustomLearnedIpRange.Builder
Returns
Type Description
RouterBgpPeer.Builder

addCustomLearnedIpRanges(int index, RouterBgpPeerCustomLearnedIpRange value)

public RouterBgpPeer.Builder addCustomLearnedIpRanges(int index, RouterBgpPeerCustomLearnedIpRange value)

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;

Parameters
Name Description
index int
value RouterBgpPeerCustomLearnedIpRange
Returns
Type Description
RouterBgpPeer.Builder

addCustomLearnedIpRanges(int index, RouterBgpPeerCustomLearnedIpRange.Builder builderForValue)

public RouterBgpPeer.Builder addCustomLearnedIpRanges(int index, RouterBgpPeerCustomLearnedIpRange.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue RouterBgpPeerCustomLearnedIpRange.Builder
Returns
Type Description
RouterBgpPeer.Builder

addCustomLearnedIpRangesBuilder()

public RouterBgpPeerCustomLearnedIpRange.Builder addCustomLearnedIpRangesBuilder()

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
RouterBgpPeerCustomLearnedIpRange.Builder

addCustomLearnedIpRangesBuilder(int index)

public RouterBgpPeerCustomLearnedIpRange.Builder addCustomLearnedIpRangesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RouterBgpPeer.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RouterBgpPeer.Builder
Overrides

build()

public RouterBgpPeer build()
Returns
Type Description
RouterBgpPeer

buildPartial()

public RouterBgpPeer buildPartial()
Returns
Type Description
RouterBgpPeer

clear()

public RouterBgpPeer.Builder clear()
Returns
Type Description
RouterBgpPeer.Builder
Overrides

clearAdvertiseMode()

public RouterBgpPeer.Builder clearAdvertiseMode()

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

This builder for chaining.

clearAdvertisedGroups()

public RouterBgpPeer.Builder clearAdvertisedGroups()

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

This builder for chaining.

clearAdvertisedIpRanges()

public RouterBgpPeer.Builder clearAdvertisedIpRanges()

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

clearAdvertisedRoutePriority()

public RouterBgpPeer.Builder clearAdvertisedRoutePriority()

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

This builder for chaining.

clearBfd()

public RouterBgpPeer.Builder clearBfd()

BFD configuration for the BGP peering.

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

Returns
Type Description
RouterBgpPeer.Builder

clearCustomLearnedIpRanges()

public RouterBgpPeer.Builder clearCustomLearnedIpRanges()

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

clearCustomLearnedRoutePriority()

public RouterBgpPeer.Builder clearCustomLearnedRoutePriority()

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

This builder for chaining.

clearEnable()

public RouterBgpPeer.Builder clearEnable()

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

This builder for chaining.

clearEnableIpv6()

public RouterBgpPeer.Builder clearEnableIpv6()

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

optional bool enable_ipv6 = 181467939;

Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RouterBgpPeer.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RouterBgpPeer.Builder
Overrides

clearInterfaceName()

public RouterBgpPeer.Builder clearInterfaceName()

Name of the interface the BGP peer is associated with.

optional string interface_name = 437854673;

Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

clearIpAddress()

public RouterBgpPeer.Builder clearIpAddress()

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

optional string ip_address = 406272220;

Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

clearIpv6NexthopAddress()

public RouterBgpPeer.Builder clearIpv6NexthopAddress()

IPv6 address of the interface inside Google Cloud Platform.

optional string ipv6_nexthop_address = 27968211;

Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

clearManagementType()

public RouterBgpPeer.Builder clearManagementType()

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

This builder for chaining.

clearMd5AuthenticationKeyName()

public RouterBgpPeer.Builder clearMd5AuthenticationKeyName()

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

This builder for chaining.

clearName()

public RouterBgpPeer.Builder clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RouterBgpPeer.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RouterBgpPeer.Builder
Overrides

clearPeerAsn()

public RouterBgpPeer.Builder clearPeerAsn()

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

optional uint32 peer_asn = 69573151;

Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

clearPeerIpAddress()

public RouterBgpPeer.Builder clearPeerIpAddress()

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

optional string peer_ip_address = 207735769;

Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

clearPeerIpv6NexthopAddress()

public RouterBgpPeer.Builder clearPeerIpv6NexthopAddress()

IPv6 address of the BGP interface outside Google Cloud Platform.

optional string peer_ipv6_nexthop_address = 491486608;

Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

clearRouterApplianceInstance()

public RouterBgpPeer.Builder clearRouterApplianceInstance()

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

This builder for chaining.

clone()

public RouterBgpPeer.Builder clone()
Returns
Type Description
RouterBgpPeer.Builder
Overrides

getAdvertiseMode()

public 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the advertisedGroups.

getAdvertisedIpRanges(int index)

public 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

getAdvertisedIpRangesBuilder(int index)

public RouterAdvertisedIpRange.Builder getAdvertisedIpRangesBuilder(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.Builder

getAdvertisedIpRangesBuilderList()

public List<RouterAdvertisedIpRange.Builder> getAdvertisedIpRangesBuilderList()

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<Builder>

getAdvertisedIpRangesCount()

public 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 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 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 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 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 RouterBgpPeerBfd getBfd()

BFD configuration for the BGP peering.

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

Returns
Type Description
RouterBgpPeerBfd

The bfd.

getBfdBuilder()

public RouterBgpPeerBfd.Builder getBfdBuilder()

BFD configuration for the BGP peering.

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

Returns
Type Description
RouterBgpPeerBfd.Builder

getBfdOrBuilder()

public RouterBgpPeerBfdOrBuilder getBfdOrBuilder()

BFD configuration for the BGP peering.

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

Returns
Type Description
RouterBgpPeerBfdOrBuilder

getCustomLearnedIpRanges(int index)

public 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

getCustomLearnedIpRangesBuilder(int index)

public RouterBgpPeerCustomLearnedIpRange.Builder getCustomLearnedIpRangesBuilder(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.Builder

getCustomLearnedIpRangesBuilderList()

public List<RouterBgpPeerCustomLearnedIpRange.Builder> getCustomLearnedIpRangesBuilderList()

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<Builder>

getCustomLearnedIpRangesCount()

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

getDefaultInstanceForType()

public RouterBgpPeer getDefaultInstanceForType()
Returns
Type Description
RouterBgpPeer

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

optional string enable = 311764355;

Returns
Type Description
String

The enable.

getEnableBytes()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBfd(RouterBgpPeerBfd value)

public RouterBgpPeer.Builder mergeBfd(RouterBgpPeerBfd value)

BFD configuration for the BGP peering.

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

Parameter
Name Description
value RouterBgpPeerBfd
Returns
Type Description
RouterBgpPeer.Builder

mergeFrom(RouterBgpPeer other)

public RouterBgpPeer.Builder mergeFrom(RouterBgpPeer other)
Parameter
Name Description
other RouterBgpPeer
Returns
Type Description
RouterBgpPeer.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RouterBgpPeer.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterBgpPeer.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RouterBgpPeer.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RouterBgpPeer.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RouterBgpPeer.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RouterBgpPeer.Builder
Overrides

removeAdvertisedIpRanges(int index)

public RouterBgpPeer.Builder removeAdvertisedIpRanges(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
RouterBgpPeer.Builder

removeCustomLearnedIpRanges(int index)

public RouterBgpPeer.Builder removeCustomLearnedIpRanges(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
RouterBgpPeer.Builder

setAdvertiseMode(String value)

public RouterBgpPeer.Builder setAdvertiseMode(String value)

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;

Parameter
Name Description
value String

The advertiseMode to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setAdvertiseModeBytes(ByteString value)

public RouterBgpPeer.Builder setAdvertiseModeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for advertiseMode to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setAdvertisedGroups(int index, String value)

public RouterBgpPeer.Builder setAdvertisedGroups(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.
value String

The advertisedGroups to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setAdvertisedIpRanges(int index, RouterAdvertisedIpRange value)

public RouterBgpPeer.Builder setAdvertisedIpRanges(int index, RouterAdvertisedIpRange value)

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;

Parameters
Name Description
index int
value RouterAdvertisedIpRange
Returns
Type Description
RouterBgpPeer.Builder

setAdvertisedIpRanges(int index, RouterAdvertisedIpRange.Builder builderForValue)

public RouterBgpPeer.Builder setAdvertisedIpRanges(int index, RouterAdvertisedIpRange.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue RouterAdvertisedIpRange.Builder
Returns
Type Description
RouterBgpPeer.Builder

setAdvertisedRoutePriority(int value)

public RouterBgpPeer.Builder setAdvertisedRoutePriority(int value)

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;

Parameter
Name Description
value int

The advertisedRoutePriority to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setBfd(RouterBgpPeerBfd value)

public RouterBgpPeer.Builder setBfd(RouterBgpPeerBfd value)

BFD configuration for the BGP peering.

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

Parameter
Name Description
value RouterBgpPeerBfd
Returns
Type Description
RouterBgpPeer.Builder

setBfd(RouterBgpPeerBfd.Builder builderForValue)

public RouterBgpPeer.Builder setBfd(RouterBgpPeerBfd.Builder builderForValue)

BFD configuration for the BGP peering.

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

Parameter
Name Description
builderForValue RouterBgpPeerBfd.Builder
Returns
Type Description
RouterBgpPeer.Builder

setCustomLearnedIpRanges(int index, RouterBgpPeerCustomLearnedIpRange value)

public RouterBgpPeer.Builder setCustomLearnedIpRanges(int index, RouterBgpPeerCustomLearnedIpRange value)

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;

Parameters
Name Description
index int
value RouterBgpPeerCustomLearnedIpRange
Returns
Type Description
RouterBgpPeer.Builder

setCustomLearnedIpRanges(int index, RouterBgpPeerCustomLearnedIpRange.Builder builderForValue)

public RouterBgpPeer.Builder setCustomLearnedIpRanges(int index, RouterBgpPeerCustomLearnedIpRange.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue RouterBgpPeerCustomLearnedIpRange.Builder
Returns
Type Description
RouterBgpPeer.Builder

setCustomLearnedRoutePriority(int value)

public RouterBgpPeer.Builder setCustomLearnedRoutePriority(int value)

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;

Parameter
Name Description
value int

The customLearnedRoutePriority to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setEnable(String value)

public RouterBgpPeer.Builder setEnable(String value)

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;

Parameter
Name Description
value String

The enable to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setEnableBytes(ByteString value)

public RouterBgpPeer.Builder setEnableBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for enable to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setEnableIpv6(boolean value)

public RouterBgpPeer.Builder setEnableIpv6(boolean value)

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

optional bool enable_ipv6 = 181467939;

Parameter
Name Description
value boolean

The enableIpv6 to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RouterBgpPeer.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RouterBgpPeer.Builder
Overrides

setInterfaceName(String value)

public RouterBgpPeer.Builder setInterfaceName(String value)

Name of the interface the BGP peer is associated with.

optional string interface_name = 437854673;

Parameter
Name Description
value String

The interfaceName to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setInterfaceNameBytes(ByteString value)

public RouterBgpPeer.Builder setInterfaceNameBytes(ByteString value)

Name of the interface the BGP peer is associated with.

optional string interface_name = 437854673;

Parameter
Name Description
value ByteString

The bytes for interfaceName to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setIpAddress(String value)

public RouterBgpPeer.Builder setIpAddress(String value)

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

optional string ip_address = 406272220;

Parameter
Name Description
value String

The ipAddress to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setIpAddressBytes(ByteString value)

public RouterBgpPeer.Builder setIpAddressBytes(ByteString value)

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

optional string ip_address = 406272220;

Parameter
Name Description
value ByteString

The bytes for ipAddress to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setIpv6NexthopAddress(String value)

public RouterBgpPeer.Builder setIpv6NexthopAddress(String value)

IPv6 address of the interface inside Google Cloud Platform.

optional string ipv6_nexthop_address = 27968211;

Parameter
Name Description
value String

The ipv6NexthopAddress to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setIpv6NexthopAddressBytes(ByteString value)

public RouterBgpPeer.Builder setIpv6NexthopAddressBytes(ByteString value)

IPv6 address of the interface inside Google Cloud Platform.

optional string ipv6_nexthop_address = 27968211;

Parameter
Name Description
value ByteString

The bytes for ipv6NexthopAddress to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setManagementType(String value)

public RouterBgpPeer.Builder setManagementType(String value)

[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;

Parameter
Name Description
value String

The managementType to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setManagementTypeBytes(ByteString value)

public RouterBgpPeer.Builder setManagementTypeBytes(ByteString value)

[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;

Parameter
Name Description
value ByteString

The bytes for managementType to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setMd5AuthenticationKeyName(String value)

public RouterBgpPeer.Builder setMd5AuthenticationKeyName(String value)

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;

Parameter
Name Description
value String

The md5AuthenticationKeyName to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setMd5AuthenticationKeyNameBytes(ByteString value)

public RouterBgpPeer.Builder setMd5AuthenticationKeyNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for md5AuthenticationKeyName to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setName(String value)

public RouterBgpPeer.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RouterBgpPeer.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setPeerAsn(int value)

public RouterBgpPeer.Builder setPeerAsn(int value)

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

optional uint32 peer_asn = 69573151;

Parameter
Name Description
value int

The peerAsn to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setPeerIpAddress(String value)

public RouterBgpPeer.Builder setPeerIpAddress(String value)

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

optional string peer_ip_address = 207735769;

Parameter
Name Description
value String

The peerIpAddress to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setPeerIpAddressBytes(ByteString value)

public RouterBgpPeer.Builder setPeerIpAddressBytes(ByteString value)

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

optional string peer_ip_address = 207735769;

Parameter
Name Description
value ByteString

The bytes for peerIpAddress to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setPeerIpv6NexthopAddress(String value)

public RouterBgpPeer.Builder setPeerIpv6NexthopAddress(String value)

IPv6 address of the BGP interface outside Google Cloud Platform.

optional string peer_ipv6_nexthop_address = 491486608;

Parameter
Name Description
value String

The peerIpv6NexthopAddress to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setPeerIpv6NexthopAddressBytes(ByteString value)

public RouterBgpPeer.Builder setPeerIpv6NexthopAddressBytes(ByteString value)

IPv6 address of the BGP interface outside Google Cloud Platform.

optional string peer_ipv6_nexthop_address = 491486608;

Parameter
Name Description
value ByteString

The bytes for peerIpv6NexthopAddress to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RouterBgpPeer.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RouterBgpPeer.Builder
Overrides

setRouterApplianceInstance(String value)

public RouterBgpPeer.Builder setRouterApplianceInstance(String value)

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;

Parameter
Name Description
value String

The routerApplianceInstance to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setRouterApplianceInstanceBytes(ByteString value)

public RouterBgpPeer.Builder setRouterApplianceInstanceBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for routerApplianceInstance to set.
Returns
Type Description
RouterBgpPeer.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RouterBgpPeer.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RouterBgpPeer.Builder
Overrides