- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public final class RouterBgpPeer extends GeneratedMessageV3 implements RouterBgpPeerOrBuilder Protobuf type google.cloud.compute.v1.RouterBgpPeer
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RouterBgpPeerImplements
RouterBgpPeerOrBuilderStatic Fields
ADVERTISED_GROUPS_FIELD_NUMBER
public static final int ADVERTISED_GROUPS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ADVERTISED_IP_RANGES_FIELD_NUMBER
public static final int ADVERTISED_IP_RANGES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ADVERTISED_ROUTE_PRIORITY_FIELD_NUMBER
public static final int ADVERTISED_ROUTE_PRIORITY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ADVERTISE_MODE_FIELD_NUMBER
public static final int ADVERTISE_MODE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
BFD_FIELD_NUMBER
public static final int BFD_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOM_LEARNED_IP_RANGES_FIELD_NUMBER
public static final int CUSTOM_LEARNED_IP_RANGES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOM_LEARNED_ROUTE_PRIORITY_FIELD_NUMBER
public static final int CUSTOM_LEARNED_ROUTE_PRIORITY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ENABLE_FIELD_NUMBER
public static final int ENABLE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ENABLE_IPV4_FIELD_NUMBER
public static final int ENABLE_IPV4_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ENABLE_IPV6_FIELD_NUMBER
public static final int ENABLE_IPV6_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EXPORT_POLICIES_FIELD_NUMBER
public static final int EXPORT_POLICIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
IMPORT_POLICIES_FIELD_NUMBER
public static final int IMPORT_POLICIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INTERFACE_NAME_FIELD_NUMBER
public static final int INTERFACE_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
IPV4_NEXTHOP_ADDRESS_FIELD_NUMBER
public static final int IPV4_NEXTHOP_ADDRESS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
IPV6_NEXTHOP_ADDRESS_FIELD_NUMBER
public static final int IPV6_NEXTHOP_ADDRESS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
IP_ADDRESS_FIELD_NUMBER
public static final int IP_ADDRESS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MANAGEMENT_TYPE_FIELD_NUMBER
public static final int MANAGEMENT_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MD5_AUTHENTICATION_KEY_NAME_FIELD_NUMBER
public static final int MD5_AUTHENTICATION_KEY_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PEER_ASN_FIELD_NUMBER
public static final int PEER_ASN_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PEER_IPV4_NEXTHOP_ADDRESS_FIELD_NUMBER
public static final int PEER_IPV4_NEXTHOP_ADDRESS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PEER_IPV6_NEXTHOP_ADDRESS_FIELD_NUMBER
public static final int PEER_IPV6_NEXTHOP_ADDRESS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PEER_IP_ADDRESS_FIELD_NUMBER
public static final int PEER_IP_ADDRESS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ROUTER_APPLIANCE_INSTANCE_FIELD_NUMBER
public static final int ROUTER_APPLIANCE_INSTANCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static RouterBgpPeer getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static RouterBgpPeer.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer.Builder |
|
newBuilder(RouterBgpPeer prototype)
public static RouterBgpPeer.Builder newBuilder(RouterBgpPeer prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
RouterBgpPeer |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer.Builder |
|
parseDelimitedFrom(InputStream input)
public static RouterBgpPeer parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RouterBgpPeer parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static RouterBgpPeer parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RouterBgpPeer parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static RouterBgpPeer parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RouterBgpPeer parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static RouterBgpPeer parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RouterBgpPeer parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static RouterBgpPeer parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RouterBgpPeer parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static RouterBgpPeer parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RouterBgpPeer parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<RouterBgpPeer> parser()| Returns | |
|---|---|
| Type | Description |
Parser<RouterBgpPeer> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
intThe 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 |
intThe 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 |
|
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. |
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 |
|
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 |
|
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. |
getEnableIpv4()
public boolean getEnableIpv4()Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.
optional bool enable_ipv4 = 181467937;
| Returns | |
|---|---|
| Type | Description |
boolean |
The enableIpv4. |
getEnableIpv6()
public boolean getEnableIpv6()Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.
optional bool enable_ipv6 = 181467939;
| Returns | |
|---|---|
| Type | Description |
boolean |
The enableIpv6. |
getExportPolicies(int index)
public String getExportPolicies(int index)List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.
repeated string export_policies = 134084987;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The exportPolicies at the given index. |
getExportPoliciesBytes(int index)
public ByteString getExportPoliciesBytes(int index)List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.
repeated string export_policies = 134084987;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the exportPolicies at the given index. |
getExportPoliciesCount()
public int getExportPoliciesCount()List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.
repeated string export_policies = 134084987;
| Returns | |
|---|---|
| Type | Description |
int |
The count of exportPolicies. |
getExportPoliciesList()
public ProtocolStringList getExportPoliciesList()List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.
repeated string export_policies = 134084987;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the exportPolicies. |
getImportPolicies(int index)
public String getImportPolicies(int index)List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.
repeated string import_policies = 451147946;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The importPolicies at the given index. |
getImportPoliciesBytes(int index)
public ByteString getImportPoliciesBytes(int index)List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.
repeated string import_policies = 451147946;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the importPolicies at the given index. |
getImportPoliciesCount()
public int getImportPoliciesCount()List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.
repeated string import_policies = 451147946;
| Returns | |
|---|---|
| Type | Description |
int |
The count of importPolicies. |
getImportPoliciesList()
public ProtocolStringList getImportPoliciesList()List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.
repeated string import_policies = 451147946;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the importPolicies. |
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.
optional string ip_address = 406272220;
| Returns | |
|---|---|
| Type | Description |
String |
The ipAddress. |
getIpAddressBytes()
public ByteString getIpAddressBytes()IP address of the interface inside Google Cloud Platform.
optional string ip_address = 406272220;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for ipAddress. |
getIpv4NexthopAddress()
public String getIpv4NexthopAddress()IPv4 address of the interface inside Google Cloud Platform.
optional string ipv4_nexthop_address = 5703377;
| Returns | |
|---|---|
| Type | Description |
String |
The ipv4NexthopAddress. |
getIpv4NexthopAddressBytes()
public ByteString getIpv4NexthopAddressBytes()IPv4 address of the interface inside Google Cloud Platform.
optional string ipv4_nexthop_address = 5703377;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for ipv4NexthopAddress. |
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. |
getParserForType()
public Parser<RouterBgpPeer> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<RouterBgpPeer> |
|
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.
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.
optional string peer_ip_address = 207735769;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for peerIpAddress. |
getPeerIpv4NexthopAddress()
public String getPeerIpv4NexthopAddress()IPv4 address of the BGP interface outside Google Cloud Platform.
optional string peer_ipv4_nexthop_address = 469221774;
| Returns | |
|---|---|
| Type | Description |
String |
The peerIpv4NexthopAddress. |
getPeerIpv4NexthopAddressBytes()
public ByteString getPeerIpv4NexthopAddressBytes()IPv4 address of the BGP interface outside Google Cloud Platform.
optional string peer_ipv4_nexthop_address = 469221774;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for peerIpv4NexthopAddress. |
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. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
hasEnableIpv4()
public boolean hasEnableIpv4()Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.
optional bool enable_ipv4 = 181467937;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the enableIpv4 field is set. |
hasEnableIpv6()
public boolean hasEnableIpv6()Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.
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.
optional string ip_address = 406272220;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the ipAddress field is set. |
hasIpv4NexthopAddress()
public boolean hasIpv4NexthopAddress()IPv4 address of the interface inside Google Cloud Platform.
optional string ipv4_nexthop_address = 5703377;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the ipv4NexthopAddress 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.
optional string peer_ip_address = 207735769;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the peerIpAddress field is set. |
hasPeerIpv4NexthopAddress()
public boolean hasPeerIpv4NexthopAddress()IPv4 address of the BGP interface outside Google Cloud Platform.
optional string peer_ipv4_nexthop_address = 469221774;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the peerIpv4NexthopAddress 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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public RouterBgpPeer.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RouterBgpPeer.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public RouterBgpPeer.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
RouterBgpPeer.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|