Compute V1 Client - Class RouterBgpPeer (1.5.0)

Reference documentation and code samples for the Compute V1 Client class RouterBgpPeer.

Generated from protobuf message google.cloud.compute.v1.RouterBgpPeer

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ advertise_mode`	`string` User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values.
`↳ advertised_groups`	`array` 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.
`↳ advertised_ip_ranges`	`array<Google\Cloud\Compute\V1\RouterAdvertisedIpRange>` 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.
`↳ advertised_route_priority`	`int` 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.
`↳ bfd`	`Google\Cloud\Compute\V1\RouterBgpPeerBfd` BFD configuration for the BGP peering.
`↳ enable`	`string` 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.
`↳ enable_ipv6`	`bool` Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
`↳ interface_name`	`string` Name of the interface the BGP peer is associated with.
`↳ ip_address`	`string` IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
`↳ ipv6_nexthop_address`	`string` IPv6 address of the interface inside Google Cloud Platform.
`↳ management_type`	`string` [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.
`↳ md5_authentication_key_name`	`string` 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.
`↳ name`	`string` 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.
`↳ peer_asn`	`int` Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
`↳ peer_ip_address`	`string` IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
`↳ peer_ipv6_nexthop_address`	`string` IPv6 address of the BGP interface outside Google Cloud Platform.
`↳ router_appliance_instance`	`string` 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.

getAdvertiseMode

User-specified flag to indicate which mode to use for advertisement.

Check the AdvertiseMode enum for the list of possible values.

Generated from protobuf field optional string advertise_mode = 312134331;

Returns
Type	Description
`string`

hasAdvertiseMode

clearAdvertiseMode

setAdvertiseMode

User-specified flag to indicate which mode to use for advertisement.

Check the AdvertiseMode enum for the list of possible values.

Generated from protobuf field optional string advertise_mode = 312134331;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAdvertisedGroups

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

Check the AdvertisedGroups enum for the list of possible values.

Generated from protobuf field repeated string advertised_groups = 21065526;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAdvertisedGroups

Check the AdvertisedGroups enum for the list of possible values.

Generated from protobuf field repeated string advertised_groups = 21065526;

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getAdvertisedIpRanges

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

Generated from protobuf field repeated .google.cloud.compute.v1.RouterAdvertisedIpRange advertised_ip_ranges = 35449932;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAdvertisedIpRanges

Generated from protobuf field repeated .google.cloud.compute.v1.RouterAdvertisedIpRange advertised_ip_ranges = 35449932;

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\RouterAdvertisedIpRange>`

Returns
Type	Description
`$this`

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.

Generated from protobuf field optional uint32 advertised_route_priority = 186486332;

Returns
Type	Description
`int`

hasAdvertisedRoutePriority

clearAdvertisedRoutePriority

setAdvertisedRoutePriority

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.

Generated from protobuf field optional uint32 advertised_route_priority = 186486332;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getBfd

BFD configuration for the BGP peering.

Generated from protobuf field optional .google.cloud.compute.v1.RouterBgpPeerBfd bfd = 97440;

Returns
Type	Description
`Google\Cloud\Compute\V1\RouterBgpPeerBfd\|null`

hasBfd

clearBfd

setBfd

BFD configuration for the BGP peering.

Generated from protobuf field optional .google.cloud.compute.v1.RouterBgpPeerBfd bfd = 97440;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\RouterBgpPeerBfd`

Returns
Type	Description
`$this`

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.

Generated from protobuf field optional string enable = 311764355;

Returns
Type	Description
`string`

hasEnable

clearEnable

setEnable

Check the Enable enum for the list of possible values.

Generated from protobuf field optional string enable = 311764355;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEnableIpv6

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

Generated from protobuf field optional bool enable_ipv6 = 181467939;

Returns
Type	Description
`bool`

hasEnableIpv6

clearEnableIpv6

setEnableIpv6

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

Generated from protobuf field optional bool enable_ipv6 = 181467939;

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getInterfaceName

Name of the interface the BGP peer is associated with.

Generated from protobuf field optional string interface_name = 437854673;

Returns
Type	Description
`string`

hasInterfaceName

clearInterfaceName

setInterfaceName

Name of the interface the BGP peer is associated with.

Generated from protobuf field optional string interface_name = 437854673;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIpAddress

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

Generated from protobuf field optional string ip_address = 406272220;

Returns
Type	Description
`string`

hasIpAddress

clearIpAddress

setIpAddress

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

Generated from protobuf field optional string ip_address = 406272220;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIpv6NexthopAddress

IPv6 address of the interface inside Google Cloud Platform.

Generated from protobuf field optional string ipv6_nexthop_address = 27968211;

Returns
Type	Description
`string`

hasIpv6NexthopAddress

clearIpv6NexthopAddress

setIpv6NexthopAddress

IPv6 address of the interface inside Google Cloud Platform.

Generated from protobuf field optional string ipv6_nexthop_address = 27968211;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Generated from protobuf field optional string management_type = 173703606;

Returns
Type	Description
`string`

hasManagementType

clearManagementType

setManagementType

Check the ManagementType enum for the list of possible values.

Generated from protobuf field optional string management_type = 173703606;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Generated from protobuf field optional string md5_authentication_key_name = 281075345;

Returns
Type	Description
`string`

hasMd5AuthenticationKeyName

clearMd5AuthenticationKeyName

setMd5AuthenticationKeyName

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.

Generated from protobuf field optional string md5_authentication_key_name = 281075345;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Generated from protobuf field optional string name = 3373707;

Returns
Type	Description
`string`

hasName

clearName

setName

Generated from protobuf field optional string name = 3373707;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPeerAsn

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

Generated from protobuf field optional uint32 peer_asn = 69573151;

Returns
Type	Description
`int`

hasPeerAsn

clearPeerAsn

setPeerAsn

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

Generated from protobuf field optional uint32 peer_asn = 69573151;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPeerIpAddress

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

Generated from protobuf field optional string peer_ip_address = 207735769;

Returns
Type	Description
`string`

hasPeerIpAddress

clearPeerIpAddress

setPeerIpAddress

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

Generated from protobuf field optional string peer_ip_address = 207735769;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPeerIpv6NexthopAddress

IPv6 address of the BGP interface outside Google Cloud Platform.

Generated from protobuf field optional string peer_ipv6_nexthop_address = 491486608;

Returns
Type	Description
`string`

hasPeerIpv6NexthopAddress

clearPeerIpv6NexthopAddress

setPeerIpv6NexthopAddress

IPv6 address of the BGP interface outside Google Cloud Platform.

Generated from protobuf field optional string peer_ipv6_nexthop_address = 491486608;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Generated from protobuf field optional string router_appliance_instance = 468312989;

Returns
Type	Description
`string`

hasRouterApplianceInstance

clearRouterApplianceInstance

setRouterApplianceInstance

Generated from protobuf field optional string router_appliance_instance = 468312989;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`