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 | |
|---|---|
| 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. 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.
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. The options are DEFAULT or CUSTOM.
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. 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.
Generated from protobuf field repeated string advertised_groups = 21065526;
| Returns | |
|---|---|
| Type | Description |
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.
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 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.
Generated from protobuf field repeated .google.cloud.compute.v1.RouterAdvertisedIpRange advertised_ip_ranges = 35449932;
| Returns | |
|---|---|
| Type | Description |
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.
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 | |
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.
Generated from protobuf field optional uint32 asn = 96892;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field optional uint32 asn = 96892;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field optional uint32 keepalive_interval = 276771516;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field optional uint32 keepalive_interval = 276771516;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |