Compute V1 Client - Class RouterBgp (1.6.1)

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

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ advertise_mode string

User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. Check the AdvertiseMode enum for the list of possible values.

↳ advertised_groups array

User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be 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 is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

↳ asn int

Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

↳ keepalive_interval int

The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

getAdvertiseMode

User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

Check the AdvertiseMode enum for the list of possible values.

Returns
TypeDescription
string

hasAdvertiseMode

clearAdvertiseMode

setAdvertiseMode

User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

Check the AdvertiseMode enum for the list of possible values.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAdvertisedGroups

User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be 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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAdvertisedGroups

User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be 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.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$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 is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAdvertisedIpRanges

User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Parameter
NameDescription
var array<Google\Cloud\Compute\V1\RouterAdvertisedIpRange>
Returns
TypeDescription
$this

getAsn

Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

Returns
TypeDescription
int

hasAsn

clearAsn

setAsn

Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getKeepaliveInterval

The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

Returns
TypeDescription
int

hasKeepaliveInterval

clearKeepaliveInterval

setKeepaliveInterval

The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.

Parameter
NameDescription
var int
Returns
TypeDescription
$this